SOAPHeaderImpl (LLOM API)

java.lang.Object
- 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.CoreCharacterDataSinkNode, org.apache.axiom.core.CoreChildNode, org.apache.axiom.core.CoreElement, org.apache.axiom.core.CoreMixedContentContainer, org.apache.axiom.core.CoreNamedNode, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreNSAwareElement, org.apache.axiom.core.CoreNSAwareNamedNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.om.impl.intf.AxiomChildNode, org.apache.axiom.om.impl.intf.AxiomContainer, org.apache.axiom.om.impl.intf.AxiomCoreParentNode, org.apache.axiom.om.impl.intf.AxiomElement, org.apache.axiom.om.impl.intf.AxiomInformationItem, org.apache.axiom.om.impl.intf.AxiomNamedInformationItem, org.apache.axiom.om.impl.intf.AxiomSerializable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMElementEx, org.apache.axiom.om.impl.OMNodeEx, 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.shared.INSAwareNamedNode, org.apache.axiom.soap.impl.intf.AxiomSOAPElement, org.apache.axiom.soap.impl.intf.AxiomSOAPHeader, org.apache.axiom.soap.SOAPHeader

Direct Known Subclasses:

SOAP11HeaderImpl, SOAP12HeaderImpl
```
public abstract class SOAPHeaderImpl
extends SOAPElement
implements org.apache.axiom.soap.impl.intf.AxiomSOAPHeader
```
A class representing the SOAP Header, primarily allowing access to the contained HeaderBlocks.

Field Summary
- 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
  COMPACT, COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors
Constructor and Description

SOAPHeaderImpl()

Constructors
Constructor and Description
`SOAPHeaderImpl()`

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)`
`void`	`checkParent(org.apache.axiom.om.OMElement parent)`
`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.OMInformationItemImpl
coreGetNodeFactory, getMetaFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement
getOMFactory, getSOAPHelper

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomElement
_setAttributeValue, addAttribute, addAttribute, addNamespaceDeclaration, addNamespaceDeclaration, buildWithAttachments, checkChild, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, defaultInternalSerialize, detachAndDiscardParent, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, getType, handleNamespace, initName, insertChild, internalAppendAttribute, internalSerialize, removeAttribute, resolveQName, setComplete, setLineNumber, setNamespace, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

Methods inherited from interface org.apache.axiom.om.OMElement
serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, hasName, setLocalName

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomContainer
addChild, build, defaultGetXMLStreamReader, discarded, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, notifyChildComplete, prepareNewChild, removeChildren, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomCoreParentNode
isComplete

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

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomInformationItem
clone, getMetaFactory

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

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomNamedInformationItem
coreGetLocalName, coreGetNamespaceURI, coreGetPrefix, coreSetName, coreSetPrefix, defaultGetNamespace, defaultGetQName, getNamespace, getQName, hasName, initName, internalGetLocalName, internalSetLocalName, internalSetNamespace, setLocalName, updateLocalName

Methods inherited from interface org.apache.axiom.shared.INSAwareNamedNode
getLocalName, getNamespaceURI, getPrefix

Methods inherited from interface org.apache.axiom.core.CoreNSAwareElement
coreGetNodeType, getImplicitNamespaceURI, getImplicitPrefix

Methods inherited from interface org.apache.axiom.core.CoreElement
coreAppendAttribute, coreGetAttribute, coreGetAttributesByType, coreGetFirstAttribute, coreGetLastAttribute, coreLookupNamespaceURI, coreLookupPrefix, coreRemoveAttribute, coreSetAttribute, coreSetAttribute, init, initSource

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

Methods inherited from interface org.apache.axiom.core.CoreMixedContentContainer
coreGetCharacterData

Methods inherited from interface org.apache.axiom.core.CoreCharacterDataSinkNode
coreSetCharacterData

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

Methods inherited from interface org.apache.axiom.core.CoreParentNode
buildNext, cloneChildrenIfNecessary, coreAppendChild, coreAppendChildren, coreGetElements, coreGetFirstChild, coreGetFirstChild, coreGetFirstChildIfAvailable, coreGetLastChild, coreGetLastChild, coreGetLastKnownChild, coreGetNodes, coreRemoveChildren, coreSetCharacterData, coreSetState, forceExpand, getState, isExpanded

- Constructor Detail
  - SOAPHeaderImpl
```
public SOAPHeaderImpl()
```
- 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
```
public void checkParent(org.apache.axiom.om.OMElement parent)
                 throws org.apache.axiom.soap.SOAPProcessingException
```
    Specified by:
    
    checkParent in interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement
    
    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.intf.AxiomContainer
    
    Specified by:
    
    addChild in interface org.apache.axiom.om.impl.OMContainerEx
  - exceptionToString
```
public static String exceptionToString(Throwable e)
```

Class SOAPHeaderImpl

Field Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement

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

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

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

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

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

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomCoreParentNode

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

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

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

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

Methods inherited from interface org.apache.axiom.shared.INSAwareNamedNode

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

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

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

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

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

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

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

Constructor Detail

SOAPHeaderImpl

Method Detail

addHeaderBlock

addHeaderBlock

getHeadersToProcess

getHeadersToProcess

examineHeaderBlocks

extractHeaderBlocks

examineMustUnderstandHeaderBlocks

examineAllHeaderBlocks

extractAllHeaderBlocks

getHeaderBlocksWithNSURI

checkParent

addChild

exceptionToString