org.jboss.ws.core.soap

Class SOAPHeaderElementImpl

java.lang.Object

org.jboss.ws.core.soap.NodeImpl

org.jboss.ws.core.soap.SOAPElementImpl

org.jboss.ws.core.soap.SOAPContentElement

org.jboss.ws.core.soap.SOAPHeaderElementImpl

All Implemented Interfaces:

SOAPElement, SOAPHeaderElement, SOAPContentAccess, Element, Node

public class SOAPHeaderElementImpl
extends SOAPContentElement
implements SOAPHeaderElement

An object representing the contents in the SOAP header part of the SOAP envelope. The immediate children of a SOAPHeader object can be represented only as SOAPHeaderElement objects. A SOAPHeaderElement object can have other SOAPElement objects as its children.

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields inherited from class org.jboss.ws.core.soap.SOAPContentElement

GENERIC_PARAM_NAME, GENERIC_RETURN_NAME, soapContent

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

domNode, soapParent

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

Constructor and Description
SOAPHeaderElementImpl(Name name)
SOAPHeaderElementImpl(QName qname)
SOAPHeaderElementImpl(SOAPElementImpl element)

Method Summary

Methods

Modifier and Type	Method and Description
String	getActor() Returns the uri of the actor attribute of this SOAPHeaderElement.
boolean	getMustUnderstand() Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.
boolean	getRelay() Returns the boolean value of the relay attribute for this SOAPHeaderElement
String	getRole() Returns the value of the Role attribute of this SOAPHeaderElement.
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 parent) 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.
void	writeElement(Writer writer) The default implementation uses a DOMWriter.

Methods inherited from class org.jboss.ws.core.soap.SOAPContentElement

accept, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, cloneNode, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getChildElements, getChildElements, getChildNodes, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getJavaType, getLastChild, getNamespacePrefixes, getNamespaceURI, getNextSibling, getObjectValue, getParamMetaData, getPreviousSibling, getSchemaTypeInfo, getTagName, getValue, getVisibleNamespacePrefixes, getXMLFragment, getXmlType, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setObjectValue, setParamMetaData, setValue, setXMLFragment, transitionTo

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl

addAttribute, addChildElement, createQName, getAllAttributesAsQNames, getAttributeValue, getChildElements, getElementQName, getFirstChildElementByLocalName, getSOAPEnvelope, removeAttribute, setElementQName, setElementQNameInternal, setEncodingStyle, setPrefix, writeElementContent

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

compareDocumentPosition, detachNode, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getTextContent, getUserData, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, setNodeValue, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, 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(Name name)

SOAPHeaderElementImpl

public SOAPHeaderElementImpl(QName qname)

SOAPHeaderElementImpl

public SOAPHeaderElementImpl(SOAPElementImpl element)

Method Detail

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

setRole

public void setRole(String roleURI)

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

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)

setRelay

public void setRelay(boolean relay)

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

See Also:

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

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)

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()

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

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)

setParentElement

public void setParentElement(SOAPElement parent)
                      throws SOAPException

Description copied from class: NodeImpl

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

Overrides:

setParentElement in class NodeImpl

Parameters:

parent - 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()

writeElement

public void writeElement(Writer writer)
                  throws IOException

Description copied from class: SOAPElementImpl

The default implementation uses a DOMWriter. SOAPContentElements overwrite this to optimize DOM callbacks.

Overrides:

writeElement in class SOAPContentElement

Throws:

IOException