javax.xml.soap.SOAPConnectionFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 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
* https://glassfish.dev.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;
/**
* A factory for creating SOAPConnection objects. Implementation of this class
* is optional. If SOAPConnectionFactory.newInstance() throws an
* UnsupportedOperationException then the implementation does not support the
* SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects
* can be created by calling createConnection() on the newly
* created SOAPConnectionFactory object.
*/
public abstract class SOAPConnectionFactory {
/**
* A constant representing the default value for a SOAPConnection
* object. The default is the point-to-point SOAP connection.
*/
static private final String DEFAULT_SOAP_CONNECTION_FACTORY
= "com.sun.xml.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";
/**
* A constant representing the SOAPConnection class.
*/
static private final String SF_PROPERTY
= "javax.xml.soap.SOAPConnectionFactory";
/**
* Creates an instance of the default
* SOAPConnectionFactory object.
*
* @return a new instance of a default
* SOAPConnectionFactory object
*
* @exception SOAPException if there was an error creating the
* SOAPConnectionFactory
*
* @exception UnsupportedOperationException if newInstance is not
* supported.
*/
public static SOAPConnectionFactory newInstance()
throws SOAPException, UnsupportedOperationException
{
try {
return (SOAPConnectionFactory)
FactoryFinder.find(SF_PROPERTY,
DEFAULT_SOAP_CONNECTION_FACTORY);
} catch (Exception ex) {
throw new SOAPException("Unable to create SOAP connection factory: "
+ex.getMessage());
}
}
/**
* Create a new SOAPConnection.
*
* @return the new SOAPConnection object.
*
* @exception SOAPException if there was an exception creating the
* SOAPConnection object.
*/
public abstract SOAPConnection createConnection()
throws SOAPException;
}