Package com.sun.xml.messaging.saaj.soap.impl

Class HeaderElementImpl

java.lang.Object

com.sun.xml.messaging.saaj.soap.impl.ElementImpl

com.sun.xml.messaging.saaj.soap.impl.HeaderElementImpl

All Implemented Interfaces:

Node, SOAPBodyElement, SOAPElement, SOAPHeaderElement, Element, Node

Direct Known Subclasses:

HeaderElement1_1Impl, HeaderElement1_2Impl

public abstract class HeaderElementImpl
extends ElementImpl
implements SOAPHeaderElement

Field Summary

Fields

Modifier and Type	Field	Description
protected static Name	MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME
protected static Name	RELAY_ATTRIBUTE_LOCAL_NAME

Fields inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

DSIG_NS, elementQName, WSU_NS, XENC_NS

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderElementImpl(SOAPDocumentImpl ownerDoc, Name qname)
protected	HeaderElementImpl(SOAPDocumentImpl ownerDoc, QName qname)
protected	HeaderElementImpl(SOAPDocumentImpl ownerDoc, Element domElement)

Method Summary

Modifier and Type	Method	Description
String	getActor()	Returns the uri of the actor attribute of this SOAPHeaderElement.
protected abstract NameImpl	getActorAttributeName()
protected abstract String	getActorOrRole()
boolean	getMustUnderstand()	Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.
protected abstract NameImpl	getMustunderstandAttributeName()
protected abstract boolean	getMustunderstandAttributeValue(String str)
protected abstract String	getMustunderstandLiteralValue(boolean mu)
boolean	getRelay()	Returns the boolean value of the relay attribute for this SOAPHeaderElement
protected abstract NameImpl	getRelayAttributeName()
protected abstract boolean	getRelayAttributeValue(String str)
protected abstract String	getRelayLiteralValue(boolean mu)
String	getRole()	Returns the value of the Role attribute of this SOAPHeaderElement.
protected abstract NameImpl	getRoleAttributeName()
void	setActor(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 either true or false.
void	setParentElement(SOAPElement element)	Sets the parent of this Node object to the given SOAPElement object.
void	setRelay(boolean relay)	Sets the relay attribute for this SOAPHeaderElement to be either true or false.
void	setRole(String roleUri)	Sets the Role associated with this SOAPHeaderElement object to the specified Role.

Methods inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

addAttribute, addAttribute, addCDATA, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addElement, addElement, addNamespaceDeclaration, addNode, addText, addTextNode, appendChild, cloneNode, compareDocumentPosition, convertToSoapElement, convertToSoapText, createElement, createElement, createQName, detachNode, doGetNamespacePrefixes, ensureNamespaceIsDeclared, findAndConvertChildElement, findChild, findEncodingStyleAttributeName, getAllAttributes, getAllAttributesAsQNames, getAllAttributesFrom, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getAttributeValueFrom, getBaseURI, getChildElementNodes, getChildElements, getChildElements, getChildElements, getChildElementsFrom, getChildNodes, getDomElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFeature, getFirstChild, getLastChild, getLocalName, getLocalPart, getNamespaceAttr, getNamespaceAttrFrom, getNamespaceContextNodes, getNamespaceContextNodes, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQualifiedName, getSchemaTypeInfo, getSoapDocument, getSOAPNamespace, getTagName, getTextContent, getUserData, getValue, getValueNode, getValueNodeStrict, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importElement, insertBefore, isDefaultNamespace, isEqualNode, isNamespaceQualified, isNamespaceQualified, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, replaceElementWithSOAPElement, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setEncodingStyle, setEncodingStyleNamespace, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setPrefix, setTextContent, setUserData, setValue, tryToFindEncodingStyleAttributeName

Methods inherited from class java.lang.Object

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

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 jakarta.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setValue

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

Methods inherited from interface jakarta.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

Field Detail

RELAY_ATTRIBUTE_LOCAL_NAME

protected static final Name RELAY_ATTRIBUTE_LOCAL_NAME

MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME

protected static final Name MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME

Constructor Detail

HeaderElementImpl

protected HeaderElementImpl(SOAPDocumentImpl ownerDoc,
                            Name qname)

HeaderElementImpl

protected HeaderElementImpl(SOAPDocumentImpl ownerDoc,
                            QName qname)

HeaderElementImpl

protected HeaderElementImpl(SOAPDocumentImpl ownerDoc,
                            Element domElement)

Method Detail

getActorAttributeName

protected abstract NameImpl getActorAttributeName()

getRoleAttributeName

protected abstract NameImpl getRoleAttributeName()

getMustunderstandAttributeName

protected abstract NameImpl getMustunderstandAttributeName()

getMustunderstandAttributeValue

protected abstract boolean getMustunderstandAttributeValue(String str)

getMustunderstandLiteralValue

protected abstract String getMustunderstandLiteralValue(boolean mu)

getRelayAttributeName

protected abstract NameImpl getRelayAttributeName()

getRelayAttributeValue

protected abstract boolean getRelayAttributeValue(String str)

getRelayLiteralValue

protected abstract String getRelayLiteralValue(boolean mu)

getActorOrRole

protected abstract String getActorOrRole()

setParentElement

public void setParentElement(SOAPElement element)
                      throws SOAPException

Description copied from interface: Node

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

Specified by:

setParentElement in interface Node

Overrides:

setParentElement in class ElementImpl

Parameters:

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

Throws:

SOAPException - if there is a problem in setting the parent to the given element

See Also:

Node.getParentElement()

setActor

public void setActor(String actorUri)

Description copied from interface: SOAPHeaderElement

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

If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to SOAPHeaderElement.setRole(String)

Specified by:

setActor in interface SOAPHeaderElement

Parameters:

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

See Also:

SOAPHeaderElement.getActor()

setRole

public void setRole(String roleUri)
             throws SOAPException

Description copied from interface: SOAPHeaderElement

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

Specified by:

setRole in interface SOAPHeaderElement

Parameters:

roleUri - the URI of the Role

Throws:

SOAPException - if there is an error in setting the role

getActor

public String getActor()

Description copied from interface: SOAPHeaderElement

Returns the uri of the actor attribute of this SOAPHeaderElement.

If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to SOAPHeaderElement.getRole()

Specified by:

getActor in interface SOAPHeaderElement

Returns:

a String giving the URI of the actor

See Also:

SOAPHeaderElement.setActor(java.lang.String)

getRole

public String getRole()

Description copied from interface: SOAPHeaderElement

Returns the value of the Role attribute of this SOAPHeaderElement.

Specified by:

getRole in interface SOAPHeaderElement

Returns:

a String giving the URI of the Role

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)

Description copied from interface: SOAPHeaderElement

Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false.

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 SOAPHeaderElement

Parameters:

mustUnderstand - true to set the mustUnderstand attribute to true; false to set it to false

See Also:

SOAPHeaderElement.getMustUnderstand(), SOAPHeaderElement.setRelay(boolean)

getMustUnderstand

public boolean getMustUnderstand()

Description copied from interface: SOAPHeaderElement

Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.

Specified by:

getMustUnderstand in interface SOAPHeaderElement

Returns:

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

setRelay

public void setRelay(boolean relay)
              throws SOAPException

Description copied from interface: SOAPHeaderElement

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 SOAPHeaderElement

Parameters:

relay - the new value of the relay attribute

Throws:

SOAPException - if there is a problem in setting the relay attribute.

See Also:

SOAPHeaderElement.setMustUnderstand(boolean), SOAPHeaderElement.getRelay()

getRelay

public boolean getRelay()

Description copied from interface: SOAPHeaderElement

Returns the boolean value of the relay attribute for this SOAPHeaderElement

Specified by:

getRelay in interface SOAPHeaderElement

Returns:

true if the relay attribute is turned on; false otherwise

See Also:

SOAPHeaderElement.getMustUnderstand(), SOAPHeaderElement.setRelay(boolean)