javax.xml.soap.SOAPConnectionFactory Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (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.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at http://glassfish.java.net/public/CDDL+GPL_1_1.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright (c) 2004-2013 Oracle and/or its affiliates. All rights reserved.
*/
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 final String DEFAULT_SOAP_CONNECTION_FACTORY
= "com.sun.xml.internal.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;
}