SOAPHeaderImpl (Axiom Impl API)

java.lang.Object
- org.apache.axiom.om.impl.common.InformationItem
- - org.apache.axiom.om.impl.llom.OMInformationItemImpl
  - - 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:

org.apache.axiom.core.CoreChildNode, org.apache.axiom.core.CoreElement, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.om.impl.common.AxiomChildNode, org.apache.axiom.om.impl.common.AxiomContainer, org.apache.axiom.om.impl.common.AxiomElement, org.apache.axiom.om.impl.common.AxiomInformationItem, org.apache.axiom.om.impl.common.AxiomNamedInformationItem, org.apache.axiom.om.impl.common.AxiomSerializable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMElementEx, 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.OMInformationItem, org.apache.axiom.om.OMNamedInformationItem, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable, org.apache.axiom.soap.SOAPHeader

Direct Known Subclasses:

SOAP11HeaderImpl, SOAP12HeaderImpl
```
public abstract class SOAPHeaderImpl
extends SOAPElement
implements org.apache.axiom.soap.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, namespaces
- 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.core.CoreParentNode
  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

Constructors
Modifier	Constructor and Description
`protected`	`SOAPHeaderImpl(org.apache.axiom.om.OMNamespace ns, org.apache.axiom.soap.SOAPFactory factory)`
	`SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.soap.SOAPFactory factory)` Constructor SOAPHeaderImpl
	`SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.soap.SOAPFactory factory)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(org.apache.axiom.om.OMNode child, boolean fromBuilder)`
`org.apache.axiom.soap.SOAPHeaderBlock`	`addHeaderBlock(QName qname)`
`org.apache.axiom.soap.SOAPHeaderBlock`	`addHeaderBlock(String localName, org.apache.axiom.om.OMNamespace ns)`
`protected void`	`checkParent(org.apache.axiom.om.OMElement parent)` This has to be implemented by all the derived classes to check for the correct parent.
`protected org.apache.axiom.om.OMElement`	`createClone(org.apache.axiom.om.OMCloneOptions options, org.apache.axiom.om.OMContainer targetParent)`
`Iterator`	`examineAllHeaderBlocks()`
`Iterator`	`examineHeaderBlocks(String role)`
`Iterator`	`examineMustUnderstandHeaderBlocks(String actor)`
`static String`	`exceptionToString(Throwable e)`
`Iterator`	`extractAllHeaderBlocks()`
`abstract Iterator`	`extractHeaderBlocks(String role)`
`ArrayList`	`getHeaderBlocksWithNSURI(String nsURI)`
`Iterator`	`getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer)`
`Iterator`	`getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer, String namespace)`

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

Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, addNamespaceDeclaration, addNamespaceDeclaration, build, buildWithAttachments, checkChild, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getDefaultNamespace, getLineNumber, getNamespaceURI, internalSerialize, removeAttribute, setComplete, setLineNumber, setNamespace, toString, toStringWithConsume, undeclarePrefix

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

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

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, 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, getSAXResult, 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, hasName, setLocalName, setNamespace

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomElement
detachAndDiscardParent, discard, getChildElements, getFirstElement, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, getType, handleNamespace, insertChild, resolveQName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, writeTextTo

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomContainer
addChild, defaultBuild, discarded, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, isComplete, prepareNewChild, removeChildren, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomChildNode
detach, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomSerializable
close, getBuilder, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomInformationItem
coreGetNodeFactory

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomNamedInformationItem
getLocalName, getNamespace, getPrefix, getQName, handleNamespace, hasName, internalGetLocalName, internalSetLocalName, internalSetNamespace, setLocalName

Methods inherited from interface org.apache.axiom.core.CoreChildNode
coreDetach, coreGetNextSibling, coreGetNextSiblingIfAvailable, coreGetParent, coreGetPreviousSibling, coreHasParent, coreInsertSiblingAfter, coreInsertSiblingBefore, coreInsertSiblingsBefore, coreSetNextSibling, coreSetOwnerDocument, coreSetPreviousSibling, internalUnsetParent

Methods inherited from interface org.apache.axiom.core.DeferringParentNode
coreSetBuilder, coreSetState, forceExpand, getBuilder, getState

Methods inherited from interface org.apache.axiom.core.CoreParentNode
buildNext, coreAppendChild, coreAppendChildren, coreGetFirstChild, coreGetFirstChildIfAvailable, coreGetLastChild, coreGetLastKnownChild, coreRemoveChildren

Constructor Detail

SOAPHeaderImpl

protected SOAPHeaderImpl(org.apache.axiom.om.OMNamespace ns,
              org.apache.axiom.soap.SOAPFactory factory)

SOAPHeaderImpl

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

Throws:: org.apache.axiom.soap.SOAPProcessingException

SOAPHeaderImpl

public SOAPHeaderImpl(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
```
  Specified by:
  
  addHeaderBlock in interface org.apache.axiom.soap.SOAPHeader
  
  Throws:
  
  org.apache.axiom.om.OMException
