SOAPHeader JDK 1.6)

Methods

public SOAPHeaderElement addHeaderElement (Name name) throws SOAPException

Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.

Creates a new SOAPHeaderElement object initialized with the
specified name and adds it to this SOAPHeader object.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- name - a Name object with the name of the new SOAPHeaderElement object
Throws:
- SOAPException - if a SOAP error occurs
See Also: SOAPHeader.addHeaderElement(javax.xml.namespace.QName),

public SOAPHeaderElement addHeaderElement (QName qname) throws SOAPException

Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object.

Creates a new SOAPHeaderElement object initialized with the
specified qname and adds it to this SOAPHeader object.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- qname - a QName object with the qname of the new SOAPHeaderElement object
Throws:
- SOAPException - if a SOAP error occurs
Since: SAAJ 1.3
See Also: SOAPHeader.addHeaderElement(Name),

public SOAPHeaderElement addNotUnderstoodHeaderElement (QName name) throws SOAPException

Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.

Creates a new NotUnderstood SOAPHeaderElement object initialized
with the specified name and adds it to this SOAPHeader object.
This operation is supported only by SOAP 1.2.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- name - a QName object with the name of the SOAPHeaderElement object that was not understood.
Throws:
- SOAPException - if a SOAP error occurs.
- UnsupportedOperationException - if this is a SOAP 1.1 Header.
Since: SAAJ 1.3

public SOAPHeaderElement addUpgradeHeaderElement (Iterator supportedSOAPURIs) throws SOAPException

Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object.

Creates a new Upgrade 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.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- supportedSOAPURIs - an Iterator object with the URIs of SOAP versions supported.
Throws:
- SOAPException - if a SOAP error occurs.
Since: SAAJ 1.3

public SOAPHeaderElement addUpgradeHeaderElement (String supportedSoapUri) throws SOAPException

Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object.

Creates a new Upgrade 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.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- supportedSoapUri - the URI of SOAP the version that is supported.
Throws:
- SOAPException - if a SOAP error occurs.
Since: SAAJ 1.3

public SOAPHeaderElement addUpgradeHeaderElement (String supportedSoapUris) throws SOAPException

Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object.

Creates a new Upgrade 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.
Returns: the new SOAPHeaderElement object that was inserted into this SOAPHeader object
Parameters:
- supportedSoapUris - an array of the URIs of SOAP versions supported.
Throws:
- SOAPException - if a SOAP error occurs.
Since: SAAJ 1.3

public Iterator examineAllHeaderElements ()

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.

Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object.
Returns: an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader
Since: SAAJ 1.2
See Also: SOAPHeader.extractAllHeaderElements(),

public Iterator examineHeaderElements (String actor)

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor.

Returns an 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.
Returns: an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role
Parameters:
- actor - a String giving the URI of the actor / role for which to search
See Also: SOAPHeader.extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT,

public 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.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
Returns: an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role and are marked as MustUnderstand
Parameters:
- actor - a String giving the URI of the actor / role for which to search
Since: SAAJ 1.2
See Also: SOAPHeader.examineHeaderElements(java.lang.String), SOAPHeader.extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT,

public Iterator extractAllHeaderElements ()

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.

Returns an Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object and detaches them
from this SOAPHeader object.
Returns: an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader
Since: SAAJ 1.2
See Also: SOAPHeader.examineAllHeaderElements(),

public 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.

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.
Returns: an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role
Parameters:
- actor - a String giving the URI of the actor / role for which to search
See Also: SOAPHeader.examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT,

Fields

Hide/Show inherited fields

publicfinalstatic short ATTRIBUTE_NODE = "2" [Inherited From SOAPElement]

The node is an Attr.

publicfinalstatic short ATTRIBUTE_NODE = "2" [Inherited From SOAPElement]

The node is an Attr.

publicfinalstatic short CDATA_SECTION_NODE = "4" [Inherited From SOAPElement]

The node is a CDATASection.

publicfinalstatic short CDATA_SECTION_NODE = "4" [Inherited From SOAPElement]

The node is a CDATASection.

