/*
* Copyright (c) 2005, 2006, 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.
*/
/*
* $Id: SOAPFactory.java,v 1.14 2006/03/30 00:59:41 ofung Exp $
* $Revision: 1.14 $
* $Datae$
*/
package javax.xml.soap;
import javax.xml.namespace.QName;
import org.w3c.dom.Element;
/**
* <code>SOAPFactory</code> is a factory for creating various objects
* that exist in the SOAP XML tree.
* <code>SOAPFactory</code> 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
* {@link SOAPHeaderElement} or {@link SOAPBodyElement} or
* {@link SOAPEnvelope} or other {@link SOAPElement} objects.
*
* <code>SOAPFactory</code> also has methods to create
* <code>javax.xml.soap.Detail</code> objects as well as
* <code>java.xml.soap.Name</code> objects.
*
*/
public abstract class SOAPFactory {
/**
* A constant representing the property used to lookup the name of
* a <code>SOAPFactory</code> implementation class.
*/
static private final String SOAP_FACTORY_PROPERTY =
"javax.xml.soap.SOAPFactory";
/**
* Creates a <code>SOAPElement</code> object from an existing DOM
* <code>Element</code>. If the DOM <code>Element</code> that is passed in
* as an argument is already a <code>SOAPElement</code> then this method
* must return it unmodified without any further work. Otherwise, a new
* <code>SOAPElement</code> is created and a deep copy is made of the
* <code>domElement</code> argument. The concrete type of the return value
* will depend on the name of the <code>domElement</code> argument. If any
* part of the tree rooted in <code>domElement</code> violates SOAP rules, a
* <code>SOAPException</code> will be thrown.
*
* @param domElement - the <code>Element</code> to be copied.
*
* @return a new <code>SOAPElement</code> that is a copy of <code>domElement</code>.
*
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
*
* @since SAAJ 1.3
*/
public SOAPElement createElement(Element domElement) throws SOAPException {
throw new UnsupportedOperationException("createElement(org.w3c.dom.Element) must be overridden by all subclasses of SOAPFactory.");
}
/**
* Creates a <code>SOAPElement</code> object initialized with the
* given <code>Name</code> object. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For
* instance, a new <code>SOAPElement</code> with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created.
*
* @param name a <code>Name</code> object with the XML name for
* the new element
*
* @return the new <code>SOAPElement</code> object that was
* created
*
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
* @see SOAPFactory#createElement(javax.xml.namespace.QName)
*/
public abstract SOAPElement createElement(Name name) throws SOAPException;
/**
* Creates a <code>SOAPElement</code> object initialized with the
* given <code>QName</code> object. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For
* instance, a new <code>SOAPElement</code> with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created.
*
* @param qname a <code>QName</code> object with the XML name for
* the new element
*
* @return the new <code>SOAPElement</code> object that was
* created
*
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
* @see SOAPFactory#createElement(Name)
* @since SAAJ 1.3
*/
public SOAPElement createElement(QName qname) throws SOAPException {
throw new UnsupportedOperationException("createElement(QName) must be overridden by all subclasses of SOAPFactory.");
}
/**
* Creates a <code>SOAPElement</code> object initialized with the
* given local name.
*
* @param localName a <code>String</code> giving the local name for
* the new element
*
* @return the new <code>SOAPElement</code> object that was
* created
*
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(String localName)
throws SOAPException;
/**
* Creates a new <code>SOAPElement</code> object with the given
* local name, prefix and uri. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For
* instance, a new <code>SOAPElement</code> with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created.
*
* @param localName a <code>String</code> giving the local name
* for the new element
* @param prefix the prefix for this <code>SOAPElement</code>
* @param uri a <code>String</code> giving the URI of the
* namespace to which the new element belongs
*
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(
String localName,
String prefix,
String uri)
throws SOAPException;
/**
* Creates a new <code>Detail</code> object which serves as a container
* for <code>DetailEntry</code> objects.
* <P>
* This factory method creates <code>Detail</code> objects for use in
* situations where it is not practical to use the <code>SOAPFault</code>
* abstraction.
*
* @return a <code>Detail</code> object
* @throws SOAPException if there is a SOAP error
* @throws UnsupportedOperationException if the protocol specified
* for the SOAPFactory was <code>DYNAMIC_SOAP_PROTOCOL</code>
*/
public abstract Detail createDetail() throws SOAPException;
/**
*Creates a new <code>SOAPFault</code> object initialized with the given <code>reasonText</code>
* and <code>faultCode</code>
*@param reasonText the ReasonText/FaultString for the fault
*@param faultCode the FaultCode for the fault
*@return a <code>SOAPFault</code> object
*@throws SOAPException if there is a SOAP error
*@since SAAJ 1.3
*/
public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException;
/**
*Creates a new default <code>SOAPFault</code> object
*@return a <code>SOAPFault</code> object
*@throws SOAPException if there is a SOAP error
*@since SAAJ 1.3
*/
public abstract SOAPFault createFault() throws SOAPException;
/**
* Creates a new <code>Name</code> object initialized with the
* given local name, namespace prefix, and namespace URI.
* <P>
* This factory method creates <code>Name</code> objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code>
* abstraction.
*
* @param localName a <code>String</code> giving the local name
* @param prefix a <code>String</code> giving the prefix of the namespace
* @param uri a <code>String</code> giving the URI of the namespace
* @return a <code>Name</code> 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 <code>Name</code> object initialized with the
* given local name.
* <P>
* This factory method creates <code>Name</code> objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code>
* abstraction.
*
* @param localName a <code>String</code> giving the local name
* @return a <code>Name</code> 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 <code>SOAPFactory</code> object that is an instance of
* the default implementation (SOAP 1.1),
*
* This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load:
* <UL>
* <LI> Use the javax.xml.soap.SOAPFactory system property.
* <LI> Use the properties file "lib/jaxm.properties" in the JRE directory. This configuration file is in standard
* java.util.Properties format and contains the fully qualified name of the implementation class with the key being the
* system property defined above.
* <LI> Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API
* will look for a classname in the file META-INF/services/javax.xml.soap.SOAPFactory in jars available to the runtime.
* <LI> Use the SAAJMetaFactory instance to locate the SOAPFactory implementation class.
* </UL>
*
* @return a new instance of a <code>SOAPFactory</code>
*
* @exception SOAPException if there was an error creating the
* default <code>SOAPFactory</code>
* @see SAAJMetaFactory
*/
public static SOAPFactory newInstance()
throws SOAPException
{
try {
SOAPFactory factory = (SOAPFactory) FactoryFinder.find(SOAP_FACTORY_PROPERTY);
if (factory != null)
return factory;
return newInstance(SOAPConstants.SOAP_1_1_PROTOCOL);
} catch (Exception ex) {
throw new SOAPException(
"Unable to create SOAP Factory: " + ex.getMessage());
}
}
/**
* Creates a new <code>SOAPFactory</code> object that is an instance of
* the specified implementation, this method uses the SAAJMetaFactory to
* locate the implementation class and create the SOAPFactory instance.
*
* @return a new instance of a <code>SOAPFactory</code>
*
* @param protocol a string constant representing the protocol of the
* specified SOAP factory implementation. May be
* either <code>DYNAMIC_SOAP_PROTOCOL</code>,
* <code>DEFAULT_SOAP_PROTOCOL</code> (which is the same
* as) <code>SOAP_1_1_PROTOCOL</code>, or
* <code>SOAP_1_2_PROTOCOL</code>.
*
* @exception SOAPException if there was an error creating the
* specified <code>SOAPFactory</code>
* @see SAAJMetaFactory
* @since SAAJ 1.3
*/
public static SOAPFactory newInstance(String protocol)
throws SOAPException {
return SAAJMetaFactory.getInstance().newSOAPFactory(protocol);
}
}