org.apache.xmlbeans.impl.soap.SOAPFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-xmlbeans Show documentation
The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.
The newest version!
/*   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.xmlbeans.impl.soap;

/**
 * SOAPFactory is a factory for creating various objects
 * that exist in the SOAP XML tree.
 *
 * SOAPFactory can be
 * used to create XML fragments that will eventually end up in the
 * SOAP part. These fragments can be inserted as children of the
 * SOAPHeaderElement or SOAPBodyElement or
 * SOAPEnvelope.
 *
 * SOAPFactory also has methods to create
 * javax.xml.soap.Detail objects as well as
 * java.xml.soap.Name objects.
 *
 */
public abstract class SOAPFactory {

    public SOAPFactory() {}

    /**
     * Create a SOAPElement object initialized with the
     * given Name object.
     *
     * @param name a Name object with the XML name for
     *        the new element
     * @return  the new SOAPElement object that was
     *    created
     * @throws SOAPException if there is an error in creating the
     *       SOAPElement object
     */
    public abstract SOAPElement createElement(Name name) throws SOAPException;

    /**
     * Create a SOAPElement object initialized with the
     * given local name.
     *
     * @param localName a String giving the local name for
     *       the new element
     * @return the new SOAPElement object that was
     *    created
     * @throws SOAPException if there is an error in creating the
     *       SOAPElement object
     */
    public abstract SOAPElement createElement(String localName) throws SOAPException;

    /**
     * Create a new SOAPElement object with the given
     * local name, prefix and uri.
     *
     * @param localName a String giving the local name
     *            for the new element
     * @param prefix the prefix for this SOAPElement
     * @param uri a String giving the URI of the
     *      namespace to which the new element belongs
     * @return the new SOAPElement object that was
     *    created
     * @throws SOAPException if there is an error in creating the
     *      SOAPElement object
     */
    public abstract SOAPElement createElement(String localName, String prefix, String uri)
        throws SOAPException;

    /**
     * Creates a new Detail object which serves as a container
     * for DetailEntry objects.
     * 
     * This factory method creates Detail objects for use in
     * situations where it is not practical to use the SOAPFault
     * abstraction.
     *
     * @return a Detail object
     * @throws SOAPException if there is a SOAP error
     */
    public abstract Detail createDetail() throws SOAPException;

    /**
     * Creates a new Name object initialized with the
     * given local name, namespace prefix, and namespace URI.
     * 

     * This factory method creates Name objects for use in
     * situations where it is not practical to use the SOAPEnvelope
     * abstraction.
     *
     * @param localName a String giving the local name
     * @param prefix a String giving the prefix of the namespace
     * @param uri a String giving the URI of the namespace
     * @return a Name object initialized with the given
     *   local name, namespace prefix, and namespace URI
     * @throws SOAPException if there is a SOAP error
     */
    public abstract Name createName(String localName, String prefix, String uri)
        throws SOAPException;

    /**
     * Creates a new Name object initialized with the
     * given local name.
     * 
     * This factory method creates Name objects for use in
     * situations where it is not practical to use the SOAPEnvelope
     * abstraction.
     *
     * @param localName a String giving the local name
     * @return a Name object initialized with the given
     *    local name
     * @throws SOAPException if there is a SOAP error
     */
    public abstract Name createName(String localName) throws SOAPException;

    /**
     * Creates a new instance of SOAPFactory.
     *
     * @return a new instance of a SOAPFactory
     * @throws SOAPException if there was an error creating the
     *       default SOAPFactory
     */
    public static SOAPFactory newInstance() throws SOAPException {

        try {
            return (SOAPFactory) FactoryFinder.find(SF_PROPERTY, DEFAULT_SF);
        } catch (Exception exception) {
            throw new SOAPException("Unable to create SOAP Factory: "
                                    + exception.getMessage());
        }
    }

    private static final String SF_PROPERTY = "javax.xml.soap.SOAPFactory";

    private static final String DEFAULT_SF =
        "org.apache.axis.soap.SOAPFactoryImpl";
}