org.apache.axiom.soap.impl.llom.soap11

Class SOAP11HeaderImpl

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

org.apache.axiom.soap.impl.llom.soap11.SOAP11HeaderImpl

All Implemented Interfaces:

org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable, org.apache.axiom.soap.SOAPHeader

public class SOAP11HeaderImpl
extends SOAPHeaderImpl

Field Summary

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

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

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

nextSibling, nodeType, parent, previousSibling

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

builder, done, 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

Constructor Summary

Constructors

Constructor and Description
SOAP11HeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.soap.SOAPFactory factory) Constructor SOAPHeaderImpl
SOAP11HeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.soap.SOAPFactory factory)
SOAP11HeaderImpl(org.apache.axiom.soap.SOAPFactory factory)

Method Summary

Modifier and Type	Method and Description
org.apache.axiom.soap.SOAPHeaderBlock	addHeaderBlock(String localName, org.apache.axiom.om.OMNamespace ns) Creates a new SOAPHeaderBlock object initialized with the specified name and adds it to this SOAPHeader object.
Iterator	extractHeaderBlocks(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

addChild, checkParent, examineAllHeaderBlocks, examineHeaderBlocks, examineMustUnderstandHeaderBlocks, exceptionToString, extractAllHeaderBlocks, getHeaderBlocksWithNSURI, getHeadersToProcess, getHeadersToProcess

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, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume

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

getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setComplete, setNextOMSibling, setPreviousOMSibling, setType

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

close, getOMFactory, isComplete, 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, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume

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

buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching

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

build, close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

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

setComplete

Constructor Detail

SOAP11HeaderImpl

public SOAP11HeaderImpl(org.apache.axiom.soap.SOAPFactory factory)
                 throws org.apache.axiom.soap.SOAPProcessingException

Throws:

org.apache.axiom.soap.SOAPProcessingException

SOAP11HeaderImpl

public SOAP11HeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope,
                        org.apache.axiom.soap.SOAPFactory factory)
                 throws org.apache.axiom.soap.SOAPProcessingException

Parameters:

envelope -

Throws:

org.apache.axiom.soap.SOAPProcessingException

SOAP11HeaderImpl

public SOAP11HeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope,
                        org.apache.axiom.om.OMXMLParserWrapper builder,
                        org.apache.axiom.soap.SOAPFactory factory)

Constructor SOAPHeaderImpl

Parameters:

envelope -

builder -

Method Detail

addHeaderBlock

public org.apache.axiom.soap.SOAPHeaderBlock addHeaderBlock(String localName,
                                                            org.apache.axiom.om.OMNamespace ns)
                                                     throws org.apache.axiom.om.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 org.apache.axiom.soap.SOAPHeader

Specified by:

addHeaderBlock in class SOAPHeaderImpl

Returns:

the new SOAPHeaderBlock object that was inserted into this SOAPHeader object

Throws:

org.apache.axiom.om.OMException

extractHeaderBlocks

public Iterator extractHeaderBlocks(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 org.apache.axiom.soap.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)