com.eibus.connector.nom

Class SOAPMessage

java.lang.Object

com.eibus.connector.nom.SOAPMessage

public class SOAPMessage
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SOAPMessage()

Method Summary

Modifier and Type	Method and Description
static void	adjustHeader(int node, java.lang.String replyTo) adjust the header by swaping sender and receiver as response needs to be sent
static int	createBodyNode(int envelope) Creates and returns a body node for the root SOAP Envelope node, if it not already exists.
static java.lang.String	createMessageId(int soapHeader) returns created Message-ID for a SOAP Message
static int	createResponse(int node, java.lang.String replyTo) returns the sender component from a given SOAP Message reference
static int	duplicateMessageHeader(int node) Duplicates the message Header if the soapMessage has to be sent to different components
static boolean	expectsNoReply(int node) Returns whether the SOAP Message expects no reply
static int	getBodyNode(int node) Deprecated. since 4.2 C3, use getRootBodyNode()
static int	getCordysHeaderNode(int node) Returns the Cordys Header node of the SOAP Message.
static int	getEnvelopeNode(int node) Deprecated. since 4.2 C3, use getRootEnvelopeNode()
static int	getHeaderNode(int node) Deprecated. since 4.2 C3, use getRootHeaderNode()
static java.lang.String	getMessageId(int node) returns the message id from a given SOAP Message reference
static java.lang.String	getReceiverComponent(int node) returns the receiver component from a given SOAP Message reference
static java.lang.String	getReplyTo(int node) returns the replyto uri from a given SOAP Message reference
static int	getRootBodyNode(int node) Returns the root SOAP Body node of the SOAP Message.
static int	getRootEnvelopeNode(int node) Retreives the envelope node from anywhere in the SOAP request.
static int	getRootHeaderNode(int node) Returns the root SOAP Header node of the SOAP Message.
static java.lang.String	getSenderComponent(int node) returns the sender component from a given SOAP Message reference
static java.lang.String	getSentTo(int node) returns the sent to uri from a given SOAP Message reference
static java.lang.String	getUser(int node) returns the user from a given SOAP Message reference
static void	setLocale(int node, java.util.Locale locale) Set the locale information in the SOAP Header node
static void	setMessageId(int node, java.lang.String msgId) Sets the Message ID for the SOAP Message
static void	setReceiver(int node, java.lang.String component, java.lang.String uri) Set the specified receiver information in the soapHeader.
static void	setSender(int node, java.lang.String component, java.lang.String uri, java.lang.String user) Set the sender information in the header node
static void	setSenderIdentity(int node, java.lang.String component, java.lang.String uri, Identity senderIdentity) Set the sender information in the header node
static Message	toMessage(int node) Returns a serialized version of the XML Message.
static Message	toMessage(int node, MessageOptions messageOptions) Returns a serialized version of the XML Message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPMessage

public SOAPMessage()

Method Detail

toMessage

public static Message toMessage(int node)

Returns a serialized version of the XML Message.

  com.eibus.transport.Message message = SOAPMessage.getMessage(soapMessage);

Parameters:

node - int reference to the XML Node

toMessage

public static Message toMessage(int node,
                                MessageOptions messageOptions)

Returns a serialized version of the XML Message. And implements on the message the given message options

  com.eibus.transport.Message message = SOAPMessage.getMessage(soapMessage);

Parameters:

node - int reference to the XML Node

getEnvelopeNode

@Deprecated
public static int getEnvelopeNode(int node)

Deprecated. since 4.2 C3, use getRootEnvelopeNode()

Returns the envelope node from the SOAPMessage

 
 int envelopeNode = SoapMessage.getEnvelopeNode(soapMessage);
 
 

Parameters:

node - int reference to the XML node

getHeaderNode

@Deprecated
public static int getHeaderNode(int node)

Deprecated. since 4.2 C3, use getRootHeaderNode()

Returns the first child if the node has local name Envelope. Returns the previous sibling if the node has local name Body. Returns the node itself if it has local name Header. Returns 0 otherwise.

Parameters:

node - int reference to the xml node

getBodyNode

@Deprecated
public static int getBodyNode(int node)

Deprecated. since 4.2 C3, use getRootBodyNode()

Returns the second child if the node has local name Envelope. Returns the next sibling if the node has local name Header. Returns the node itself if it has local name Body. Returns 0 otherwise.

Parameters:

node - int reference to the XML Node

getRootEnvelopeNode

