mq5.0-source.main.jaxm-api.src.main.java.javax.xml.messaging.ProviderConnectionFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-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
* 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.messaging;
import javax.xml.soap.*;
/**
* A factory for creating connections to a particular messaging provider.
* A ProviderConnectionFactory
object can be obtained in two
* different ways.
*
* - Call the
ProviderConnectionFactory.newInstance
* method to get an instance of the default ProviderConnectionFactory
* object.
* This instance can be used to create a ProviderConnection
* object that connects to the default provider implementation.
*
* ProviderConnectionFactory pcf = ProviderConnectionFactory.newInstance();
* ProviderConnection con = pcf.createConnection();
*
*
*
- Retrieve a
ProviderConnectionFactory
object
* that has been registered with a naming service based on Java Naming and
* Directory InterfaceTM (JNDI) technology.
* In this case, the ProviderConnectionFactory
object is an
* administered object that was created by a container (a servlet or Enterprise
* JavaBeansTM container). The
* ProviderConnectionFactory
object was configured in an implementation-
* specific way, and the connections it creates will be to the specified
* messaging provider.
*
* Registering a ProviderConnectionFactory
object with a JNDI naming service
* associates it with a logical name. When an application wants to establish a
* connection with the provider associated with that
* ProviderConnectionFactory
object, it does a lookup, providing the
* logical name. The application can then use the
* ProviderConnectionFactory
* object that is returned to create a connection to the messaging provider.
* The first two lines of the following code fragment use JNDI methods to
* retrieve a ProviderConnectionFactory
object. The third line uses the
* returned object to create a connection to the JAXM provider that was
* registered with "ProviderXYZ" as its logical name.
*
* Context ctx = new InitialContext();
* ProviderConnectionFactory pcf = (ProviderConnectionFactory)ctx.lookup(
* "ProviderXYZ");
* ProviderConnection con = pcf.createConnection();
*
*
*/
public abstract class ProviderConnectionFactory {
/**
* Creates a ProviderConnection
object to the messaging provider that
* is associated with this ProviderConnectionFactory
* object.
*
* @return a ProviderConnection
object that represents
* a connection to the provider associated with this
* ProviderConnectionFactory
object
* @exception JAXMException if there is an error in creating the
* connection
*/
public abstract ProviderConnection createConnection()
throws JAXMException;
static private final String PCF_PROPERTY
= "javax.xml.messaging.ProviderConnectionFactory";
static private final String DEFAULT_PCF
= "com.sun.xml.messaging.jaxm.client.remote.ProviderConnectionFactoryImpl";
/**
* Creates a default ProviderConnectionFactory
object.
*
* @return a new instance of a ProviderConnectionFactory
*
* @exception JAXMException if there was an error creating the
* default ProviderConnectionFactory
*/
public static ProviderConnectionFactory newInstance()
throws JAXMException
{
//try {
return (ProviderConnectionFactory)
FactoryFinder.find(PCF_PROPERTY,
DEFAULT_PCF);
//} catch (Exception ex) {
//throw new JAXMException("Unable to create "+
//"ProviderConnectionFactory: "
//+ex.getMessage());
//}
}
}