org.apache.axiom.soap.impl.builder
Class StAXSOAPModelBuilder

java.lang.Object
  extended by org.apache.axiom.om.impl.builder.StAXBuilder
      extended by org.apache.axiom.om.impl.builder.StAXOMBuilder
          extended by org.apache.axiom.soap.impl.builder.StAXSOAPModelBuilder
All Implemented Interfaces:
OMXMLParserWrapper
Direct Known Subclasses:
MTOMStAXSOAPModelBuilder

public class StAXSOAPModelBuilder
extends StAXOMBuilder

StAX based builder that produces a SOAP infoset model. It builds SOAP specific objects such as SOAPEnvelope, SOAPHeader, SOAPHeaderBlock and SOAPBody.


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.builder.StAXBuilder
_isClosed, _releaseParserOnClose, cache, charEncoding, customBuilderForPayload, customBuilders, document, done, elementLevel, isDataHandlerAware, lastNode, maxDepthForCustomBuilders, omfactory, parser, parserAccessed
 
Constructor Summary
StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser)
          Constructor StAXSOAPModelBuilder Users of this constructor needs to externally take care validating the transport level soap version with the Envelope version.
StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser, SOAPFactory factory, String soapVersion)
           
StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser, String soapVersion)
          Constructor StAXSOAPModelBuilder soapVersion parameter is to give the soap version from the transport.
 
Method Summary
protected  OMElement constructNode(OMElement parent, String elementName, boolean isEnvelope)
          Method constructNode
protected  OMNode createDTD()
          Method createDTD.
protected  OMNode createNextOMElement()
          Creates a new OMElement using either a CustomBuilder or the default Builder mechanism.
protected  OMNode createOMElement()
          Method createOMElement.
protected  OMNode createPI()
          Method createPI.
 void endElement()
           
 OMDocument getDocument()
           
 OMElement getDocumentElement()
          Method getDocumentElement.
 OMNamespace getEnvelopeNamespace()
           
 SOAPEnvelope getSOAPEnvelope()
          Method getSOAPEnvelope.
protected  SOAPFactory getSoapFactory()
           
 SOAPMessage getSoapMessage()
           
protected  void identifySOAPVersion(String soapVersionURIFromTransport)
           
 boolean isProcessingDetailElements()
           
protected  void processNamespaceData(OMElement node, boolean isSOAPElement)
          Method processNamespaceData.
 void setProcessingDetailElements(boolean value)
           
protected  void setSOAPEnvelope(OMElement node)
           
 
Methods inherited from class org.apache.axiom.om.impl.builder.StAXOMBuilder
createComment, createPrefix, createWithCustomBuilder, isLookahead, isNamespaceURIInterning, logParserState, lookahead, next, processNamespaceData, setDoDebug, setNamespaceURIInterning
 
Methods inherited from class org.apache.axiom.om.impl.builder.StAXBuilder
close, createOMText, discard, getAttributeCount, getAttributeName, getAttributeNamespace, getAttributePrefix, getBuilderType, getCharacterEncoding, getCharsetEncoding, getCustomBuilder, getLastNode, getName, getNamespace, getNamespaceCount, getNamespacePrefix, getNamespaceUri, getParser, getPrefix, getReaderProperty, getRegisteredContentHandler, getText, init, isCache, isClosed, isCompleted, isDataHandlerAware, processAttributes, registerCustomBuilder, registerCustomBuilderForPayload, registerExternalContentHandler, releaseParserOnClose, reset, setCache, setIsDataHandlerAware, setOMBuilderFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser,
                            String soapVersion)
Constructor StAXSOAPModelBuilder soapVersion parameter is to give the soap version from the transport. For example, in HTTP case you can identify the version of the soap message u have recd by looking at the HTTP headers. It is used to check whether the actual soap message contained is of that version. If one is creates the builder from the transport, then can just pass null for version.

Parameters:
parser -
soapVersion - parameter is to give the soap version for the transport.

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser)
Constructor StAXSOAPModelBuilder Users of this constructor needs to externally take care validating the transport level soap version with the Envelope version.

Parameters:
parser -

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(javax.xml.stream.XMLStreamReader parser,
                            SOAPFactory factory,
                            String soapVersion)
Parameters:
parser -
factory -
soapVersion - parameter is to give the soap version from the transport. For example, in HTTP case you can identify the version of the soap message u have recd by looking at the HTTP headers. It is used to check whether the actual soap message contained is of that version.If one is creates the builder from the transport, then can just pass null for version.
Method Detail

identifySOAPVersion

protected void identifySOAPVersion(String soapVersionURIFromTransport)
Parameters:
soapVersionURIFromTransport -

getSOAPEnvelope

public SOAPEnvelope getSOAPEnvelope()
                             throws OMException
Method getSOAPEnvelope.

Returns:
Returns SOAPEnvelope.
Throws:
OMException

createNextOMElement

protected OMNode createNextOMElement()
Creates a new OMElement using either a CustomBuilder or the default Builder mechanism.

Overrides:
createNextOMElement in class StAXOMBuilder
Returns:

createOMElement

protected OMNode createOMElement()
                          throws OMException
Method createOMElement.

Overrides:
createOMElement in class StAXOMBuilder
Returns:
Returns OMNode.
Throws:
OMException

setSOAPEnvelope

protected void setSOAPEnvelope(OMElement node)

constructNode

protected OMElement constructNode(OMElement parent,
                                  String elementName,
                                  boolean isEnvelope)
Method constructNode

Parameters:
parent -
elementName -
isEnvelope -

endElement

public void endElement()
Overrides:
endElement in class StAXOMBuilder

createDTD

protected OMNode createDTD()
                    throws OMException
Method createDTD. Overriding the default behaviour as a SOAPMessage should not have a DTD.

Overrides:
createDTD in class StAXOMBuilder
Returns:
Returns OMNode.
Throws:
OMException

createPI

protected OMNode createPI()
                   throws OMException
Method createPI. Overriding the default behaviour as a SOAP Message should not have a PI.

Overrides:
createPI in class StAXOMBuilder
Returns:
Returns OMNode.
Throws:
OMException

getDocumentElement

public OMElement getDocumentElement()
Method getDocumentElement.

Specified by:
getDocumentElement in interface OMXMLParserWrapper
Overrides:
getDocumentElement in class StAXOMBuilder
Returns:
Returns OMElement.

processNamespaceData

protected void processNamespaceData(OMElement node,
                                    boolean isSOAPElement)
Method processNamespaceData.

Parameters:
node -
isSOAPElement -

getEnvelopeNamespace

public OMNamespace getEnvelopeNamespace()

isProcessingDetailElements

public boolean isProcessingDetailElements()

setProcessingDetailElements

public void setProcessingDetailElements(boolean value)

getSoapMessage

public SOAPMessage getSoapMessage()

getDocument

public OMDocument getDocument()
Overrides:
getDocument in class StAXBuilder

getSoapFactory

protected SOAPFactory getSoapFactory()
Returns:
Returns the soapFactory.


Copyright © 2004-2011 The Apache Software Foundation. All Rights Reserved.