325N/A/*
325N/A * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.xml.soap;
325N/A
325N/A/**
325N/A * An object representing the contents in the SOAP header part of the
325N/A * SOAP envelope.
325N/A * The immediate children of a <code>SOAPHeader</code> object can
325N/A * be represented only as <code>SOAPHeaderElement</code> objects.
325N/A * <P>
325N/A * A <code>SOAPHeaderElement</code> object can have other
325N/A * <code>SOAPElement</code> objects as its children.
325N/A */
325N/Apublic interface SOAPHeaderElement extends SOAPElement {
325N/A
325N/A /**
325N/A * Sets the actor associated with this <code>SOAPHeaderElement</code>
325N/A * object to the specified actor. The default value of an actor is:
325N/A * <code>SOAPConstants.URI_SOAP_ACTOR_NEXT</code>
325N/A * <P>
325N/A * If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is
325N/A * equivalent to {@link #setRole(String)}
325N/A *
325N/A * @param actorURI a <code>String</code> giving the URI of the actor
325N/A * to set
325N/A *
325N/A * @exception IllegalArgumentException if there is a problem in
325N/A * setting the actor.
325N/A *
325N/A * @see #getActor
325N/A */
325N/A public void setActor(String actorURI);
325N/A
325N/A /**
325N/A * Sets the <code>Role</code> associated with this <code>SOAPHeaderElement</code>
325N/A * object to the specified <code>Role</code>.
325N/A *
325N/A * @param uri - the URI of the <code>Role</code>
325N/A *
325N/A * @throws SOAPException if there is an error in setting the role
325N/A *
325N/A * @exception UnsupportedOperationException if this message does not
325N/A * support the SOAP 1.2 concept of Fault Role.
325N/A *
325N/A * @since SAAJ 1.3
325N/A */
325N/A public void setRole(String uri) throws SOAPException;
325N/A
325N/A /**
325N/A * Returns the uri of the <i>actor</i> attribute of this
325N/A * <code>SOAPHeaderElement</code>.
325N/A *<P>
325N/A * If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is
325N/A * equivalent to {@link #getRole()}
325N/A * @return a <code>String</code> giving the URI of the actor
325N/A * @see #setActor
325N/A */
325N/A public String getActor();
325N/A
325N/A /**
325N/A * Returns the value of the <i>Role</i> attribute of this
325N/A * <code>SOAPHeaderElement</code>.
325N/A *
325N/A * @return a <code>String</code> giving the URI of the <code>Role</code>
325N/A *
325N/A * @exception UnsupportedOperationException if this message does not
325N/A * support the SOAP 1.2 concept of Fault Role.
325N/A *
325N/A * @since SAAJ 1.3
325N/A */
325N/A public String getRole();
325N/A
325N/A /**
325N/A * Sets the mustUnderstand attribute for this <code>SOAPHeaderElement</code>
325N/A * object to be either true or false.
325N/A * <P>
325N/A * If the mustUnderstand attribute is on, the actor who receives the
325N/A * <code>SOAPHeaderElement</code> must process it correctly. This
325N/A * ensures, for example, that if the <code>SOAPHeaderElement</code>
325N/A * object modifies the message, that the message is being modified correctly.
325N/A *
325N/A * @param mustUnderstand <code>true</code> to set the mustUnderstand
325N/A * attribute to true; <code>false</code> to set it to false
325N/A *
325N/A * @exception IllegalArgumentException if there is a problem in
325N/A * setting the mustUnderstand attribute
325N/A * @see #getMustUnderstand
325N/A * @see #setRelay
325N/A */
325N/A public void setMustUnderstand(boolean mustUnderstand);
325N/A
325N/A /**
325N/A * Returns the boolean value of the mustUnderstand attribute for this
325N/A * <code>SOAPHeaderElement</code>.
325N/A *
325N/A * @return <code>true</code> if the mustUnderstand attribute of this
325N/A * <code>SOAPHeaderElement</code> object is turned on; <code>false</code>
325N/A * otherwise
325N/A */
325N/A public boolean getMustUnderstand();
325N/A
325N/A /**
325N/A * Sets the <i>relay</i> attribute for this <code>SOAPHeaderElement</code> to be
325N/A * either true or false.
325N/A * <P>
325N/A * The SOAP relay attribute is set to true to indicate that the SOAP header
325N/A * block must be relayed by any node that is targeted by the header block
325N/A * but not actually process it. This attribute is ignored on header blocks
325N/A * whose mustUnderstand attribute is set to true or that are targeted at
325N/A * the ultimate reciever (which is the default). The default value of this
325N/A * attribute is <code>false</code>.
325N/A *
325N/A * @param relay the new value of the <i>relay</i> attribute
325N/A *
325N/A * @exception SOAPException if there is a problem in setting the
325N/A * relay attribute.
325N/A * @exception UnsupportedOperationException if this message does not
325N/A * support the SOAP 1.2 concept of Relay attribute.
325N/A *
325N/A * @see #setMustUnderstand
325N/A * @see #getRelay
325N/A *
325N/A * @since SAAJ 1.3
325N/A */
325N/A public void setRelay(boolean relay) throws SOAPException;
325N/A
325N/A /**
325N/A * Returns the boolean value of the <i>relay</i> attribute for this
325N/A * <code>SOAPHeaderElement</code>
325N/A *
325N/A * @return <code>true</code> if the relay attribute is turned on;
325N/A * <code>false</code> otherwise
325N/A *
325N/A * @exception UnsupportedOperationException if this message does not
325N/A * support the SOAP 1.2 concept of Relay attribute.
325N/A *
325N/A * @see #getMustUnderstand
325N/A * @see #setRelay
325N/A *
325N/A * @since SAAJ 1.3
325N/A */
325N/A public boolean getRelay();
325N/A}