- addHeaderBlock
```
public org.apache.axiom.soap.SOAPHeaderBlock addHeaderBlock(QName qname)
                                                     throws org.apache.axiom.om.OMException
```
  Specified by:
  
  addHeaderBlock in interface org.apache.axiom.soap.SOAPHeader
  
  Throws:
  
  org.apache.axiom.om.OMException
- getHeadersToProcess
```
public Iterator getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer)
```
  Specified by:
  
  getHeadersToProcess in interface org.apache.axiom.soap.SOAPHeader
- getHeadersToProcess
```
public Iterator getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer,
                           String namespace)
```
  Specified by:
  
  getHeadersToProcess in interface org.apache.axiom.soap.SOAPHeader
- examineHeaderBlocks
```
public Iterator examineHeaderBlocks(String role)
```
  Specified by:
  
  examineHeaderBlocks in interface org.apache.axiom.soap.SOAPHeader
- extractHeaderBlocks
```
public abstract Iterator extractHeaderBlocks(String role)
```
  Specified by:
  
  extractHeaderBlocks in interface org.apache.axiom.soap.SOAPHeader
- examineMustUnderstandHeaderBlocks
```
public Iterator examineMustUnderstandHeaderBlocks(String actor)
```
  Specified by:
  
  examineMustUnderstandHeaderBlocks in interface org.apache.axiom.soap.SOAPHeader
- examineAllHeaderBlocks
```
public Iterator examineAllHeaderBlocks()
```
  Specified by:
  
  examineAllHeaderBlocks in interface org.apache.axiom.soap.SOAPHeader
- extractAllHeaderBlocks
```
public Iterator extractAllHeaderBlocks()
```
  Specified by:
  
  extractAllHeaderBlocks in interface org.apache.axiom.soap.SOAPHeader
- getHeaderBlocksWithNSURI
```
public ArrayList getHeaderBlocksWithNSURI(String nsURI)
```
  Specified by:
  
  getHeaderBlocksWithNSURI in interface org.apache.axiom.soap.SOAPHeader
- checkParent
```
protected void checkParent(org.apache.axiom.om.OMElement parent)
                    throws org.apache.axiom.soap.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:
  
  org.apache.axiom.soap.SOAPProcessingException
- addChild
```
public void addChild(org.apache.axiom.om.OMNode child,
            boolean fromBuilder)
```
  Specified by:
  
  addChild in interface org.apache.axiom.om.impl.common.AxiomContainer
  
  Specified by:
  
  addChild in interface org.apache.axiom.om.impl.OMContainerEx
- exceptionToString
```
public static String exceptionToString(Throwable e)
```
- createClone
```
protected org.apache.axiom.om.OMElement createClone(org.apache.axiom.om.OMCloneOptions options,
                                        org.apache.axiom.om.OMContainer targetParent)
```
  Overrides:
  
  createClone in class OMElementImpl

Class SOAPHeaderImpl

Field Summary

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

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

Fields inherited from interface org.apache.axiom.core.CoreParentNode

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

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

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

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

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

Methods inherited from interface org.apache.axiom.core.CoreChildNode

Methods inherited from interface org.apache.axiom.core.DeferringParentNode

Methods inherited from interface org.apache.axiom.core.CoreParentNode

Constructor Detail

SOAPHeaderImpl

SOAPHeaderImpl

SOAPHeaderImpl

Method Detail

addHeaderBlock

addHeaderBlock

getHeadersToProcess

getHeadersToProcess

examineHeaderBlocks

extractHeaderBlocks

examineMustUnderstandHeaderBlocks

examineAllHeaderBlocks

extractAllHeaderBlocks

getHeaderBlocksWithNSURI

checkParent

addChild

exceptionToString

createClone