org.apache.axiom.soap.impl.dom
Class SOAPHeaderBlockImpl

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axiom.om.impl.dom.ChildNode
          org.apache.axiom.om.impl.dom.ParentNode
              org.apache.axiom.om.impl.dom.ElementImpl
                  org.apache.axiom.soap.impl.dom.SOAPHeaderBlockImpl

All Implemented Interfaces:

Cloneable, OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, OMSourcedElement, SOAPHeaderBlock, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

Direct Known Subclasses:

SOAP11HeaderBlockImpl, SOAP12HeaderBlockImpl

public abstract class SOAPHeaderBlockImpl
extends ElementImpl
implements SOAPHeaderBlock

Field Summary

Fields inherited from class org.apache.axiom.om.impl.dom.ElementImpl

localName, namespace

Fields inherited from class org.apache.axiom.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axiom.om.impl.dom.ChildNode

nextSibling, parentNode, previousSibling

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED

Fields inherited from interface org.apache.axiom.soap.SOAPHeaderBlock

MUST_UNDERSTAND_PROPERTY, RELAY_PROPERTY, ROLE_PROPERTY

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.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_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

SOAPHeaderBlockImpl(String localName, OMNamespace ns, OMElement parent, OMXMLParserWrapper builder, SOAPFactory factory)
Constructor SOAPHeaderBlockImpl.

SOAPHeaderBlockImpl(String localName, OMNamespace ns, SOAPFactory factory)

SOAPHeaderBlockImpl(String localName, OMNamespace ns, SOAPHeader parent, SOAPFactory factory)

Method Summary

protected String	getAttribute(String attrName, String soapEnvelopeNamespaceURI) Method getAttribute.
OMDataSource	getDataSource()
boolean	isExpanded()
boolean	isProcessed()
protected void	setAttribute(String attributeName, String attrValue, String soapEnvelopeNamespaceURI)
OMDataSource	setDataSource(OMDataSource dataSource) Replace an existing OMDataSource with a new one.
void	setProcessed() We need to know whether all the mustUnderstand headers have been processed by the node.

Methods inherited from class org.apache.axiom.om.impl.dom.ElementImpl

addAttribute, addAttribute, buildWithAttachments, cloneNode, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setOwnerDocument, setText, setText, setType, toString, toStringWithConsume

Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode

addChild, buildNext, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, getTextContent, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

Methods inherited from class org.apache.axiom.om.impl.dom.ChildNode

detach, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

appendChild, build, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getOwnerDocument, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setPrefix, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.axiom.soap.SOAPHeaderBlock

getMustUnderstand, getRelay, getRole, getVersion, setMustUnderstand, setMustUnderstand, setRelay, setRole

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, buildWithAttachments, close, 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, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

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

setComplete

Constructor Detail

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(String localName,
                           OMNamespace ns,
                           SOAPHeader parent,
                           SOAPFactory factory)
                    throws SOAPProcessingException

Parameters:

localName -

ns -

parent -

Throws:

SOAPProcessingException

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(String localName,
                           OMNamespace ns,
                           SOAPFactory factory)
                    throws SOAPProcessingException

Throws:

SOAPProcessingException

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(String localName,
                           OMNamespace ns,
                           OMElement parent,
                           OMXMLParserWrapper builder,
                           SOAPFactory factory)

Constructor SOAPHeaderBlockImpl.

Parameters:

localName -

ns -

parent -

builder -

Method Detail

setAttribute

protected void setAttribute(String attributeName,
                            String attrValue,
                            String soapEnvelopeNamespaceURI)

Parameters:

attributeName -

attrValue -

soapEnvelopeNamespaceURI -

getAttribute

protected String getAttribute(String attrName,
                              String soapEnvelopeNamespaceURI)

Method getAttribute.

Parameters:

attrName -

Returns:

Returns String.

isProcessed

public boolean isProcessed()

Specified by:

isProcessed in interface SOAPHeaderBlock

setProcessed

public void setProcessed()

Description copied from interface: SOAPHeaderBlock

We need to know whether all the mustUnderstand headers have been processed by the node. This will done by a specific validation handler at the end of the execution chain. For this all the handlers who process a particular header block must explicitly say that he processesd the header by calling setProcessed()

Specified by:

setProcessed in interface SOAPHeaderBlock

getDataSource

public OMDataSource getDataSource()

Specified by:

getDataSource in interface OMSourcedElement

Returns:

OMDataSource

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface OMSourcedElement

Returns:

true if tree is expanded or being expanded.

setDataSource

public OMDataSource setDataSource(OMDataSource dataSource)

Description copied from interface: OMSourcedElement

Replace an existing OMDataSource with a new one.

Specified by:

setDataSource in interface OMSourcedElement

Parameters:

dataSource - new OMDataSource

Returns:

null or old OMDataSource