SOAPHeader (Java EE 5 SDK)

javax.xml.soap Interface SOAPHeader

所有父接口:

Element, Node, SOAPElement

public interface SOAPHeader

extends SOAPElement

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();
 

      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

addHeaderElement

SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException

Creates a new 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

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs

另请参见:

addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException

Creates a new 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

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs

从以下版本开始:

SAAJ 1.3

另请参见:

addHeaderElement(Name)

examineMustUnderstandHeaderElements

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.

参数:

actor - a String giving the URI of the actor / role for which to search

返回:

an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role and are marked as MustUnderstand

从以下版本开始:

SAAJ 1.2

另请参见:

examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

examineHeaderElements

Iterator examineHeaderElements(String 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.

参数:

actor - a String giving the URI of the actor / role for which to search

返回:

an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role

另请参见:

extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

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.

参数:

actor - a String giving the URI of the actor / role for which to search

返回:

an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role

另请参见:

examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                                throws SOAPException

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.

参数:

name - a QName object with the name of the SOAPHeaderElement object that was not understood.

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs.

UnsupportedOperationException - if this is a SOAP 1.1 Header.

从以下版本开始:

SAAJ 1.3

addUpgradeHeaderElement

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

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs.

从以下版本开始:

SAAJ 1.3

addUpgradeHeaderElement

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. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.

参数:

supportedSoapUris - an array of the URIs of SOAP versions supported.

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs.

从以下版本开始:

SAAJ 1.3

addUpgradeHeaderElement

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. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.

参数:

supportedSoapUri - the URI of SOAP the version that is supported.

返回:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

抛出异常:

SOAPException - if a SOAP error occurs.

从以下版本开始:

SAAJ 1.3

examineAllHeaderElements

Iterator examineAllHeaderElements()

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

返回:

an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader

从以下版本开始:

SAAJ 1.2

另请参见:

extractAllHeaderElements()

extractAllHeaderElements

Iterator extractAllHeaderElements()

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

返回:

an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader

从以下版本开始:

SAAJ 1.2

另请参见:

examineAllHeaderElements()

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.