public abstract class HeaderElementImpl extends ElementImpl implements SOAPHeaderElement
Modifier and Type | Field and Description |
---|---|
protected static Name |
MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME |
protected static Name |
RELAY_ATTRIBUTE_LOCAL_NAME |
DSIG_NS, elementQName, log, WSU_NS, XENC_NS, XML_URI, XMLNS_URI
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 and Description |
---|
HeaderElementImpl(SOAPDocumentImpl ownerDoc,
Element domElement) |
HeaderElementImpl(SOAPDocumentImpl ownerDoc,
Name qname) |
HeaderElementImpl(SOAPDocumentImpl ownerDoc,
QName qname) |
Modifier and Type | Method and 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 . |
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
detachNode, getParentElement, getValue, recycleNode, setValue
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
protected static Name RELAY_ATTRIBUTE_LOCAL_NAME
protected static Name MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME
public HeaderElementImpl(SOAPDocumentImpl ownerDoc, Name qname)
public HeaderElementImpl(SOAPDocumentImpl ownerDoc, QName qname)
public HeaderElementImpl(SOAPDocumentImpl ownerDoc, Element domElement)
protected abstract NameImpl getActorAttributeName()
protected abstract NameImpl getRoleAttributeName()
protected abstract NameImpl getMustunderstandAttributeName()
protected abstract boolean getMustunderstandAttributeValue(String str)
protected abstract String getMustunderstandLiteralValue(boolean mu)
protected abstract NameImpl getRelayAttributeName()
protected abstract boolean getRelayAttributeValue(String str)
protected abstract String getRelayLiteralValue(boolean mu)
protected abstract String getActorOrRole()
public void setParentElement(SOAPElement element) throws SOAPException
Node
Node
object to the given
SOAPElement
object.setParentElement
in class ElementImpl
element
- the SOAPElement
object to be set as
the parent of this Node
objectSOAPException
- if there is a problem in setting the
parent to the given elementNode.getParentElement()
public void setActor(String actorUri)
SOAPHeaderElement
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)
setActor
in interface SOAPHeaderElement
actorUri
- a String
giving the URI of the actor
to setSOAPHeaderElement.getActor()
public void setRole(String roleUri) throws SOAPException
SOAPHeaderElement
Role
associated with this SOAPHeaderElement
object to the specified Role
.setRole
in interface SOAPHeaderElement
roleUri
- - the URI of the Role
SOAPException
- if there is an error in setting the rolepublic String getActor()
SOAPHeaderElement
SOAPHeaderElement
.
If this SOAPHeaderElement
supports SOAP 1.2 then this call is
equivalent to SOAPHeaderElement.getRole()
getActor
in interface SOAPHeaderElement
String
giving the URI of the actorSOAPHeaderElement.setActor(java.lang.String)
public String getRole()
SOAPHeaderElement
SOAPHeaderElement
.getRole
in interface SOAPHeaderElement
String
giving the URI of the Role
public void setMustUnderstand(boolean mustUnderstand)
SOAPHeaderElement
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.
setMustUnderstand
in interface SOAPHeaderElement
mustUnderstand
- true
to set the mustUnderstand
attribute to true; false
to set it to falseSOAPHeaderElement.getMustUnderstand()
,
SOAPHeaderElement.setRelay(boolean)
public boolean getMustUnderstand()
SOAPHeaderElement
SOAPHeaderElement
.getMustUnderstand
in interface SOAPHeaderElement
true
if the mustUnderstand attribute of this
SOAPHeaderElement
object is turned on; false
otherwisepublic void setRelay(boolean relay) throws SOAPException
SOAPHeaderElement
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
.
setRelay
in interface SOAPHeaderElement
relay
- the new value of the relay attributeSOAPException
- if there is a problem in setting the
relay attribute.SOAPHeaderElement.setMustUnderstand(boolean)
,
SOAPHeaderElement.getRelay()
public boolean getRelay()
SOAPHeaderElement
SOAPHeaderElement
getRelay
in interface SOAPHeaderElement
true
if the relay attribute is turned on;
false
otherwiseSOAPHeaderElement.getMustUnderstand()
,
SOAPHeaderElement.setRelay(boolean)
Copyright © 2020 JBoss by Red Hat. All rights reserved.