com.sun.jbi.wsdl11wrapper

Interface WrapperParser

All Known Implementing Classes:

WrapperParserImpl

public interface WrapperParser

Assist in processing normalized messages with JBI WSDL 1.1 wrappers Usage sequence: for each normalized message to process call parse() before using the get() accessors to obtain details regarding the normalized message. e.g. along the lines of parse(normalizedMsg, wsdlDef) getPartElement(partName1) getPartElement(partName2) 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

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessageName() Get the optional message "name" defined in the wrapped document.
QName	getMessageType() Get the message type of the message wrapper in the wrapped document.
int	getNoOfParts()
String[]	getPartNames()
NodeList	getPartNodes(String partName) Returns all nodes inside the part wrapper (a jbi:part element may legally contain multiple Elements, or a text node)
Element	getWrappedPart(String partName) Returns the part, including the part wrapper element around the part 'payload' (a jbi:part element may legally contain multiple Elements, or text)
boolean	hasPart(String partName) Note that the spec mandates that all parts present in the WSDL message definition have to appear in the wrapped normalized message - as such this method has limited usefulness
void	parse(Document wrappedDoc, javax.wsdl.Definition wsdlDefinition) Parse a normalized message document in JBI WSDL 1.1 wrapper format
void	parse(Document wrappedDoc, javax.wsdl.Message wsdlMessageDefinition) Parse a normalized message document in JBI WSDL 1.1 wrapper format

Method Detail

parse

void parse(Document wrappedDoc,
         javax.wsdl.Definition wsdlDefinition)
           throws WrapperProcessingException

Parse a normalized message document in JBI WSDL 1.1 wrapper format

Parameters:

wrappedDoc - the wrapped normalized message document

wsdlDefinition - the full wsdl definition, including the definition for the normalized message

Throws:

WrapperProcessingException - if there is an issue parsing the normalized message, e.g. if the normalized message could not be found in the WSDL

parse

void parse(Document wrappedDoc,
         javax.wsdl.Message wsdlMessageDefinition)
           throws WrapperProcessingException

Parse a normalized message document in JBI WSDL 1.1 wrapper format

Parameters:

wrappedDoc - the wrapped normalized message document

wsdlMessageDefinition - the wsdl message definition for the normalized message

Throws:

WrapperProcessingException - if there is an issue parsing the normalized message, e.g. if the normalized message does not match the WSDL description

hasPart

boolean hasPart(String partName)

Note that the spec mandates that all parts present in the WSDL message definition have to appear in the wrapped normalized message - as such this method has limited usefulness

Parameters:

partName - the name of the part to check

Returns:

true if the parsed document contains an entry for the given part - even if the part payload itself is empty. false if the part is not present

getPartNodes

NodeList getPartNodes(String partName)
                      throws WrapperProcessingException

Returns all nodes inside the part wrapper (a jbi:part element may legally contain multiple Elements, or a text node)

Parameters:

partName - the name of the part

Returns:

all Nodes in the normalized message part

Throws:

WrapperProcessingException - if the part could not be returned

getWrappedPart

Element getWrappedPart(String partName)
                       throws WrapperProcessingException

Returns the part, including the part wrapper element around the part 'payload' (a jbi:part element may legally contain multiple Elements, or text)

Parameters:

partName - the name of the part

Returns:

the wrapped normalized message part

Throws:

WrapperProcessingException - if the part could not be returned

getNoOfParts

int getNoOfParts()

Returns:

the number of parts in the normalized message

getPartNames

String[] getPartNames()

Returns:

the names of the parts in the normalized message

getMessageType

QName getMessageType()
                     throws WrapperProcessingException

Get the message type of the message wrapper in the wrapped document.

Returns:

the message type as QName

Throws:

WrapperProcessingException

getMessageName

String getMessageName()
                      throws WrapperProcessingException

Get the optional message "name" defined in the wrapped document. This is the logical name defined in the operation binding, not the type name.

Returns:

the message name

Throws:

WrapperProcessingException