javax.xml.soap.SOAPHeaderElement Maven / Gradle / Ivy
/*
* $Id: SOAPHeaderElement.java,v 1.10 2006/03/30 00:59:42 ofung Exp $
* $Revision: 1.10 $
* $Date: 2006/03/30 00:59:42 $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package javax.xml.soap;
/**
* An object representing the contents in the SOAP header part of the
* SOAP envelope.
* The immediate children of a SOAPHeader object can
* be represented only as SOAPHeaderElement objects.
*
* A SOAPHeaderElement object can have other
* SOAPElement objects as its children.
*/
public interface SOAPHeaderElement extends SOAPElement {
/**
* 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 {@link #setRole(String)}
*
* @param actorURI a String giving the URI of the actor
* to set
*
* @exception IllegalArgumentException if there is a problem in
* setting the actor.
*
* @see #getActor
*/
public void setActor(String actorURI);
/**
* Sets the Role associated with this SOAPHeaderElement
* object to the specified Role.
*
* @param uri - the URI of the Role
*
* @throws SOAPException if there is an error in setting the role
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
* @since SAAJ 1.3
*/
public void setRole(String uri) throws SOAPException;
/**
* Returns the uri of the actor attribute of this
* SOAPHeaderElement.
*
* If this SOAPHeaderElement supports SOAP 1.2 then this call is
* equivalent to {@link #getRole()}
* @return a String giving the URI of the actor
* @see #setActor
*/
public String getActor();
/**
* Returns the value of the Role attribute of this
* SOAPHeaderElement.
*
* @return a String giving the URI of the Role
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
* @since SAAJ 1.3
*/
public String getRole();
/**
* 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.
*
* @param mustUnderstand true to set the mustUnderstand
* attribute to true; false to set it to false
*
* @exception IllegalArgumentException if there is a problem in
* setting the mustUnderstand attribute
* @see #getMustUnderstand
* @see #setRelay
*/
public void setMustUnderstand(boolean mustUnderstand);
/**
* Returns the boolean value of the mustUnderstand attribute for this
* SOAPHeaderElement.
*
* @return true if the mustUnderstand attribute of this
* SOAPHeaderElement object is turned on; false
* otherwise
*/
public boolean getMustUnderstand();
/**
* 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.
*
* @param relay the new value of the relay attribute
*
* @exception SOAPException if there is a problem in setting the
* relay attribute.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Relay attribute.
*
* @see #setMustUnderstand
* @see #getRelay
*
* @since SAAJ 1.3
*/
public void setRelay(boolean relay) throws SOAPException;
/**
* Returns the boolean value of the relay attribute for this
* SOAPHeaderElement
*
* @return true if the relay attribute is turned on;
* false otherwise
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Relay attribute.
*
* @see #getMustUnderstand
* @see #setRelay
*
* @since SAAJ 1.3
*/
public boolean getRelay();
}