org.apache.axiom.soap.impl.llom

Class SOAPBodyImpl

java.lang.Object

org.apache.axiom.om.impl.llom.OMSerializableImpl

org.apache.axiom.om.impl.llom.OMNodeImpl

org.apache.axiom.om.impl.llom.OMElementImpl

org.apache.axiom.soap.impl.llom.SOAPElement

org.apache.axiom.soap.impl.llom.SOAPBodyImpl

All Implemented Interfaces:

IChildNode, IContainer, IElement, IParentNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, SOAPBody

Direct Known Subclasses:

SOAP11BodyImpl, SOAP12BodyImpl

public abstract class SOAPBodyImpl
extends SOAPElement
implements SOAPBody, OMConstants

Class SOAPBodyImpl

Field Summary

Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

attributes, builder, firstChild, lastChild, localName, namespaces, ns, qName, state

Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

nextSibling, parent, previousSibling

Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

factory

Fields inherited from interface org.apache.axiom.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Fields inherited from interface org.apache.axiom.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors

Modifier	Constructor and Description
	SOAPBodyImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory) Constructor SOAPBodyImpl
	SOAPBodyImpl(SOAPEnvelope envelope, SOAPFactory factory)
protected	SOAPBodyImpl(String localName, OMNamespace ns, SOAPFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addChild(OMNode child, boolean fromBuilder)
abstract SOAPFault	addFault(Exception e) Creates a new SOAPFault object and adds it to this SOAPBody object.
void	addFault(SOAPFault soapFault)
protected void	checkParent(OMElement parent) This has to be implemented by all the derived classes to check for the correct parent.
protected OMElement	createClone(OMCloneOptions options, OMContainer targetParent)
OMNode	detach() Removes this information item and its children, from the model completely.
SOAPFault	getFault() Returns the SOAPFault object in this SOAPBody object.
String	getFirstElementLocalName() Retrieves the local name of the first element in the body.
OMNamespace	getFirstElementNS() Retrieves the OMNamespace of the first element in the body.
boolean	hasFault() Indicates whether a SOAPFault object exists in this SOAPBody object.

Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPElement

registerContentHandler, setParent

Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

addAttribute, addAttribute, addChild, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getDescendants, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLastKnownOMChild, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getPrefix, getQName, getSAXSource, getState, getText, getTextAsQName, getTextAsStream, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, isComplete, removeAttribute, removeChildren, resolveQName, setBuilder, setComplete, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

clone, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

close, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.axiom.om.OMElement

addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setLineNumber, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

Methods inherited from interface org.apache.axiom.om.OMNode

buildWithAttachments, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore

Methods inherited from interface org.apache.axiom.om.OMContainer

addChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

clone, getOMFactory

Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem

getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, setLocalName

Methods inherited from interface org.apache.axiom.om.impl.common.IChildNode

getIParentNode

Methods inherited from interface org.apache.axiom.om.impl.OMNodeEx

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

Constructor Detail

SOAPBodyImpl

protected SOAPBodyImpl(String localName,
                       OMNamespace ns,
                       SOAPFactory factory)

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    SOAPFactory factory)
             throws SOAPProcessingException

Parameters:

envelope -

Throws:

SOAPProcessingException

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    OMXMLParserWrapper builder,
                    SOAPFactory factory)

Constructor SOAPBodyImpl

Parameters:

envelope -

builder -

Method Detail

addFault

public abstract SOAPFault addFault(Exception e)
                            throws OMException

Creates a new SOAPFault object and adds it to this SOAPBody object.

Specified by:

addFault in interface SOAPBody

Parameters:

e -

Returns:

the new SOAPFault object

Throws:

OMException - if there is a SOAP error

OMException

hasFault

public boolean hasFault()

Indicates whether a SOAPFault object exists in this SOAPBody object.

Specified by:

hasFault in interface SOAPBody

Returns:

true if a SOAPFault object exists in this SOAPBody object; false otherwise

getFault

public SOAPFault getFault()

Returns the SOAPFault object in this SOAPBody object.

Specified by:

getFault in interface SOAPBody

Returns:

the SOAPFault object in this SOAPBody object

addFault

public void addFault(SOAPFault soapFault)
              throws OMException

Specified by:

addFault in interface SOAPBody

Parameters:

soapFault -

Throws:

OMException

OMException

checkParent

protected void checkParent(OMElement parent)
                    throws SOAPProcessingException

Description copied from class: SOAPElement

This has to be implemented by all the derived classes to check for the correct parent.

Specified by:

checkParent in class SOAPElement

Throws:

SOAPProcessingException

detach

public OMNode detach()
              throws OMException

Description copied from class: OMElementImpl

Removes this information item and its children, from the model completely.

Specified by:

detach in interface OMNode

Overrides:

detach in class OMElementImpl

Returns:

The detached node. This is always the instance on which this method is invoked.

Throws:

OMException - If a node is not complete, the detach can trigger further parsing, which may cause an exception.

getFirstElementNS

public OMNamespace getFirstElementNS()

Description copied from interface: SOAPBody

Retrieves the OMNamespace of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the OMNamespace, but don't necessarily need the OMElement.

Specified by:

getFirstElementNS in interface SOAPBody

Returns:

the namespace of first element in the body, or null if the element has no namespace or the body is empty

getFirstElementLocalName

public String getFirstElementLocalName()

Description copied from interface: SOAPBody

Retrieves the local name of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the name, but don't necessarily need the OMElement.

Specified by:

getFirstElementLocalName in interface SOAPBody

Returns:

local name of first element in the body, or null if the body is empty

addChild

public void addChild(OMNode child,
                     boolean fromBuilder)

Specified by:

addChild in interface OMContainerEx

Overrides:

addChild in class OMElementImpl

createClone

protected OMElement createClone(OMCloneOptions options,
                                OMContainer targetParent)

Overrides:

createClone in class OMElementImpl