org.apache.axis2.saaj

Class SOAPHeaderElementImpl

java.lang.Object

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

org.apache.axis2.saaj.NodeImplEx

org.apache.axis2.saaj.SOAPElementImpl

org.apache.axis2.saaj.SOAPHeaderElementImpl

All Implemented Interfaces:

java.lang.Cloneable, javax.xml.soap.SOAPElement, javax.xml.soap.SOAPHeaderElement, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPHeaderElementImpl
extends SOAPElementImpl
implements javax.xml.soap.SOAPHeaderElement

Field Summary

Fields inherited from class org.apache.axis2.saaj.SOAPElementImpl

element

Fields inherited from class org.apache.axis2.saaj.NodeImplEx

parentElement

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

DTD_NODE, PI_NODE, SPACE_NODE

Constructor Summary

Constructors

Constructor and Description
SOAPHeaderElementImpl(org.apache.axiom.soap.SOAPHeaderBlock element)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActor() Returns the uri of the actor associated with this SOAPHeaderElement object.
boolean	getMustUnderstand() Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
boolean	getRelay()
java.lang.String	getRole()
void	setActor(java.lang.String actorURI) Sets the actor associated with this SOAPHeaderElement object to the specified actor.
void	setMustUnderstand(boolean mustUnderstand) Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.
void	setParentElement(javax.xml.soap.SOAPElement parent) Sets the parent of this Node object to the given SOAPElement object.
void	setRelay(boolean flag) Sets the relay attribute for this SOAPHeaderElement to be either true or false.
void	setRole(java.lang.String uri) Sets the Role associated with this SOAPHeaderElement object to the specified Role.

Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, appendElement, appendText, clone, copyContents, createQName, detach, detachNode, discard, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getChildNodes, getElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getTextContent, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setEncodingStyle, setParent, setValue, toString

Methods inherited from class org.apache.axis2.saaj.NodeImplEx

getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType

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

build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getPreviousOMSibling, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setValue

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Constructor Detail

SOAPHeaderElementImpl

public SOAPHeaderElementImpl(org.apache.axiom.soap.SOAPHeaderBlock element)

Parameters:

element -

Method Detail

setActor

public void setActor(java.lang.String actorURI)

Sets the actor associated with this SOAPHeaderElement object to the specified actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT

Specified by:

setActor in interface javax.xml.soap.SOAPHeaderElement

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if there is a problem in setting the actor.

See Also:

getActor()

getActor

public java.lang.String getActor()

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

Specified by:

getActor in interface javax.xml.soap.SOAPHeaderElement

Returns:

a String giving the URI of the actor

See Also:

setActor(java.lang.String)

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

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

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

Specified by:

setMustUnderstand in interface javax.xml.soap.SOAPHeaderElement

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if there is a problem in setting the actor.

See Also:

getMustUnderstand()

getMustUnderstand

public boolean getMustUnderstand()

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

Specified by:

getMustUnderstand in interface javax.xml.soap.SOAPHeaderElement

Returns:

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

setRole

public void setRole(java.lang.String uri)
             throws javax.xml.soap.SOAPException

Sets the Role associated with this SOAPHeaderElement object to the specified Role.

Specified by:

setRole in interface javax.xml.soap.SOAPHeaderElement

Parameters:

uri - - the URI of the Role

Throws:

javax.xml.soap.SOAPException - - if there is an error in setting the role java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.

getRole

public java.lang.String getRole()

Specified by:

getRole in interface javax.xml.soap.SOAPHeaderElement

setRelay

public void setRelay(boolean flag)
              throws javax.xml.soap.SOAPException

Sets the relay attribute for this SOAPHeaderElement 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. This attribute is ignored on header blocks whose mustUnderstand attribute is set to true or that are targeted at the ultimate reciever (which is the default). The default value of this attribute is false.

Specified by:

setRelay in interface javax.xml.soap.SOAPHeaderElement

Parameters:

relay - - the new value of the relay attribute

Throws:

javax.xml.soap.SOAPException - - if there is a problem in setting the relay attribute. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.

getRelay

public boolean getRelay()

Specified by:

getRelay in interface javax.xml.soap.SOAPHeaderElement

setParentElement

public void setParentElement(javax.xml.soap.SOAPElement parent)
                      throws javax.xml.soap.SOAPException

Description copied from class: NodeImplEx

Sets the parent of this Node object to the given SOAPElement object.

Overrides:

setParentElement in class SOAPElementImpl

Parameters:

parent - the SOAPElement object to be set as the parent of this Node object

Throws:

javax.xml.soap.SOAPException - if there is a problem in setting the parent to the given element

See Also:

getParentElement()