Java Web Services in a Nutshell

Name

SOAPHeaderElement

Synopsis

public interface SOAPHeaderElement extends SOAPElement {
// Public Instance Methods
    public abstract String getActor(  ); 
    public abstract boolean getMustUnderstand(  ); 
    public abstract void setActor( String actorURI); 
    public abstract void setMustUnderstand(boolean mustUnderstand);
}

SOAPHeaderElement is a subinterface of SOAPElement that represents the root element of a SOAP header. A SOAPHeaderElement can be created using the addHeaderElement( ) or addChildElement( ) methods of SOAPHeader, or by adding a SOAPElement directly to a SOAPHeader.

The setActor( ) method can be used to set the URI of the intermediate system that is expected to process the header; the special value SOAPConstants.URI_SOAP_ACTOR_NEXT should be used to indicate that the header is intended for the next recipient of the message. The setMustUnderstand( ) method sets the header attribute that determines whether the actor to which the header is addressed must be able to understand and process it; the method returns a reply containing a SOAPFault if the actor does not understand the attribute.

Returned By

SOAPHeader.addHeaderElement( )