org.apache.axiom.soap.impl.dom.soap11

Class SOAP11HeaderBlockImpl

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

org.apache.axiom.soap.impl.dom.soap11.SOAP11HeaderBlockImpl

All Implemented Interfaces:

IChildNode, IContainer, IElement, IParentNode, NamedNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, OMSourcedElement, SOAPHeaderBlock, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAP11HeaderBlockImpl
extends SOAPHeaderBlockImpl

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
SOAP11HeaderBlockImpl(ParentNode parentNode, java.lang.String localName, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)

Method Summary

Modifier and Type	Method and Description
protected void	checkParent(OMElement parent)
protected OMElement	createClone(OMCloneOptions options, ParentNode targetParent, boolean generateNSDecl)
boolean	getMustUnderstand() Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on.
boolean	getRelay() Returns the relay status associated with this SOAPHeaderBlock object.
java.lang.String	getRole() Returns the uri of the actor associated with this SOAPHeaderBlock object.
SOAPVersion	getVersion() What SOAP version is this HeaderBlock?
void	setMustUnderstand(boolean mustUnderstand) Sets the mustUnderstand attribute for this SOAPHeaderBlock object to be on or off.
void	setMustUnderstand(java.lang.String mustUnderstand)
void	setRelay(boolean relay) Sets the relay attribute for this SOAPHeaderBlock to be either true or false.
void	setRole(java.lang.String roleURI) Sets the actor associated with this SOAPHeaderBlock object to the specified actor.

Methods inherited from class org.apache.axiom.soap.impl.dom.SOAPHeaderBlockImpl

copyData, getAttribute, getDataSource, getObject, isExpanded, isProcessed, setAttribute, setDataSource, setParent, setProcessed

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

addAttribute, addAttribute, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, 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.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

SOAP11HeaderBlockImpl

public SOAP11HeaderBlockImpl(ParentNode parentNode,
                             java.lang.String localName,
                             OMNamespace ns,
                             OMXMLParserWrapper builder,
                             OMFactory factory,
                             boolean generateNSDecl)

Method Detail

checkParent

protected void checkParent(OMElement parent)
                    throws SOAPProcessingException

Specified by:

checkParent in class SOAPHeaderBlockImpl

Throws:

SOAPProcessingException

setRole

public void setRole(java.lang.String roleURI)

Description copied from interface: SOAPHeaderBlock

Sets the actor associated with this SOAPHeaderBlock object to the specified actor.

Parameters:

roleURI - a String giving the URI of the actor to set

See Also:

getRole()

getRole

public java.lang.String getRole()

Description copied from interface: SOAPHeaderBlock

Returns the uri of the actor associated with this SOAPHeaderBlock object.

Returns:

a String giving the URI of the actor

See Also:

setRole(java.lang.String)

setRelay

public void setRelay(boolean relay)

Description copied from interface: SOAPHeaderBlock

Sets the relay attribute for this SOAPHeaderBlock to be either true or false. The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it.

Parameters:

relay - a boolean giving the value to be set

getRelay

public boolean getRelay()

Description copied from interface: SOAPHeaderBlock

Returns the relay status associated with this SOAPHeaderBlock object.

Returns:

a boolean giving the relay status

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

Description copied from interface: SOAPHeaderBlock

Sets the mustUnderstand attribute for this SOAPHeaderBlock object to be on or off.

If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderBlock must process it correctly. This ensures, for example, that if the SOAPHeaderBlock object modifies the message, that the message is being modified correctly.

Parameters:

mustUnderstand - true to set the mustUnderstand attribute on; false to turn if off

See Also:

getMustUnderstand()

setMustUnderstand

public void setMustUnderstand(java.lang.String mustUnderstand)
                       throws SOAPProcessingException

Throws:

SOAPProcessingException

getMustUnderstand

public boolean getMustUnderstand()
                          throws SOAPProcessingException

Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on.

Returns:

true if the mustUnderstand attribute of this SOAPHeaderBlock object is turned on; false otherwise

Throws:

SOAPProcessingException

getVersion

public SOAPVersion getVersion()

What SOAP version is this HeaderBlock?

Returns:

a SOAPVersion, one of the two singletons.

createClone

protected OMElement createClone(OMCloneOptions options,
                                ParentNode targetParent,
                                boolean generateNSDecl)

Overrides:

createClone in class ElementImpl