public interface SOAPHeaderElement extends SOAPElement
SOAPHeader object can
be represented only as SOAPHeaderElement objects.
A SOAPHeaderElement object can have other
SOAPElement objects as its children.
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| 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 |
setRelay(boolean relay)
Sets the relay attribute for this
SOAPHeaderElement to be
either true or false. |
void |
setRole(String uri)
Sets the
Role associated with this SOAPHeaderElement
object to the specified Role. |
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, setEncodingStyledetachNode, getParentElement, getValue, recycleNode, setParentElement, setValuegetAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNSappendChild, 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, setUserDatavoid setActor(String actorURI)
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 setRole(String)
actorURI - a String giving the URI of the actor
to setIllegalArgumentException - if there is a problem in
setting the actor.getActor()void setRole(String uri) throws SOAPException
Role associated with this SOAPHeaderElement
object to the specified Role.uri - - the URI of the RoleSOAPException - if there is an error in setting the roleUnsupportedOperationException - if this message does not
support the SOAP 1.2 concept of Fault Role.String getActor()
SOAPHeaderElement.
If this SOAPHeaderElement supports SOAP 1.2 then this call is
equivalent to getRole()
String giving the URI of the actorsetActor(java.lang.String)String getRole()
SOAPHeaderElement.String giving the URI of the RoleUnsupportedOperationException - if this message does not
support the SOAP 1.2 concept of Fault Role.void setMustUnderstand(boolean mustUnderstand)
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.
mustUnderstand - true to set the mustUnderstand
attribute to true; false to set it to falseIllegalArgumentException - if there is a problem in
setting the mustUnderstand attributegetMustUnderstand(),
setRelay(boolean)boolean getMustUnderstand()
SOAPHeaderElement.true if the mustUnderstand attribute of this
SOAPHeaderElement object is turned on; false
otherwisevoid setRelay(boolean relay)
throws SOAPException
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.
relay - the new value of the relay attributeSOAPException - if there is a problem in setting the
relay attribute.UnsupportedOperationException - if this message does not
support the SOAP 1.2 concept of Relay attribute.setMustUnderstand(boolean),
getRelay()boolean getRelay()
SOAPHeaderElementtrue if the relay attribute is turned on;
false otherwiseUnsupportedOperationException - if this message does not
support the SOAP 1.2 concept of Relay attribute.getMustUnderstand(),
setRelay(boolean) Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138