com.sun.jbi.wsdl11wrapper

Interface WrapperBuilder

All Known Implementing Classes:

WrapperBuilderImpl

public interface WrapperBuilder

Assist in processing normalized messages with JBI WSDL 1.1 wrappers Usage sequence, for each message to normalize: initialize() addParts() or multiple addPart() calls getResult() The same instance should not be used by multiple threads concurrently as it is not guaranteed to be thread safe - and maintains state The re-use of the same instance however is encouraged.

Author:

aegloff

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESULT_TAG Constant RESULT
static String	STATUS_TAG Constant Status

Method Summary

Methods

Modifier and Type	Method and Description
void	addPart(String partName, Element partNode) Add a part in the right position (wrapped in a JBI part wrapper) to the JBI message wrapper element
void	addPart(String partName, NodeList partNodes) Add a part in the right position (wrapped in a JBI part wrapper) to the JBI message wrapper element
void	addParts(Map partNameToPartNodes) Add parts in the right order (each wrapped in a JBI part wrapper) to the passed in JBI message wrapper element The jbiMessageWrapper must be a node of the normalDoc.
Document	getResult() Obtain the result document, i.e. the Normalized Message payload in jbi wsdl 1.1 wrapper format
Document	getStatusDocument(String statusMessage) Obtain the status document, i.e. the Normalized Message payload in jbi wsdl 1.1 wrapper format that represents a status (succeed or error)
javax.wsdl.Message	getStatusMessage() Obtain the status Message definition
void	initialize(Document docToPopulate, javax.wsdl.Message wsdlMessageDefinition, String operationBindingMessageName) Initialize the builder to start a build sequence.

Field Detail

STATUS_TAG

static final String STATUS_TAG

Constant Status

See Also:

Constant Field Values

RESULT_TAG

static final String RESULT_TAG

Constant RESULT

See Also:

Constant Field Values

Method Detail

initialize

void initialize(Document docToPopulate,
              javax.wsdl.Message wsdlMessageDefinition,
              String operationBindingMessageName)
                throws WrapperProcessingException

Initialize the builder to start a build sequence. Also re-sets a result document if it already exists.

Parameters:

wsdlMessageDefinition - sets the WSDL message definition of the message to normalize

operationBindingMessageName - The name defined in the WSDL operation binding for the message to normalize to.

Throws:

WrapperProcessingException - if the builder could not be initialized

addPart

void addPart(String partName,
           Element partNode)
             throws WrapperProcessingException

Add a part in the right position (wrapped in a JBI part wrapper) to the JBI message wrapper element

Parameters:

partName - the name of the message part

partNode - the part node (payload) The part node does not have to be associated with the normalDoc yet, it will be imported

Throws:

WrapperProcessingException - if the part could not be added

addPart

void addPart(String partName,
           NodeList partNodes)
             throws WrapperProcessingException

Add a part in the right position (wrapped in a JBI part wrapper) to the JBI message wrapper element

Parameters:

partName - the name of the message part

partNodes - the part node(s) (payload) The part node does not have to be associated with the normalDoc yet, it will be imported

Throws:

WrapperProcessingException - if the part could not be added

addParts

void addParts(Map partNameToPartNodes)
              throws WrapperProcessingException

Add parts in the right order (each wrapped in a JBI part wrapper) to the passed in JBI message wrapper element The jbiMessageWrapper must be a node of the normalDoc.

Parameters:

normalDoc - The target document of the normalization

jbiMessageWrapper - The message wrapper element to add the jbi part wrappers and part payload to

messageDefinintion - the WSDL message definition

partNameToPartNodes - a mapping from the part name to the part node(s) of type NodeList (payload), The part node does not have to be associated with the normalDoc yet, it will be imported

Throws:

WrapperProcessingException - if the parts could not be added

getResult

Document getResult()
                   throws WrapperProcessingException

Obtain the result document, i.e. the Normalized Message payload in jbi wsdl 1.1 wrapper format

Returns:

the normalized message payload document

Throws:

WrapperProcessingException

getStatusDocument

Document getStatusDocument(String statusMessage)
                           throws WrapperProcessingException

Obtain the status document, i.e. the Normalized Message payload in jbi wsdl 1.1 wrapper format that represents a status (succeed or error)

Returns:

the normalized message payload document

Throws:

WrapperProcessingException

getStatusMessage

javax.wsdl.Message getStatusMessage()
                                    throws WrapperProcessingException

Obtain the status Message definition

Returns:

the normalized message payload document

Throws:

WrapperProcessingException