MessageHeader¶
-
public class
MessageHeader
extends HeaderElement¶ An ebXML
MessageHeader
in the SOAP Header of aHeaderContainer
Author: cyng
Fields¶
ELEMENT_CONVERSATION_ID¶
ELEMENT_DUPLICATE_ELIMINATION¶
ELEMENT_MESSAGE_DATA¶
ELEMENT_REF_TO_MESSAGE_ID¶
ELEMENT_TIME_TO_LIVE¶
Constructors¶
MessageHeader¶
-
MessageHeader
(SOAPEnvelope soapEnvelope)¶ Initializes data structures in
MessageHeader
object using the givenSOAPEnvelope
.Parameters: - soapEnvelope –
SOAPEnvelope
into which theMessageHeader
is added.
Throws: - SOAPException –
- soapEnvelope –
MessageHeader¶
-
MessageHeader
(SOAPEnvelope soapEnvelope, String fromPartyId, String fromPartyIdType, String toPartyId, String toPartyIdType, String cpaId, String conversationId, String service, String action, String messageId, String timestamp)¶ Constructs a
MessageHeader
with the given mandatory fields. No further modification on the fields specified are allowed.Parameters: - soapEnvelope –
SOAPEnvelope
into which theMessageHeader
is added. - fromPartyId – PartyID of the sender.
- fromPartyIdType – PartyID type of the sender.
- toPartyId – PartyID of the recipient.
- toPartyIdType – PartyID type of the recipient.
- cpaId – CPA ID.
- conversationId – Conversation ID of the message.
- service – Service name.
- action – Action name.
- messageId – Unique message identifier.
- timestamp – Timestamp of the message header creation.
Throws: - SOAPException –
- soapEnvelope –
MessageHeader¶
-
MessageHeader
(SOAPEnvelope soapEnvelope, SOAPElement soapElement)¶ Constructs a
MessageHeader
with the givenSOAPEnvelope
andSOAPElement
.Parameters: - soapEnvelope –
SOAPEnvelope
into which theMessageHeader
is added. - soapElement –
SOAPElement
to be parsed and stored in the MessageHeader.
Throws: - SOAPException –
- soapEnvelope –
Methods¶
addDescription¶
addDescription¶
-
public void
addDescription
(String description, String lang)¶ Add element with specified
xml:lang
. This method can be called repeatedly to add several descriptions to theMessageHeader
Parameters: - description – Description to be added to
MessageHeader
- lang – Language of the description specified in ` RFC 1766 <http://www.ietf.org/rfc/rfc1766.txt>`_ and ISO639.
Throws: - SOAPException –
- description – Description to be added to
addFromPartyId¶
addFromPartyId¶
addToPartyId¶
addToPartyId¶
getConversationId¶
getDescriptionCount¶
-
public int
getDescriptionCount
()¶ Gets the number of
Description
elements in thisMessageHeader
.Returns: The number of Description
elements.
getDescriptions¶
getDuplicateElimination¶
-
public boolean
getDuplicateElimination
()¶ Get current setting of duplication elimination.
Returns: true if duplicate elimination is enabled; false otherwise.
getFrom¶
-
ExtensionElement
getFrom
()¶ Get From core extension element.
Returns: From extension element object.
getFromPartyIds¶
getFromRole¶
getMessageData¶
-
ExtensionElement
getMessageData
()¶ Get MessageData core extension element.
Returns: MessageData ExtensionElement
getRefToMessageId¶
getServiceType¶
getTimeToLive¶
getTimestamp¶
getTo¶
-
ExtensionElement
getTo
()¶ Get To core extension element.
Returns: To extension element object.
getToPartyIds¶
getToRole¶
setAction¶
setConversationId¶
setCpaId¶
setDuplicateElimination¶
-
public void
setDuplicateElimination
()¶ Enable duplication elimination function. This property can be set only once.
Throws: - SOAPException –