Package jakarta.xml.messaging
Class ProviderConnectionFactory
- java.lang.Object
-
- jakarta.xml.messaging.ProviderConnectionFactory
-
@Deprecated public abstract class ProviderConnectionFactory extends java.lang.Object
Deprecated.since 6.2, will be removed without replacementA factory for creating connections to a particular messaging provider. AProviderConnectionFactory
object can be obtained in two different ways.- Call the
ProviderConnectionFactory.newInstance
method to get an instance of the defaultProviderConnectionFactory
object.
This instance can be used to create aProviderConnection
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, theProviderConnectionFactory
object is an administered object that was created by a container (a servlet or Enterprise JavaBeansTM container). TheProviderConnectionFactory
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 thatProviderConnectionFactory
object, it does a lookup, providing the logical name. The application can then use theProviderConnectionFactory
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 aProviderConnectionFactory
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();
- Call the
-
-
Constructor Summary
Constructors Constructor Description ProviderConnectionFactory()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract ProviderConnection
createConnection()
Deprecated.Creates aProviderConnection
object to the messaging provider that is associated with thisProviderConnectionFactory
object.static ProviderConnectionFactory
newInstance()
Deprecated.Creates a defaultProviderConnectionFactory
object.
-
-
-
Method Detail
-
createConnection
public abstract ProviderConnection createConnection() throws JAXMException
Deprecated.Creates aProviderConnection
object to the messaging provider that is associated with thisProviderConnectionFactory
object.- Returns:
- a
ProviderConnection
object that represents a connection to the provider associated with thisProviderConnectionFactory
object - Throws:
JAXMException
- if there is an error in creating the connection
-
newInstance
public static ProviderConnectionFactory newInstance() throws JAXMException
Deprecated.Creates a defaultProviderConnectionFactory
object.- Returns:
- a new instance of a
ProviderConnectionFactory
- Throws:
JAXMException
- if there was an error creating the defaultProviderConnectionFactory
-
-