-
- All Superinterfaces:
- Element, Node, SOAPElement
public interface SOAPHeaderElement extends SOAPElement
An object representing the contents in the SOAP header part of the SOAP envelope. The immediate children of aSOAPHeader
object can be represented only asSOAPHeaderElement
objects.A
SOAPHeaderElement
object can have otherSOAPElement
objects as its children.
-
-
Field Summary
-
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
-
-
Method Summary
Methods Modifier and Type Method and Description String
getActor()
Returns the uri of the actor attribute of thisSOAPHeaderElement
.boolean
getMustUnderstand()
Returns the boolean value of the mustUnderstand attribute for thisSOAPHeaderElement
.boolean
getRelay()
Returns the boolean value of the relay attribute for thisSOAPHeaderElement
String
getRole()
Returns the value of the Role attribute of thisSOAPHeaderElement
.void
setActor(String actorURI)
Sets the actor associated with thisSOAPHeaderElement
object to the specified actor.void
setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for thisSOAPHeaderElement
object to be either true or false.void
setRelay(boolean relay)
Sets the relay attribute for thisSOAPHeaderElement
to be either true or false.void
setRole(String uri)
Sets theRole
associated with thisSOAPHeaderElement
object to the specifiedRole
.-
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, setParentElement, 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
-
-
-
-
Method Detail
-
setActor
void setActor(String actorURI)
Sets the actor associated with thisSOAPHeaderElement
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 tosetRole(String)
- Parameters:
actorURI
- aString
giving the URI of the actor to set- Throws:
IllegalArgumentException
- if there is a problem in setting the actor.- See Also:
getActor()
-
setRole
void setRole(String uri) throws SOAPException
Sets theRole
associated with thisSOAPHeaderElement
object to the specifiedRole
.- Parameters:
uri
- - the URI of theRole
- Throws:
SOAPException
- if there is an error in setting the roleUnsupportedOperationException
- if this message does not support the SOAP 1.2 concept of Fault Role.- Since:
- SAAJ 1.3
-
getActor
String getActor()
Returns the uri of the actor attribute of thisSOAPHeaderElement
.If this
SOAPHeaderElement
supports SOAP 1.2 then this call is equivalent togetRole()
- Returns:
- a
String
giving the URI of the actor - See Also:
setActor(java.lang.String)
-
getRole
String getRole()
Returns the value of the Role attribute of thisSOAPHeaderElement
.- Returns:
- a
String
giving the URI of theRole
- Throws:
UnsupportedOperationException
- if this message does not support the SOAP 1.2 concept of Fault Role.- Since:
- SAAJ 1.3
-
setMustUnderstand
void setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for thisSOAPHeaderElement
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 theSOAPHeaderElement
object modifies the message, that the message is being modified correctly.- Parameters:
mustUnderstand
-true
to set the mustUnderstand attribute to true;false
to set it to false- Throws:
IllegalArgumentException
- if there is a problem in setting the mustUnderstand attribute- See Also:
getMustUnderstand()
,setRelay(boolean)
-
getMustUnderstand
boolean getMustUnderstand()
Returns the boolean value of the mustUnderstand attribute for thisSOAPHeaderElement
.- Returns:
true
if the mustUnderstand attribute of thisSOAPHeaderElement
object is turned on;false
otherwise
-
setRelay
void setRelay(boolean relay) throws SOAPException
Sets the relay attribute for thisSOAPHeaderElement
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
.- Parameters:
relay
- the new value of the relay attribute- Throws:
SOAPException
- 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.- Since:
- SAAJ 1.3
- See Also:
setMustUnderstand(boolean)
,getRelay()
-
getRelay
boolean getRelay()
Returns the boolean value of the relay attribute for thisSOAPHeaderElement
- Returns:
true
if the relay attribute is turned on;false
otherwise- Throws:
UnsupportedOperationException
- if this message does not support the SOAP 1.2 concept of Relay attribute.- Since:
- SAAJ 1.3
- See Also:
getMustUnderstand()
,setRelay(boolean)
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/soap/soapheaderelement.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.