JTR 5.0 API Documentation

jtr.config.jms
Class JMSConfig

java.lang.Object
  extended by jtr.config.jms.JMSConfig
All Implemented Interfaces:
java.io.Serializable

public class JMSConfig
extends java.lang.Object
implements java.io.Serializable

This class is the object oriented representation of the content of the jtx.xml <jms> element. It provides:
1. a unique name identifying the current JMS configuration
2. a set of queues
3. a set of topics
4. a set of connection factories
Both queues and topics are shaped as JMSDestination instances, while connection factories are represented by means of JMSConnectionFactory instances.

Since:
1.1
Version:
5.0
Author:
Francesco Russo (frusso@dev.java.net)
See Also:
jtr.config.JMSConnectionFactory, Serialized Form

Constructor Summary
JMSConfig()
          The default constructor.
 
Method Summary
 void addQueue(java.lang.String jndiName, java.lang.String propertyName)
          Add a queue to the set of queues available with this JMS configuration
 void addTopic(java.lang.String jndiName, java.lang.String propertyName)
          Add a topic to the set of topics available with this JMS configuration
 java.util.Collection<JMSConnectionFactory> getConnectionFactories()
          Get the connection factories available with the current JMS configuration
 java.util.Collection<JMSDestination> getQueues()
          Return the set of confiured queues.
 java.util.Collection<JMSDestination> getTopics()
          Return the set of configured topics
 java.lang.String getUniqueName()
          Get the unique name of this JMS configuration.
 void setConnectionFactories(JMSFactories jmsF)
          Set the connection factories available with the current JMS configuration
 void setUniqueName(java.lang.String name)
          Set the unique name of this JMS configuration.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JMSConfig

public JMSConfig()
The default constructor.

Method Detail

setUniqueName

public void setUniqueName(java.lang.String name)
Set the unique name of this JMS configuration.

Parameters:
name - The unique name

getUniqueName

public java.lang.String getUniqueName()
Get the unique name of this JMS configuration.

Returns:
The unique name

addQueue

public void addQueue(java.lang.String jndiName,
                     java.lang.String propertyName)
Add a queue to the set of queues available with this JMS configuration

Parameters:
jndiName - The queue's JNDI name
propertyName - The name of the property exposed by the runner that will hold the queue

getQueues

public java.util.Collection<JMSDestination> getQueues()
Return the set of confiured queues.

Returns:
Collection The configured queues

addTopic

public void addTopic(java.lang.String jndiName,
                     java.lang.String propertyName)
Add a topic to the set of topics available with this JMS configuration

Parameters:
jndiName - The topic's JNDI name
propertyName - String

getTopics

public java.util.Collection<JMSDestination> getTopics()
Return the set of configured topics

Returns:
Collection The topics

setConnectionFactories

public void setConnectionFactories(JMSFactories jmsF)
Set the connection factories available with the current JMS configuration

Parameters:
jmsF - The connection factories

getConnectionFactories

public java.util.Collection<JMSConnectionFactory> getConnectionFactories()
Get the connection factories available with the current JMS configuration

Returns:
Collection The connection factories

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

The JTR Project is licensed under GPL version 2