org.apache.axiom.soap.impl.llom

Class SOAPHeaderBlockImpl

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.om.impl.llom.OMSourcedElementImpl

org.apache.axiom.soap.impl.llom.SOAPHeaderBlockImpl

All Implemented Interfaces:

IChildNode, IContainer, IElement, IParentNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, OMSourcedElement, SOAPHeaderBlock

Direct Known Subclasses:

SOAP11HeaderBlockImpl, SOAP12HeaderBlockImpl

public abstract class SOAPHeaderBlockImpl
extends OMSourcedElementImpl
implements SOAPHeaderBlock

Class SOAPHeaderBlockImpl

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	processed

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

attributes, builder, firstChild, lastChild, localName, namespaces, ns, qName, state

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

nextSibling, parent, previousSibling

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

factory

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.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(OMContainer parent, java.lang.String localName, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)
SOAPHeaderBlockImpl(SOAPFactory factory, OMDataSource source)
SOAPHeaderBlockImpl(java.lang.String localName, OMNamespace ns, SOAPFactory factory, OMDataSource ds)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkParent(OMElement parent)
private void	copyData(OMCloneOptions options, SOAPHeaderBlock targetSHB)
protected OMElement	createClone(OMCloneOptions options, OMContainer targetParent)
protected OMSourcedElement	createClone(OMCloneOptions options, OMDataSource ds)
protected java.lang.String	getAttribute(java.lang.String attrName, java.lang.String soapEnvelopeNamespaceURI) Method getAttribute.
protected java.lang.String	getOMDataSourceProperty(java.lang.String key)
protected boolean	hasOMDataSourceProperty(java.lang.String key)
boolean	isProcessed()
protected void	setAttribute(java.lang.String attributeName, java.lang.String attrValue, java.lang.String soapEnvelopeNamespaceURI)
void	setParent(OMContainer element) Method setParent.
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.llom.OMSourcedElementImpl

addAttribute, addAttribute, addChild, addChild, addNamespaceDeclaration, build, buildWithAttachments, clone, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDataSource, getDefaultNamespace, getDescendants, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLastKnownOMChild, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getNextOMSibling, getNextOMSiblingIfAvailable, getObject, getPrefix, getQName, getSAXSource, getState, getText, getTextAsQName, getTextAsStream, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, isComplete, isExpanded, removeAttribute, removeChildren, resolveQName, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setComplete, setDataSource, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

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

getIParentNode, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

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

close, getOMFactory, serialize

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

getDataSource, getObject, isExpanded, setDataSource

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.apache.axiom.om.impl.common.IChildNode

getIParentNode

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

internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

Field Detail

processed

private boolean processed

Constructor Detail

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(OMContainer parent,
                           java.lang.String localName,
                           OMNamespace ns,
                           OMXMLParserWrapper builder,
                           OMFactory factory,
                           boolean generateNSDecl)

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(SOAPFactory factory,
                           OMDataSource source)

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl(java.lang.String localName,
                           OMNamespace ns,
                           SOAPFactory factory,
                           OMDataSource ds)

Method Detail

checkParent

protected abstract void checkParent(OMElement parent)
                             throws SOAPProcessingException

Throws:

SOAPProcessingException

setParent

public void setParent(OMContainer element)

Description copied from class: OMNodeImpl

Method setParent.

Specified by:

setParent in interface OMNodeEx

Overrides:

setParent in class OMNodeImpl

setAttribute

protected void setAttribute(java.lang.String attributeName,
                            java.lang.String attrValue,
                            java.lang.String soapEnvelopeNamespaceURI)

Parameters:

attributeName -

attrValue -

soapEnvelopeNamespaceURI -

getAttribute

protected java.lang.String getAttribute(java.lang.String attrName,
                                        java.lang.String soapEnvelopeNamespaceURI)

Method getAttribute.

Parameters:

attrName -

soapEnvelopeNamespaceURI -

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

getOMDataSourceProperty

protected java.lang.String getOMDataSourceProperty(java.lang.String key)

Parameters:

key -

Returns:

requested OMDataSourceExt property or null

hasOMDataSourceProperty

protected boolean hasOMDataSourceProperty(java.lang.String key)

Parameters:

key -

Returns:

requested OMDataSourceExt property or null

createClone

protected OMElement createClone(OMCloneOptions options,
                                OMContainer targetParent)

Overrides:

createClone in class OMSourcedElementImpl

createClone

protected OMSourcedElement createClone(OMCloneOptions options,
                                       OMDataSource ds)

Overrides:

createClone in class OMSourcedElementImpl

copyData

private void copyData(OMCloneOptions options,
                      SOAPHeaderBlock targetSHB)