public static int getRootEnvelopeNode(int node)

Retreives the envelope node from anywhere in the SOAP request. Always returns the root SOAP Envelope, if the root node is not a SOAP Envelope then returns 0

Parameters:

node - int reference to the XML node

getRootHeaderNode

public static int getRootHeaderNode(int node)

Returns the root SOAP Header node of the SOAP Message. Retreives the SOAP Header node from anywhere in the SOAP request. Always returns the root SOAP Header, if not found then returns 0

Parameters:

node - int reference to the xml node

getRootBodyNode

public static int getRootBodyNode(int node)

Returns the root SOAP Body node of the SOAP Message. Retreives the SOAP Body node from anywhere in the SOAP request. Always returns the root SOAP Body, if not found then returns 0

Parameters:

node - int reference to the XML Node

createBodyNode

public static int createBodyNode(int envelope)

Creates and returns a body node for the root SOAP Envelope node, if it not already exists. If it already exists, then the existing node is returned.

Parameters:

envelope - int reference to the xml node

setReceiver

public static void setReceiver(int node,
                               java.lang.String component,
                               java.lang.String uri)

Set the specified receiver information in the soapHeader. The receiver information is the content of the receiver tag inside a soapHeader header. The soapHeader header is usually the first child in a soapHeader element, that has the tagname header. If the receiver information is already present it will be overwritten.

Parameters:

node - The soapHeader to set the header information in. If 0, the method returns.

component - dn of the receiver

uri - uri of the connection point

setSender

public static void setSender(int node,
                             java.lang.String component,
                             java.lang.String uri,
                             java.lang.String user)

Set the sender information in the header node

Parameters:

node - int reference of the header node

component - DN of the receiver

uri - uri of the sending component

user - Dn of the user who is sending request

setLocale

public static void setLocale(int node,
                             java.util.Locale locale)

Set the locale information in the SOAP Header node

Parameters:

locale - to be set

setSenderIdentity

public static void setSenderIdentity(int node,
                                     java.lang.String component,
                                     java.lang.String uri,
                                     Identity senderIdentity)

Set the sender information in the header node

Parameters:

node - int reference of the header node

component - DN of the receiver

uri - uri of the sending component

senderIdentity - of the user who is sending request (null will remove identity information) TODO make this a native method

setMessageId

public static void setMessageId(int node,
                                java.lang.String msgId)

Sets the Message ID for the SOAP Message

Parameters:

node - int reference of the xml node

msgid - MessageId that should be set

createMessageId

public static java.lang.String createMessageId(int soapHeader)

returns created Message-ID for a SOAP Message

Parameters:

soapHeader - int reference of the SOAP Message

Returns:

string representation of GUID created

getMessageId

public static java.lang.String getMessageId(int node)

returns the message id from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String representation of the guid

getSenderComponent

public static java.lang.String getSenderComponent(int node)

returns the sender component from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String sender of the SOAP Message

getReplyTo

public static java.lang.String getReplyTo(int node)

returns the replyto uri from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String reply to uri of the sender

expectsNoReply

public static boolean expectsNoReply(int node)

Returns whether the SOAP Message expects no reply

getUser

public static java.lang.String getUser(int node)

returns the user from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String User who has send this SOAP Message

getReceiverComponent

public static java.lang.String getReceiverComponent(int node)

returns the receiver component from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String receiver of the SOAP Message

getSentTo

public static java.lang.String getSentTo(int node)

returns the sent to uri from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

Returns:

String sent to uri of SOAP Message

createResponse

public static int createResponse(int node,
                                 java.lang.String replyTo)

returns the sender component from a given SOAP Message reference

Parameters:

node - int reference to the XML Node

replyto - replyto uri to which soap message is to be sent

Returns:

int reference of the response

adjustHeader

public static void adjustHeader(int node,
                                java.lang.String replyTo)

adjust the header by swaping sender and receiver as response needs to be sent

Parameters:

node - int reference of the SOAP Message

replyto - replyto uri to which the response should be sent

duplicateMessageHeader

public static int duplicateMessageHeader(int node)

Duplicates the message Header if the soapMessage has to be sent to different components

Parameters:

int - reference of the SOAP Message

getCordysHeaderNode

public static int getCordysHeaderNode(int node)

Returns the Cordys Header node of the SOAP Message. Retreives the Cordys Header node from anywhere in the SOAP request. Always returns the Cordys Header, if not found then returns 0

Parameters:

node - int reference to the xml node