org.apache.axiom.soap.impl.dom

Class SOAPHeaderBlockImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

org.apache.axiom.om.impl.dom.ElementImpl

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

All Implemented Interfaces:

IChildNode, IContainer, IElement, IParentNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, OMSourcedElement, SOAPHeaderBlock, Element, Node, 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

builder, localName, namespace, state

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

firstChild, lastChild

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

factory, FIRSTCHILD, flags, HAS_PARENT, 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.impl.common.IParentNode

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

Constructor and Description
SOAPHeaderBlockImpl(ParentNode parentNode, String localName, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkParent(OMElement parent)
protected void	copyData(OMCloneOptions options, SOAPHeaderBlock targetSHB)
protected String	getAttribute(String attrName, String soapEnvelopeNamespaceURI) Method getAttribute.
OMDataSource	getDataSource()
Object	getObject(Class dataSourceClass) Get the object that backs the data source set on this element.
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.
protected void	setParent(ParentNode parent, boolean useDomSemantics)
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, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, createClone, declareDefaultNamespace, declareNamespace, declareNamespace, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getIParentNode, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNextSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getState, getTagName, getText, getTextAsQName, getTextAsStream, getType, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSetNamespace, isComplete, lookupNamespaceURI, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChildren, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setComplete, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setPrefix, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

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

addChild, addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, insertBefore, item, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

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

clone, cloneNode, close, compareDocumentPosition, detach, getBaseURI, getFeature, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, getUserData, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setPreviousOMSibling, 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, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, 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, 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, setLocalName

Methods inherited from interface org.w3c.dom.Node

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

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

getLastKnownOMChild, setFirstChild, setLastChild

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

addChild

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

getFirstOMChildIfAvailable

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

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling

Constructor Detail

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(ParentNode parentNode,
                           String localName,
                           OMNamespace ns,
                           OMXMLParserWrapper builder,
                           OMFactory factory,
                           boolean generateNSDecl)

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

getObject

public Object getObject(Class dataSourceClass)

Description copied from interface: OMSourcedElement

Get the object that backs the data source set on this element. This method provides a safe way to access that object. It will return a non null value if all of the following conditions are satisfied:

1. The element is configured with an OMDataSource of the type specified by the dataSourceClass parameter (in the sense of Class.isInstance(Object)).
2. The OMDataSourceExt.getObject() method returns a non null value on the configured data source.
3. The instance can ensure that the content of the element has not been modified. This is always the case if the element has not been expanded (i.e. if OMSourcedElement.isExpanded() returns false), but the implementation may use additional mechanisms to detect changes after expansion of the element.

These are exactly the conditions that must be satisfied if the application code wants to implement optimized processing of the sourced element by accessing the backing object.

Specified by:

getObject in interface OMSourcedElement

Parameters:

dataSourceClass - the expected data source class; must be assignment compatible with OMDataSourceExt

Returns:

the backing Java object or null if the conditions specified above are not satisfied

checkParent

protected abstract void checkParent(OMElement parent)
                             throws SOAPProcessingException

Throws:

SOAPProcessingException

setParent

protected void setParent(ParentNode parent,
                         boolean useDomSemantics)

Overrides:

setParent in class NodeImpl

copyData

protected final void copyData(OMCloneOptions options,
                              SOAPHeaderBlock targetSHB)