IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.sib.api.jms
Class JmsFactoryFactory

java.lang.Object
  extended by com.ibm.websphere.sib.api.jms.JmsFactoryFactory

public abstract class JmsFactoryFactory
extends java.lang.Object

The JmsFactoryFactory class is the programmatic entry point into the JMS implementation classes.

We separate interfaces and implementation so that applications can be compiled without having to have the implementation present, and this class allows applications to obtain the top level implementation objects.


Constructor Summary
JmsFactoryFactory()
           
 
Method Summary
abstract  JmsConnectionFactory createConnectionFactory()
          Create a provider specific ConnectionFactory object.
abstract  JmsQueue createQueue(java.lang.String name)
          Provides the ability to create a javax.jms.Queue object without creating a JMS Session.
abstract  JmsQueueConnectionFactory createQueueConnectionFactory()
          Create a provider specific QueueConnectionFactory object.
abstract  JmsTopic createTopic(java.lang.String name)
          Provides the ability to create a javax.jms.Topic object without creating a JMS Session.
abstract  JmsTopicConnectionFactory createTopicConnectionFactory()
          Create a provider specific TopicConnectionFactory object.
static JmsFactoryFactory getInstance()
          Returns a singleton instance of the JmsFactoryFactory class.
abstract  javax.jms.ConnectionMetaData getMetaData()
          Provides the ability to obtain a javax.jms.ConnectionMetaData object without creating an active Connection to the bus.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmsFactoryFactory

public JmsFactoryFactory()
Method Detail

getInstance

public static JmsFactoryFactory getInstance()
                                     throws javax.jms.JMSException
Returns a singleton instance of the JmsFactoryFactory class.

Returns:
The JmsFactoryFactory singleton object instance
Throws:
javax.jms.JMSException - If it was not possible to instantiate the implementation class.

createConnectionFactory

public abstract JmsConnectionFactory createConnectionFactory()
                                                      throws javax.jms.JMSException
Create a provider specific ConnectionFactory object.

Returns:
A new JMS ConnectionFactory object.
Throws:
javax.jms.JMSException - Indicates a failure to initialize the required classes.

createQueueConnectionFactory

public abstract JmsQueueConnectionFactory createQueueConnectionFactory()
                                                                throws javax.jms.JMSException
Create a provider specific QueueConnectionFactory object.

Returns:
A new JMS QueueConnectionFactory object.
Throws:
javax.jms.JMSException - Indicates a failure to initialize the required classes.

createTopicConnectionFactory

public abstract JmsTopicConnectionFactory createTopicConnectionFactory()
                                                                throws javax.jms.JMSException
Create a provider specific TopicConnectionFactory object.

Returns:
A new JMS TopicConnectionFactory object.
Throws:
javax.jms.JMSException - Indicates a failure to initialize the required classes.

createQueue

public abstract JmsQueue createQueue(java.lang.String name)
                              throws javax.jms.JMSException
Provides the ability to create a javax.jms.Queue object without creating a JMS Session.

This method is provided as a convenience to the application programmer, who may wish to create these objects to bind into JNDI without making an active Connection to the bus.

The behaviour of this method is equivalent to session.createQueue(name).

Parameters:
name - The name of the Queue this object should reference.
Returns:
A new JMS Queue (administered object).
Throws:
javax.jms.JMSException - If the supplied parameter is not in the correct format.
See Also:
Session.createQueue(String)

createTopic

public abstract JmsTopic createTopic(java.lang.String name)
                              throws javax.jms.JMSException
Provides the ability to create a javax.jms.Topic object without creating a JMS Session.

This method is provided as a convenience to the application programmer, who may wish to create these objects to bind into JNDI without making an active Connection to the bus.

The behaviour of this method is equivalent to session.createTopic(name).

Parameters:
name - The name of the Topic this object should reference.
Returns:
A new JMS Topic (administered object).
Throws:
javax.jms.JMSException - If the supplied parameter is not in the correct format.
See Also:
Session.createTopic(String)

getMetaData

public abstract javax.jms.ConnectionMetaData getMetaData()
                                                  throws javax.jms.JMSException
Provides the ability to obtain a javax.jms.ConnectionMetaData object without creating an active Connection to the bus.

This method is provided as a convenience to the application programmer. The behaviour of this method is equivalent to connection.getMetaData().

Returns:
A provider implementation of the ConnectionMetaData interface.
Throws:
javax.jms.JMSException - If the required information is not available.
See Also:
Connection.getMetaData()

IBM WebSphere Application ServerTM
Release 7