webMethods Broker API for JMS
Version 9.5.1.0.171 091713

com.webmethods.jms
Class WmJMSFactory

java.lang.Object
  extended by com.webmethods.jms.WmJMSFactory

public class WmJMSFactory
extends java.lang.Object

This factory class provides access to connection factories and destinations without the need for JNDI.


Method Summary
static WmConnectionFactory getConnectionFactory()
          Get a new instance of a WmConnectionFactory.
static WmQueue getQueue()
          Get a new instance of a WmQueue.
static WmQueue getQueue(java.lang.String queueName)
          Get a new instance of a WmQueue.
static WmQueueConnectionFactory getQueueConnectionFactory()
          Get a new instance of a WmQueueConnectionFactory.
static javax.jms.TemporaryQueue getTemporaryQueue(java.lang.String queueName)
          Get a new instance of a TemporaryQueue.
static javax.jms.TemporaryTopic getTemporaryTopic(java.lang.String topicName)
          Get a new instance of a TemporaryTopic.
static WmTopic getTopic()
          Get a new instance of a WmTopic.
static WmTopic getTopic(java.lang.String topicName)
          Get a new instance of a WmTopic.
static WmTopicConnectionFactory getTopicConnectionFactory()
          Get a new instance of a WmTopicConnectionFactory.
static WmConnectionFactory getXAConnectionFactory()
          Get a new instance of a WmConnectionFactory that implements the XAConnectionFactory interface.
static WmQueueConnectionFactory getXAQueueConnectionFactory()
          Get a new instance of a WmQueueConnectionFactory that implements the XAQueueConnectionFactory interface.
static WmTopicConnectionFactory getXATopicConnectionFactory()
          Get a new instance of a WmTopicConnectionFactory that implements the XATopicConnectionFactory interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getConnectionFactory

public static WmConnectionFactory getConnectionFactory()
                                                throws javax.jms.JMSException
Get a new instance of a WmConnectionFactory. The returned ConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a ConnectionFactory implementation
Throws:
javax.jms.JMSException - if the ConnectionFactory could not be instantiated.

getQueueConnectionFactory

public static WmQueueConnectionFactory getQueueConnectionFactory()
                                                          throws javax.jms.JMSException
Get a new instance of a WmQueueConnectionFactory. The returned QueueConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a QueueConnectionFactory implementation
Throws:
javax.jms.JMSException - if the QueueConnectionFactory could not be instantiated.

getTopicConnectionFactory

public static WmTopicConnectionFactory getTopicConnectionFactory()
                                                          throws javax.jms.JMSException
Get a new instance of a WmTopicConnectionFactory. The returned TopicConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a TopicConnectionFactory implementation
Throws:
javax.jms.JMSException - if the TopicConnectionFactory could not be instantiated.

getXAConnectionFactory

public static WmConnectionFactory getXAConnectionFactory()
                                                  throws javax.jms.JMSException
Get a new instance of a WmConnectionFactory that implements the XAConnectionFactory interface. The returned XAConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a XAConnectionFactory implementation
Throws:
javax.jms.JMSException - if the XAConnectionFactory could not be instantiated.

getXAQueueConnectionFactory

public static WmQueueConnectionFactory getXAQueueConnectionFactory()
                                                            throws javax.jms.JMSException
Get a new instance of a WmQueueConnectionFactory that implements the XAQueueConnectionFactory interface. The returned XAQueueConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a XAQueueConnectionFactory implementation
Throws:
javax.jms.JMSException - if the XAQueueConnectionFactory could not be instantiated.

getXATopicConnectionFactory

public static WmTopicConnectionFactory getXATopicConnectionFactory()
                                                            throws javax.jms.JMSException
Get a new instance of a WmTopicConnectionFactory that implements the XATopicConnectionFactory interface. The returned XATopicConnectionFactory will by default connect to the default Broker on the local host.

Returns:
a new instance of a XATopicConnectionFactory implementation
Throws:
javax.jms.JMSException - if the XATopicConnectionFactory could not be instantiated.

getQueue

public static WmQueue getQueue(java.lang.String queueName)
                        throws javax.jms.JMSException
Get a new instance of a WmQueue.

Parameters:
queueName - the name of the queue
Returns:
a new instance of a WmQueue
Throws:
javax.jms.JMSException - if the WmQueue could not be instantiated.

getQueue

public static WmQueue getQueue()
                        throws javax.jms.JMSException
Get a new instance of a WmQueue.

A queue must have a name. Any attempt to use this queue before setting its name with WmDestination.setName(java.lang.String) will result in an error. It is recommended that the getQueue(String) method be used.

Returns:
a new instance of a WmQueue
Throws:
javax.jms.JMSException - if the WmQueue could not be instantiated.

getTopic

public static WmTopic getTopic(java.lang.String topicName)
                        throws javax.jms.JMSException
Get a new instance of a WmTopic.

Parameters:
topicName - the name of the topic
Returns:
a new instance of a WmTopic
Throws:
javax.jms.JMSException - if the WmTopic could not be instantiated.

getTopic

public static WmTopic getTopic()
                        throws javax.jms.JMSException
Get a new instance of a WmTopic.

A topic must have a name. Any attempt to use this topic before setting its name with WmDestination.setName(java.lang.String) will result in an error. It is recommended that the getQueue(String) method be used.

Returns:
a new instance of a WmTopic
Throws:
javax.jms.JMSException - if the WmTopic could not be instantiated.

getTemporaryQueue

public static javax.jms.TemporaryQueue getTemporaryQueue(java.lang.String queueName)
                                                  throws javax.jms.JMSException
Get a new instance of a TemporaryQueue.

This method is primarily useful for inbound marshaling methods. If a JMSReplyTo destination is a TemporaryQueue, this method can be used to instantiate an instance of that TemporaryQueue so the recipient can use the destination for replies.

Returns:
a new instance of an object that implements the TemporaryQueue interface
Throws:
javax.jms.JMSException - if the TemporaryQueue could not be instantiated.

getTemporaryTopic

public static javax.jms.TemporaryTopic getTemporaryTopic(java.lang.String topicName)
                                                  throws javax.jms.JMSException
Get a new instance of a TemporaryTopic.

This method is primarily useful for inbound marshaling methods. If a JMSReplyTo destination is a TemporaryTopic, this method can be used to instantiate an instance of that TemporaryTopic so the recipient can use the destination for replies.

Returns:
a new instance of an object that implements the TemporaryTopic interface
Throws:
javax.jms.JMSException - if the TemporaryTopic could not be instantiated.

webMethods Broker API for JMS
Version 9.5.1.0.171 091713


Copyright © 2001 - 2013 Software AG Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their suppliers.