org.apache.axiom.soap.impl.llom.soap12
Class SOAP12HeaderImpl

java.lang.Object
  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
                  org.apache.axiom.soap.impl.llom.soap12.SOAP12HeaderImpl

All Implemented Interfaces:

OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx, SOAPHeader

public class SOAP12HeaderImpl

extends SOAPHeaderImpl

Field Summary

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

attributes, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns

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

builder, done, factory, nextSibling, nodeType, parent, previousSibling

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_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

SOAP12HeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
Constructor SOAPHeaderImpl

SOAP12HeaderImpl(SOAPEnvelope envelope, SOAPFactory factory)

SOAP12HeaderImpl(SOAPFactory factory)
Eran Chinthaka (chinthaka@apache.org)

Method Summary

SOAPHeaderBlock	addHeaderBlock(java.lang.String localName, OMNamespace ns) Creates a new SOAPHeaderBlock object initialized with the specified name and adds it to this SOAPHeader object.
java.util.Iterator	extractHeaderBlocks(java.lang.String role) Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified role and detaches them from this SOAPHeader object.

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

checkParent, examineAllHeaderBlocks, examineHeaderBlocks, examineMustUnderstandHeaderBlocks, extractAllHeaderBlocks, getHeaderBlocksWithNSURI

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

setParent

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

addAttribute, addAttribute, addChild, buildNext, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithName, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume

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

build, getOMFactory, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setPreviousOMSibling, setType

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, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume

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

build, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete

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

setComplete

Constructor Detail

SOAP12HeaderImpl

public SOAP12HeaderImpl(SOAPFactory factory)

Eran Chinthaka (chinthaka@apache.org)

SOAP12HeaderImpl

public SOAP12HeaderImpl(SOAPEnvelope envelope,
                        SOAPFactory factory)
                 throws SOAPProcessingException

Parameters:

envelope -

SOAP12HeaderImpl

public SOAP12HeaderImpl(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

Description copied from class: SOAPHeaderImpl

Creates a new SOAPHeaderBlock object initialized with the specified name and adds it to this SOAPHeader object.

Specified by:

addHeaderBlock in interface SOAPHeader

Specified by:

addHeaderBlock in class SOAPHeaderImpl

Parameters:

localName -

ns -

Returns:

the new SOAPHeaderBlock object that was inserted into this SOAPHeader object

Throws:

OMException

extractHeaderBlocks

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

Description copied from class: SOAPHeaderImpl

Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified role and detaches them from this SOAPHeader object.

This method allows an role to process only the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next role.

Specified by:

extractHeaderBlocks in interface SOAPHeader

Specified by:

extractHeaderBlocks in class SOAPHeaderImpl

Parameters:

role - a String giving the URI of the role for which to search

Returns:

an Iterator object over all the SOAPHeaderBlock objects that contain the specified role

See Also:

examineHeaderBlocks(java.lang.String)