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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/* * $Id: SOAPBody.java,v 1.16 2005/04/05 22:28:13 mk125090 Exp $ * $Revision: 1.16 $ * $Date: 2005/04/05 22:28:13 $ */ /* * Copyright 2005 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.soap; import java.util.Locale; import org.w3c.dom.Document; import javax.xml.namespace.QName; /** * An object that represents the contents of the SOAP body * element in a SOAP message. A SOAP body element consists of XML data * that affects the way the application-specific content is processed. * <P> * A <code>SOAPBody</code> object contains <code>SOAPBodyElement</code> * objects, which have the content for the SOAP body. * A <code>SOAPFault</code> object, which carries status and/or * error information, is an example of a <code>SOAPBodyElement</code> object. * * @see SOAPFault */ public interface SOAPBody extends SOAPElement { /** * Creates a new <code>SOAPFault</code> object and adds it to * this <code>SOAPBody</code> object. The new <code>SOAPFault</code> will * have default values set for the mandatory child elements. The type of * the <code>SOAPFault</code> will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> * depending on the <code>protocol</code> specified while creating the * <code>MessageFactory</code> instance. * <p> * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code> * child element. * * @return the new <code>SOAPFault</code> object * @exception SOAPException if there is a SOAP error */ public SOAPFault addFault() throws SOAPException; /** * Creates a new <code>SOAPFault</code> object and adds it to * this <code>SOAPBody</code> object. The type of the * <code>SOAPFault</code> will be a SOAP 1.1 or a SOAP 1.2 * <code>SOAPFault</code> depending on the <code>protocol</code> * specified while creating the <code>MessageFactory</code> instance. * <p> * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the * <i>Fault/Code/Value</i> element and the <code>faultString</code> parameter * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1 * the <code>faultCode</code> parameter is the value of the <code>faultcode</code> * element and the <code>faultString</code> parameter is the value of the <code>faultstring</code> * element. * <p> * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code> * child element. * * @param faultCode a <code>Name</code> object giving the fault * code to be set; must be one of the fault codes defined in the Version * of SOAP specification in use * @param faultString a <code>String</code> giving an explanation of * the fault * @param locale a {@link java.util.Locale} object indicating * the native language of the <code>faultString</code> * @return the new <code>SOAPFault</code> object * @exception SOAPException if there is a SOAP error * @see SOAPFault#setFaultCode * @see SOAPFault#setFaultString * @since SAAJ 1.2 */ public SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException; /** * Creates a new <code>SOAPFault</code> object and adds it to this * <code>SOAPBody</code> object. The type of the <code>SOAPFault</code> * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on * the <code>protocol</code> specified while creating the <code>MessageFactory</code> * instance. * <p> * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the * <i>Fault/Code/Value</i> element and the <code>faultString</code> parameter * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1 * the <code>faultCode</code> parameter is the value of the <code>faultcode</code> * element and the <code>faultString</code> parameter is the value of the <code>faultstring</code> * element. * <p> * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code> * child element. * * @param faultCode * a <code>QName</code> object giving the fault code to be * set; must be one of the fault codes defined in the version * of SOAP specification in use. * @param faultString * a <code>String</code> giving an explanation of the fault * @param locale * a {@link java.util.Locale Locale} object indicating the * native language of the <code>faultString</code> * @return the new <code>SOAPFault</code> object * @exception SOAPException * if there is a SOAP error * @see SOAPFault#setFaultCode * @see SOAPFault#setFaultString * @see SOAPBody#addFault(Name faultCode, String faultString, Locale locale) * * @since SAAJ 1.3 */ public SOAPFault addFault(QName faultCode, String faultString, Locale locale) throws SOAPException; /** * Creates a new <code>SOAPFault</code> object and adds it to this * <code>SOAPBody</code> object. The type of the <code>SOAPFault</code> * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on * the <code>protocol</code> specified while creating the <code>MessageFactory</code> * instance. * <p> * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the * <i>Fault/Code/Value</i> element and the <code>faultString</code> parameter * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1 * the <code>faultCode</code> parameter is the value of the <i>faultcode</i> * element and the <code>faultString</code> parameter is the value of the <i>faultstring</i> * element. * <p> * In case of a SOAP 1.2 fault, the default value for the mandatory <code>xml:lang</code> * attribute on the <i>Fault/Reason/Text</i> element will be set to * <code>java.util.Locale.getDefault()</code> * <p> * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code> * child element. * * @param faultCode * a <code>Name</code> object giving the fault code to be set; * must be one of the fault codes defined in the version of SOAP * specification in use * @param faultString * a <code>String</code> giving an explanation of the fault * @return the new <code>SOAPFault</code> object * @exception SOAPException * if there is a SOAP error * @see SOAPFault#setFaultCode * @see SOAPFault#setFaultString * @since SAAJ 1.2 */ public SOAPFault addFault(Name faultCode, String faultString) throws SOAPException; /** * Creates a new <code>SOAPFault</code> object and adds it to this <code>SOAPBody</code> * object. The type of the <code>SOAPFault</code> * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on * the <code>protocol</code> specified while creating the <code>MessageFactory</code> * instance. * <p> * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the * <i>Fault/Code/Value</i> element and the <code>faultString</code> parameter * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1 * the <code>faultCode</code> parameter is the value of the <i>faultcode</i> * element and the <code>faultString</code> parameter is the value of the <i>faultstring</i> * element. * <p> * In case of a SOAP 1.2 fault, the default value for the mandatory <code>xml:lang</code> * attribute on the <i>Fault/Reason/Text</i> element will be set to * <code>java.util.Locale.getDefault()</code> * <p> * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code> * child element * * @param faultCode * a <code>QName</code> object giving the fault code to be * set; must be one of the fault codes defined in the version * of SOAP specification in use * @param faultString * a <code>String</code> giving an explanation of the fault * @return the new <code>SOAPFault</code> object * @exception SOAPException * if there is a SOAP error * @see SOAPFault#setFaultCode * @see SOAPFault#setFaultString * @see SOAPBody#addFault(Name faultCode, String faultString) * @since SAAJ 1.3 */ public SOAPFault addFault(QName faultCode, String faultString) throws SOAPException; /** * Indicates whether a <code>SOAPFault</code> object exists in this * <code>SOAPBody</code> object. * * @return <code>true</code> if a <code>SOAPFault</code> object exists * in this <code>SOAPBody</code> object; <code>false</code> * otherwise */ public boolean hasFault(); /** * Returns the <code>SOAPFault</code> object in this <code>SOAPBody</code> * object. * * @return the <code>SOAPFault</code> object in this <code>SOAPBody</code> * object if present, null otherwise. */ public SOAPFault getFault(); /** * Creates a new <code>SOAPBodyElement</code> object with the specified * name and adds it to this <code>SOAPBody</code> object. * * @param name * a <code>Name</code> object with the name for the new <code>SOAPBodyElement</code> * object * @return the new <code>SOAPBodyElement</code> object * @exception SOAPException * if a SOAP error occurs * @see SOAPBody#addBodyElement(javax.xml.namespace.QName) */ public SOAPBodyElement addBodyElement(Name name) throws SOAPException; /** * Creates a new <code>SOAPBodyElement</code> object with the specified * QName and adds it to this <code>SOAPBody</code> object. * * @param qname * a <code>QName</code> object with the qname for the new * <code>SOAPBodyElement</code> object * @return the new <code>SOAPBodyElement</code> object * @exception SOAPException * if a SOAP error occurs * @see SOAPBody#addBodyElement(Name) * @since SAAJ 1.3 */ public SOAPBodyElement addBodyElement(QName qname) throws SOAPException; /** * Adds the root node of the DOM <code>{@link org.w3c.dom.Document}</code> * to this <code>SOAPBody</code> object. * <p> * Calling this method invalidates the <code>document</code> parameter. * The client application should discard all references to this <code>Document</code> * and its contents upon calling <code>addDocument</code>. The behavior * of an application that continues to use such references is undefined. * * @param document * the <code>Document</code> object whose root node will be * added to this <code>SOAPBody</code>. * @return the <code>SOAPBodyElement</code> that represents the root node * that was added. * @exception SOAPException * if the <code>Document</code> cannot be added * @since SAAJ 1.2 */ public SOAPBodyElement addDocument(org.w3c.dom.Document document) throws SOAPException; /** * Creates a new DOM <code>{@link org.w3c.dom.Document}</code> and sets * the first child of this <code>SOAPBody</code> as it's document * element. The child <code>SOAPElement</code> is removed as part of the * process. * * @return the <code>{@link org.w3c.dom.Document}</code> representation * of the <code>SOAPBody</code> content. * * @exception SOAPException * if there is not exactly one child <code>SOAPElement</code> of the * <code>SOAPBody</code>. * * @since SAAJ 1.3 */ public org.w3c.dom.Document extractContentAsDocument() throws SOAPException; }