com.highdeal.hci

Class MessageEnvelope

java.lang.Object

com.highdeal.hci.MessageEnvelope

All Implemented Interfaces:

XMLMarshallable

public class MessageEnvelope
extends java.lang.Object
implements XMLMarshallable

This Java class represents the envelope of a message sent via the HTTP Communication Interface (HCI) technical interface; it contains a header and a body with multiple operation requests for the connected SAP CC system.

The format of this message is specified by the HCI technical interface of SAP Convergent Charging.

Important Note

The connected SAP CC system processes the received HCI messages and included service operation requests. It performs the processing mode specified in the message headers.

Refer to the transactional mode for more information about the 'all', 'first fail', 'most', and 'try' execution modes in the SAP CC system.

Implementation in Your Client Application

Refer to the MessageSender Java interface if you want to design and develop a client application that can manage service operations in HCI messages.

See Also:

MessageSender

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="envelope">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="header" minOccurs="1" maxOccurs="1"/>
       <xs:element ref="body" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
MessageEnvelope()

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the objects, the child represents the marshallable object to be added into the content tree.
MessageBody	getBody() Returns the body of the message envelope.
MessageHeader	getHeader() Returns the header of the HCI message envelope.
void	marshal(XMLOutputter output) Gives an XML representation of this object, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag being processed.
void	setBody(MessageBody b) Sets a new body for this envelope.
void	setHeader(MessageHeader h) Sets a new header for this envelope.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageEnvelope

public MessageEnvelope()

Method Detail

getHeader

public MessageHeader getHeader()

Returns the header of the HCI message envelope.

Returns:

The message header

setHeader

public void setHeader(MessageHeader h)

Sets a new header for this envelope.

Parameters:

h - A message header

getBody

public MessageBody getBody()

Returns the body of the message envelope.

Returns:

The body of the message envelope

setBody

public void setBody(MessageBody b)

Sets a new body for this envelope.

Parameters:

b - A message body

setAttributes

public void setAttributes(XMLAttributes atts)

Sets the attributes of the XML representation of the tag being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current tag

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Gives an XML representation of this object, and of its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object