org.apache.axiom.soap.impl.llom
Class SOAPHeaderImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SOAP11HeaderImpl, SOAP12HeaderImpl

public abstract class SOAPHeaderImpl
extends SOAPElement
implements SOAPHeader

A class representing the SOAP Header, primarily allowing access to the contained HeaderBlocks.

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.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

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

Constructor Summary

protected	SOAPHeaderImpl(OMNamespace ns, SOAPFactory factory)
	SOAPHeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory) Constructor SOAPHeaderImpl
	SOAPHeaderImpl(SOAPEnvelope envelope, SOAPFactory factory)

Method Summary

void	addChild(OMNode child, boolean fromBuilder)
SOAPHeaderBlock	addHeaderBlock(java.lang.String localName, OMNamespace ns)
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)
java.util.Iterator	examineAllHeaderBlocks()
java.util.Iterator	examineHeaderBlocks(java.lang.String role)
java.util.Iterator	examineMustUnderstandHeaderBlocks(java.lang.String actor)
static java.lang.String	exceptionToString(java.lang.Throwable e)
java.util.Iterator	extractAllHeaderBlocks()
abstract java.util.Iterator	extractHeaderBlocks(java.lang.String role)
java.util.ArrayList	getHeaderBlocksWithNSURI(java.lang.String nsURI)
java.util.Iterator	getHeadersToProcess(RolePlayer rolePlayer)
java.util.Iterator	getHeadersToProcess(RolePlayer rolePlayer, java.lang.String namespace)

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, detach, 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, detach, 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

SOAPHeaderImpl

protected SOAPHeaderImpl(OMNamespace ns,
                         SOAPFactory factory)

SOAPHeaderImpl

public SOAPHeaderImpl(SOAPEnvelope envelope,
                      SOAPFactory factory)
               throws SOAPProcessingException

Throws:

SOAPProcessingException

SOAPHeaderImpl

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

Constructor SOAPHeaderImpl

Parameters:

envelope -

builder -

Method Detail

addHeaderBlock

public SOAPHeaderBlock addHeaderBlock(java.lang.String localName,
                                      OMNamespace ns)
                               throws OMException

Specified by:

addHeaderBlock in interface SOAPHeader

Throws:

OMException

getHeadersToProcess

public java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer)

Specified by:

getHeadersToProcess in interface SOAPHeader

getHeadersToProcess

public java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer,
                                              java.lang.String namespace)

Specified by:

getHeadersToProcess in interface SOAPHeader

examineHeaderBlocks

public java.util.Iterator examineHeaderBlocks(java.lang.String role)

Specified by:

examineHeaderBlocks in interface SOAPHeader

extractHeaderBlocks

public abstract java.util.Iterator extractHeaderBlocks(java.lang.String role)

Specified by:

extractHeaderBlocks in interface SOAPHeader

examineMustUnderstandHeaderBlocks

public java.util.Iterator examineMustUnderstandHeaderBlocks(java.lang.String actor)

Specified by:

examineMustUnderstandHeaderBlocks in interface SOAPHeader

examineAllHeaderBlocks

public java.util.Iterator examineAllHeaderBlocks()

Specified by:

examineAllHeaderBlocks in interface SOAPHeader

extractAllHeaderBlocks

public java.util.Iterator extractAllHeaderBlocks()

Specified by:

extractAllHeaderBlocks in interface SOAPHeader

getHeaderBlocksWithNSURI

public java.util.ArrayList getHeaderBlocksWithNSURI(java.lang.String nsURI)

Specified by:

getHeaderBlocksWithNSURI in interface SOAPHeader

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

addChild

public void addChild(OMNode child,
                     boolean fromBuilder)

Specified by:

addChild in interface OMContainerEx

Overrides:

addChild in class OMElementImpl

exceptionToString

public static java.lang.String exceptionToString(java.lang.Throwable e)

createClone

protected OMElement createClone(OMCloneOptions options,
                                OMContainer targetParent)

Overrides:

createClone in class OMElementImpl