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, SOAPModelBuilder
Direct Known Subclasses:
MTOMStAXSOAPModelBuilder

public class StAXSOAPModelBuilder
extends StAXOMBuilder
implements SOAPModelBuilder

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

This builder offers two different ways to handle SOAP versions:

In both cases, the SOAPFactory is retrieved either from the OMMetaFactory specified when the builder is constructed, or if none is specified, from the default meta factory returned by OMAbstractFactory.getMetaFactory().


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.builder.StAXBuilder
_isClosed, _releaseParserOnClose, cache, charEncoding, customBuilderForPayload, customBuilders, dataHandlerReader, document, done, elementLevel, lastNode, maxDepthForCustomBuilders, omfactory, parser, parserAccessed, parserException
 
Constructor Summary
StAXSOAPModelBuilder(OMMetaFactory metaFactory, XMLStreamReader parser)
          Constructor.
StAXSOAPModelBuilder(OMMetaFactory metaFactory, XMLStreamReader parser, String soapVersion)
          Constructor.
StAXSOAPModelBuilder(XMLStreamReader parser)
          Constructor.
StAXSOAPModelBuilder(XMLStreamReader parser, SOAPFactory factory, String soapVersion)
          Constructor.
StAXSOAPModelBuilder(XMLStreamReader parser, String soapVersion)
          Constructor.
 
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()
          Get the document being built by this builder.
 OMElement getDocumentElement()
          Method getDocumentElement.
 OMNamespace getEnvelopeNamespace()
           
 SOAPEnvelope getSOAPEnvelope()
          Get the SOAP envelope for the document processed by this builder.
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, getDocumentElement, 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, processAttributes, registerCustomBuilder, registerCustomBuilderForPayload, registerExternalContentHandler, releaseParserOnClose, reset, setCache, setOMBuilderFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.axiom.om.OMXMLParserWrapper
close, discard, getBuilderType, getCharacterEncoding, getDocumentElement, getParser, getRegisteredContentHandler, isCache, isCompleted, next, registerExternalContentHandler, setCache
 

Constructor Detail

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(XMLStreamReader parser,
                            String soapVersion)
Constructor.

Parameters:
parser - the parser to read the SOAP message from
soapVersion - the namespace URI corresponding to the expected SOAP version of the message

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(OMMetaFactory metaFactory,
                            XMLStreamReader parser,
                            String soapVersion)
Constructor.

Parameters:
metaFactory - the meta factory used to get the appropriate SOAPFactory implementation
parser - the parser to read the SOAP message from
soapVersion - the namespace URI corresponding to the expected SOAP version of the message

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(XMLStreamReader parser)
Constructor.

Parameters:
parser - the parser to read the SOAP message from

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(OMMetaFactory metaFactory,
                            XMLStreamReader parser)
Constructor.

Parameters:
metaFactory - the meta factory used to get the appropriate SOAPFactory implementation
parser - the parser to read the SOAP message from

StAXSOAPModelBuilder

public StAXSOAPModelBuilder(XMLStreamReader parser,
                            SOAPFactory factory,
                            String soapVersion)
Constructor.

Parameters:
parser - the parser to read the SOAP message from
factory - the SOAP factory to use
soapVersion - the namespace URI corresponding to the expected SOAP version of the message
Method Detail

identifySOAPVersion

protected void identifySOAPVersion(String soapVersionURIFromTransport)
Parameters:
soapVersionURIFromTransport -

getSOAPEnvelope

public SOAPEnvelope getSOAPEnvelope()
                             throws OMException
Description copied from interface: SOAPModelBuilder
Get the SOAP envelope for the document processed by this builder.

Specified by:
getSOAPEnvelope in interface SOAPModelBuilder
Returns:
the SOAP envelope
Throws:
OMException

createNextOMElement

protected OMNode createNextOMElement()
Description copied from class: StAXOMBuilder
Creates a new OMElement using either a CustomBuilder or the default Builder mechanism.

Overrides:
createNextOMElement in class StAXOMBuilder
Returns:
TODO

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()
Description copied from interface: OMXMLParserWrapper
Get the document being built by this builder.

Specified by:
getDocument in interface OMXMLParserWrapper
Overrides:
getDocument in class StAXBuilder
Returns:
the OMDocument instance

getSoapFactory

protected SOAPFactory getSoapFactory()
Returns:
Returns the soapFactory.


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