diff -r cb15fc6cc038 -r 9a2e5d103695 jaxws/src/java.xml.soap/share/classes/javax/xml/soap/SOAPBody.java --- a/jaxws/src/java.xml.soap/share/classes/javax/xml/soap/SOAPBody.java Thu Jan 15 11:18:14 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,298 +0,0 @@ -/* - * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. - * - * This code is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ - -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. - *

- * A SOAPBody object contains SOAPBodyElement - * objects, which have the content for the SOAP body. - * A SOAPFault object, which carries status and/or - * error information, is an example of a SOAPBodyElement object. - * - * @see SOAPFault - * @since 1.6 - */ -public interface SOAPBody extends SOAPElement { - - /** - * Creates a new SOAPFault object and adds it to - * this SOAPBody object. The new SOAPFault will - * have default values set for the mandatory child elements. The type of - * the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault - * depending on the protocol specified while creating the - * MessageFactory instance. - *

- * A SOAPBody may contain at most one SOAPFault - * child element. - * - * @return the new SOAPFault object - * @exception SOAPException if there is a SOAP error - */ - public SOAPFault addFault() throws SOAPException; - - - /** - * Creates a new SOAPFault object and adds it to - * this SOAPBody object. The type of the - * SOAPFault will be a SOAP 1.1 or a SOAP 1.2 - * SOAPFault depending on the protocol - * specified while creating the MessageFactory instance. - *

- * For SOAP 1.2 the faultCode parameter is the value of the - * Fault/Code/Value element and the faultString parameter - * is the value of the Fault/Reason/Text element. For SOAP 1.1 - * the faultCode parameter is the value of the faultcode - * element and the faultString parameter is the value of the faultstring - * element. - *

- * A SOAPBody may contain at most one SOAPFault - * child element. - * - * @param faultCode a Name 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 String giving an explanation of - * the fault - * @param locale a {@link java.util.Locale} object indicating - * the native language of the faultString - * @return the new SOAPFault object - * @exception SOAPException if there is a SOAP error - * @see SOAPFault#setFaultCode - * @see SOAPFault#setFaultString - * @since 1.6, SAAJ 1.2 - */ - public SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException; - - /** - * Creates a new SOAPFault object and adds it to this - * SOAPBody object. The type of the SOAPFault - * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on - * the protocol specified while creating the MessageFactory - * instance. - *

- * For SOAP 1.2 the faultCode parameter is the value of the - * Fault/Code/Value element and the faultString parameter - * is the value of the Fault/Reason/Text element. For SOAP 1.1 - * the faultCode parameter is the value of the faultcode - * element and the faultString parameter is the value of the faultstring - * element. - *

- * A SOAPBody may contain at most one SOAPFault - * child element. - * - * @param faultCode - * a QName 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 String giving an explanation of the fault - * @param locale - * a {@link java.util.Locale Locale} object indicating the - * native language of the faultString - * @return the new SOAPFault 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 1.6, SAAJ 1.3 - */ - public SOAPFault addFault(QName faultCode, String faultString, Locale locale) - throws SOAPException; - - /** - * Creates a new SOAPFault object and adds it to this - * SOAPBody object. The type of the SOAPFault - * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on - * the protocol specified while creating the MessageFactory - * instance. - *

- * For SOAP 1.2 the faultCode parameter is the value of the - * Fault/Code/Value element and the faultString parameter - * is the value of the Fault/Reason/Text element. For SOAP 1.1 - * the faultCode parameter is the value of the faultcode - * element and the faultString parameter is the value of the faultstring - * element. - *

- * In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang - * attribute on the Fault/Reason/Text element will be set to - * java.util.Locale.getDefault() - *

- * A SOAPBody may contain at most one SOAPFault - * child element. - * - * @param faultCode - * a Name 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 String giving an explanation of the fault - * @return the new SOAPFault object - * @exception SOAPException - * if there is a SOAP error - * @see SOAPFault#setFaultCode - * @see SOAPFault#setFaultString - * @since 1.6, SAAJ 1.2 - */ - public SOAPFault addFault(Name faultCode, String faultString) - throws SOAPException; - - /** - * Creates a new SOAPFault object and adds it to this SOAPBody - * object. The type of the SOAPFault - * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on - * the protocol specified while creating the MessageFactory - * instance. - *

- * For SOAP 1.2 the faultCode parameter is the value of the - * Fault/Code/Value element and the faultString parameter - * is the value of the Fault/Reason/Text element. For SOAP 1.1 - * the faultCode parameter is the value of the faultcode - * element and the faultString parameter is the value of the faultstring - * element. - *

- * In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang - * attribute on the Fault/Reason/Text element will be set to - * java.util.Locale.getDefault() - *

- * A SOAPBody may contain at most one SOAPFault - * child element - * - * @param faultCode - * a QName 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 String giving an explanation of the fault - * @return the new SOAPFault object - * @exception SOAPException - * if there is a SOAP error - * @see SOAPFault#setFaultCode - * @see SOAPFault#setFaultString - * @see SOAPBody#addFault(Name faultCode, String faultString) - * @since 1.6, SAAJ 1.3 - */ - public SOAPFault addFault(QName faultCode, String faultString) - throws SOAPException; - - /** - * Indicates whether a SOAPFault object exists in this - * SOAPBody object. - * - * @return true if a SOAPFault object exists - * in this SOAPBody object; false - * otherwise - */ - public boolean hasFault(); - - /** - * Returns the SOAPFault object in this SOAPBody - * object. - * - * @return the SOAPFault object in this SOAPBody - * object if present, null otherwise. - */ - public SOAPFault getFault(); - - /** - * Creates a new SOAPBodyElement object with the specified - * name and adds it to this SOAPBody object. - * - * @param name - * a Name object with the name for the new SOAPBodyElement - * object - * @return the new SOAPBodyElement 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 SOAPBodyElement object with the specified - * QName and adds it to this SOAPBody object. - * - * @param qname - * a QName object with the qname for the new - * SOAPBodyElement object - * @return the new SOAPBodyElement object - * @exception SOAPException - * if a SOAP error occurs - * @see SOAPBody#addBodyElement(Name) - * @since 1.6, SAAJ 1.3 - */ - public SOAPBodyElement addBodyElement(QName qname) throws SOAPException; - - /** - * Adds the root node of the DOM {@link org.w3c.dom.Document} - * to this SOAPBody object. - *

- * Calling this method invalidates the document parameter. - * The client application should discard all references to this Document - * and its contents upon calling addDocument. The behavior - * of an application that continues to use such references is undefined. - * - * @param document - * the Document object whose root node will be - * added to this SOAPBody. - * @return the SOAPBodyElement that represents the root node - * that was added. - * @exception SOAPException - * if the Document cannot be added - * @since 1.6, SAAJ 1.2 - */ - public SOAPBodyElement addDocument(org.w3c.dom.Document document) - throws SOAPException; - - /** - * Creates a new DOM {@link org.w3c.dom.Document} and sets - * the first child of this SOAPBody as it's document - * element. The child SOAPElement is removed as part of the - * process. - * - * @return the {@link org.w3c.dom.Document} representation - * of the SOAPBody content. - * - * @exception SOAPException - * if there is not exactly one child SOAPElement of the - * SOAPBody. - * - * @since 1.6, SAAJ 1.3 - */ - public org.w3c.dom.Document extractContentAsDocument() - throws SOAPException; -}