1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
/* * $Id: SOAPHeaderElement.java,v 1.5.2.11 2005/02/09 07:39:03 vj135062 Exp $ * $Revision: 1.5.2.11 $ * $Date: 2005/02/09 07:39:03 $ */ /* * Copyright 2005 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.soap; /** * An object representing the contents in the SOAP header part of the * SOAP envelope. * The immediate children of a <code>SOAPHeader</code> object can * be represented only as <code>SOAPHeaderElement</code> objects. * <P> * A <code>SOAPHeaderElement</code> object can have other * <code>SOAPElement</code> objects as its children. */ public interface SOAPHeaderElement extends SOAPElement { /** * Sets the actor associated with this <code>SOAPHeaderElement</code> * object to the specified actor. The default value of an actor is: * <code>SOAPConstants.URI_SOAP_ACTOR_NEXT</code> * <P> * If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is * equivalent to {@link #setRole(String)} * * @param actorURI a <code>String</code> 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 <code>Role</code> associated with this <code>SOAPHeaderElement</code> * object to the specified <code>Role</code>. * * @param uri - the URI of the <code>Role</code> * * @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 <i>actor</i> attribute of this * <code>SOAPHeaderElement</code>. *<P> * If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is * equivalent to {@link #getRole()} * @return a <code>String</code> giving the URI of the actor * @see #setActor */ public String getActor(); /** * Returns the value of the <i>Role</i> attribute of this * <code>SOAPHeaderElement</code>. * * @return a <code>String</code> giving the URI of the <code>Role</code> * * @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 <code>SOAPHeaderElement</code> * object to be either true or false. * <P> * If the mustUnderstand attribute is on, the actor who receives the * <code>SOAPHeaderElement</code> must process it correctly. This * ensures, for example, that if the <code>SOAPHeaderElement</code> * object modifies the message, that the message is being modified correctly. * * @param mustUnderstand <code>true</code> to set the mustUnderstand * attribute to true; <code>false</code> 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 * <code>SOAPHeaderElement</code>. * * @return <code>true</code> if the mustUnderstand attribute of this * <code>SOAPHeaderElement</code> object is turned on; <code>false</code> * otherwise */ public boolean getMustUnderstand(); /** * Sets the <i>relay</i> attribute for this <code>SOAPHeaderElement</code> to be * either true or false. * <P> * 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 <code>false</code>. * * @param relay the new value of the <i>relay</i> 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 <i>relay</i> attribute for this * <code>SOAPHeaderElement</code> * * @return <code>true</code> if the relay attribute is turned on; * <code>false</code> 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(); }