Java javax.xml.soap Interface SOAPHeaderElement（JDK8）

Method Detail

• setActor

  void setActor(String actorURI)

  Sets the actor associated with this 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 setRole(String)

  Parameters:

  actorURI - a String 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 the Role associated with this SOAPHeaderElement object to the specified Role.

  Parameters:

  uri - - the URI of the Role

  Throws:

  SOAPException - if there is an error in setting the role

  UnsupportedOperationException - 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 this SOAPHeaderElement.

  If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to getRole()

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

  Returns:

  a String giving the URI of the Role

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

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

  Returns:

  true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

• setRelay

  void setRelay(boolean relay)
         throws SOAPException

  Sets the relay attribute for this 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.

  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 this SOAPHeaderElement

  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)