com.sun.jbi.wsdl11wrapper.impl

Class WrapperBuilderImpl

java.lang.Object

com.sun.jbi.wsdl11wrapper.impl.WrapperBuilderImpl

All Implemented Interfaces:

WrapperBuilder

public class WrapperBuilderImpl
extends Object
implements WrapperBuilder

Assists in building the WSDL 1.1 wrapper for normalized messages specified by JBI Usage sequence: 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 inherited from interface com.sun.jbi.wsdl11wrapper.WrapperBuilder

RESULT_TAG, STATUS_TAG

Constructor Summary

Constructors

Constructor and Description
WrapperBuilderImpl() Creates a new instance The preferred way to create and use this builder implementation is to use the HelperFactory instead.

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() Retrieve the Normalized Message with the parts added (addPart(s)) since the initialize() call Make sure to only retrieve the result after all desired parts have been added.
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) Re-sets the result document, sets the WSDL message definition of the message to normalize

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapperBuilderImpl

public WrapperBuilderImpl()
                   throws WrapperProcessingException

Creates a new instance The preferred way to create and use this builder implementation is to use the HelperFactory instead.

Throws:

WrapperProcessingException

Method Detail

initialize

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

Re-sets the result document, sets the WSDL message definition of the message to normalize

Specified by:

initialize in interface WrapperBuilder

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

public 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

Specified by:

addPart in interface WrapperBuilder

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

public 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

Specified by:

addPart in interface WrapperBuilder

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

addParts

public 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.

Specified by:

addParts in interface WrapperBuilder

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 NodeList (payload). The part node does not have to be associated with the normalDoc yet, it will be imported

getResult

public Document getResult()
                   throws WrapperProcessingException

Retrieve the Normalized Message with the parts added (addPart(s)) since the initialize() call Make sure to only retrieve the result after all desired parts have been added. Parts added after the result of a build squence has been retrieved already (meaning without starting a new build squence by calling initialize) will NOT be included in subsequent retrievals of Result

Specified by:

getResult in interface WrapperBuilder

Returns:

the normalized message payload document

Throws:

WrapperProcessingException

getStatusMessage

public javax.wsdl.Message getStatusMessage()
                                    throws WrapperProcessingException

Description copied from interface: WrapperBuilder

Obtain the status Message definition

Specified by:

getStatusMessage in interface WrapperBuilder

Returns:

the normalized message payload document

Throws:

WrapperProcessingException

getStatusDocument

public Document getStatusDocument(String statusMessage)
                           throws WrapperProcessingException

Description copied from interface: WrapperBuilder

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

Specified by:

getStatusDocument in interface WrapperBuilder

Returns:

the normalized message payload document

Throws:

WrapperProcessingException