javax.xml.soap.SOAPBody Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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
*/
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 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 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 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 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 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 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 SAAJ 1.3
*/
public org.w3c.dom.Document extractContentAsDocument()
throws SOAPException;
}