|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface SOAPHeader
A representation of the SOAP header
element. A SOAP header element consists of XML data that affects
the way the application-specific content is processed by the message
provider. For example, transaction semantics, authentication information,
and so on, can be specified as the content of a SOAPHeader
object.
A SOAPEnvelope object contains an empty
SOAPHeader object by default. If the SOAPHeader
object, which is optional, is not needed, it can be retrieved and deleted
with the following line of code. The variable se is a
SOAPEnvelope object.
se.getHeader().detachNode();A
SOAPHeader object is created with the SOAPEnvelope
method addHeader. This method, which creates a new header and adds it
to the envelope, may be called only after the existing header has been removed.
se.getHeader().detachNode(); SOAPHeader sh = se.addHeader();
A SOAPHeader object can have only SOAPHeaderElement
objects as its immediate children. The method addHeaderElement
creates a new HeaderElement object and adds it to the
SOAPHeader object. In the following line of code, the
argument to the method addHeaderElement is a Name
object that is the name for the new HeaderElement object.
SOAPHeaderElement shElement = sh.addHeaderElement(name);
SOAPHeaderElement
| Field Summary |
|---|
| Method Summary | |
|---|---|
SOAPHeaderElement |
addHeaderElement(Name name)
Creates a new SOAPHeaderElement object initialized with the
specified name and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addHeaderElement(QName qname)
Creates a new SOAPHeaderElement object initialized with the
specified qname and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addNotUnderstoodHeaderElement(QName name)
Creates a new NotUnderstood SOAPHeaderElement object initialized
with the specified name and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(Iterator supportedSOAPURIs)
Creates a new Upgrade SOAPHeaderElement object initialized
with the specified List of supported SOAP URIs and adds it to this
SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(String supportedSoapUri)
Creates a new Upgrade SOAPHeaderElement object initialized
with the specified supported SOAP URI and adds it to this
SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(String[] supportedSoapUris)
Creates a new Upgrade SOAPHeaderElement object initialized
with the specified array of supported SOAP URIs and adds it to this
SOAPHeader object. |
Iterator |
examineAllHeaderElements()
Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object. |
Iterator |
examineHeaderElements(String actor)
Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor. |
Iterator |
examineMustUnderstandHeaderElements(String actor)
Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor and that have a MustUnderstand attribute
whose value is equivalent to true. |
Iterator |
extractAllHeaderElements()
Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object and detaches them
from this SOAPHeader object. |
Iterator |
extractHeaderElements(String actor)
Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor and detaches them
from this SOAPHeader object. |
| Methods inherited from interface javax.xml.soap.Node |
|---|
detachNode, getParentElement, getValue, recycleNode, setParentElement, 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 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 |
|---|
SOAPHeaderElement addHeaderElement(Name name) throws SOAPException
SOAPHeaderElement object initialized with the
specified name and adds it to this SOAPHeader object.
name - a Name object with the name of the new
SOAPHeaderElement object
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occursaddHeaderElement(javax.xml.namespace.QName)SOAPHeaderElement addHeaderElement(QName qname) throws SOAPException
SOAPHeaderElement object initialized with the
specified qname and adds it to this SOAPHeader object.
qname - a QName object with the qname of the new
SOAPHeaderElement object
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occursaddHeaderElement(Name)Iterator examineMustUnderstandHeaderElements(String actor)
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor and that have a MustUnderstand attribute
whose value is equivalent to true.
In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
actor - a String giving the URI of the actor / role
for which to search
Iterator object over all the
SOAPHeaderElement objects that contain the specified
actor / role and are marked as MustUnderstandexamineHeaderElements(java.lang.String),
extractHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTIterator examineHeaderElements(String actor)
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor.
An actor is a global attribute that indicates the intermediate
parties that should process a message before it reaches its ultimate
receiver. An actor receives the message and processes it before sending
it on to the next actor. The default actor is the ultimate intended
recipient for the message, so if no actor attribute is included in a
SOAPHeader object, it is sent to the ultimate receiver
along with the message body.
In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
actor - a String giving the URI of the actor / role
for which to search
Iterator object over all the
SOAPHeaderElement objects that contain the specified
actor / roleextractHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTIterator extractHeaderElements(String actor)
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor and detaches them
from this SOAPHeader object.
This method allows an actor to process the parts of the
SOAPHeader object that apply to it and to remove
them before passing the message on to the next actor.
In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
actor - a String giving the URI of the actor / role
for which to search
Iterator object over all the
SOAPHeaderElement objects that contain the specified
actor / roleexamineHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTSOAPHeaderElement addNotUnderstoodHeaderElement(QName name) throws SOAPException
SOAPHeaderElement object initialized
with the specified name and adds it to this SOAPHeader object.
This operation is supported only by SOAP 1.2.
name - a QName object with the name of the
SOAPHeaderElement object that was not understood.
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occurs.
UnsupportedOperationException - if this is a SOAP 1.1 Header.SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs) throws SOAPException
SOAPHeaderElement object initialized
with the specified List of supported SOAP URIs and adds it to this
SOAPHeader object.
This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
supportedSOAPURIs - an Iterator object with the URIs of SOAP
versions supported.
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occurs.SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris) throws SOAPException
SOAPHeaderElement object initialized
with the specified array of supported SOAP URIs and adds it to this
SOAPHeader object.
This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
supportedSoapUris - an array of the URIs of SOAP versions supported.
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occurs.SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri) throws SOAPException
SOAPHeaderElement object initialized
with the specified supported SOAP URI and adds it to this
SOAPHeader object.
This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
supportedSoapUri - the URI of SOAP the version that is supported.
SOAPHeaderElement object that was
inserted into this SOAPHeader object
SOAPException - if a SOAP error occurs.Iterator examineAllHeaderElements()
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object.
Iterator object over all the
SOAPHeaderElement objects contained by this
SOAPHeaderextractAllHeaderElements()Iterator extractAllHeaderElements()
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object and detaches them
from this SOAPHeader object.
Iterator object over all the
SOAPHeaderElement objects contained by this
SOAPHeaderexamineAllHeaderElements()
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
Scripting on this page tracks web page traffic, but does not change the content in any way.