publicfinalstatic short COMMENT_NODE = "8" [Inherited From SOAPElement]

The node is a Comment.

publicfinalstatic short COMMENT_NODE = "8" [Inherited From SOAPElement]

The node is a Comment.

publicfinalstatic short DOCUMENT_FRAGMENT_NODE = "11" [Inherited From SOAPElement]

The node is a DocumentFragment.

publicfinalstatic short DOCUMENT_FRAGMENT_NODE = "11" [Inherited From SOAPElement]

The node is a DocumentFragment.

publicfinalstatic short DOCUMENT_NODE = "9" [Inherited From SOAPElement]

The node is a Document.

publicfinalstatic short DOCUMENT_NODE = "9" [Inherited From SOAPElement]

The node is a Document.

publicfinalstatic short DOCUMENT_POSITION_CONTAINED_BY = "16" [Inherited From SOAPElement]

The node is contained by the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINED_BY = "16" [Inherited From SOAPElement]

The node is contained by the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINS = "8" [Inherited From SOAPElement]

The node contains the reference node.

publicfinalstatic short DOCUMENT_POSITION_CONTAINS = "8" [Inherited From SOAPElement]

The node contains the reference node.

publicfinalstatic short DOCUMENT_POSITION_DISCONNECTED = "1" [Inherited From SOAPElement]

The two nodes are disconnected.

publicfinalstatic short DOCUMENT_POSITION_DISCONNECTED = "1" [Inherited From SOAPElement]

The two nodes are disconnected.

publicfinalstatic short DOCUMENT_POSITION_FOLLOWING = "4" [Inherited From SOAPElement]

The node follows the reference node.

publicfinalstatic short DOCUMENT_POSITION_FOLLOWING = "4" [Inherited From SOAPElement]

The node follows the reference node.

publicfinalstatic short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = "32" [Inherited From SOAPElement]

The determination of preceding versus following is implementation-specific.

publicfinalstatic short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = "32" [Inherited From SOAPElement]

The determination of preceding versus following is implementation-specific.

publicfinalstatic short DOCUMENT_POSITION_PRECEDING = "2" [Inherited From SOAPElement]

The second node precedes the reference node.

publicfinalstatic short DOCUMENT_POSITION_PRECEDING = "2" [Inherited From SOAPElement]

The second node precedes the reference node.

publicfinalstatic short DOCUMENT_TYPE_NODE = "10" [Inherited From SOAPElement]

The node is a DocumentType.

publicfinalstatic short DOCUMENT_TYPE_NODE = "10" [Inherited From SOAPElement]

The node is a DocumentType.

publicfinalstatic short ELEMENT_NODE = "1" [Inherited From SOAPElement]

The node is an Element.

publicfinalstatic short ELEMENT_NODE = "1" [Inherited From SOAPElement]

The node is an Element.

publicfinalstatic short ENTITY_NODE = "6" [Inherited From SOAPElement]

The node is an Entity.

publicfinalstatic short ENTITY_NODE = "6" [Inherited From SOAPElement]

The node is an Entity.

publicfinalstatic short ENTITY_REFERENCE_NODE = "5" [Inherited From SOAPElement]

The node is an EntityReference.

publicfinalstatic short ENTITY_REFERENCE_NODE = "5" [Inherited From SOAPElement]

The node is an EntityReference.

publicfinalstatic short NOTATION_NODE = "12" [Inherited From SOAPElement]

The node is a Notation.

publicfinalstatic short NOTATION_NODE = "12" [Inherited From SOAPElement]

The node is a Notation.

publicfinalstatic short PROCESSING_INSTRUCTION_NODE = "7" [Inherited From SOAPElement]

The node is a ProcessingInstruction.

publicfinalstatic short PROCESSING_INSTRUCTION_NODE = "7" [Inherited From SOAPElement]

The node is a ProcessingInstruction.

publicfinalstatic short TEXT_NODE = "3" [Inherited From SOAPElement]

The node is a Text node.

publicfinalstatic short TEXT_NODE = "3" [Inherited From SOAPElement]

The node is a Text node.