org.ow2.jotm.jms.api
Interface JmsManager

All Known Implementing Classes:

JmsManagerImpl

public interface JmsManager

This interface is used by components that want to access a JMS Manager. The JMS Manager encapsulates a MOM like Joram. This interface is implemented by JmsManagerImpl.

Author:

durieuxp

Method Summary

Queue	createQueue(String name) Creation of an administered Object Queue and bind it in the registry Can be retrieved later by lookup(name)
Topic	createTopic(String name) Creation of an administered Object Topic and bind it in the registry Can be retrieved later by lookup(name)
ConnectionFactory	getConnectionFactory()
QueueConnectionFactory	getQueueConnectionFactory()
TopicConnectionFactory	getTopicConnectionFactory() Get the unique TopicConnectionFactory registered in JNDI with the name "TCF".
void	init(Class cl, boolean collocated, String url, TransactionManager tm) Initialization of the JmsManager.
void	stop() Terminate the administering process and unbind all objects in JNDI.

Method Detail

init

void init(Class cl,
          boolean collocated,
          String url,
          TransactionManager tm)
          throws Exception

Initialization of the JmsManager. Since the JmsManager is instanciate with a constructor without arg, we need this method to perform the actual initialization.

Parameters:

cl - class implementing JmsAdministration

collocated - true if collacated, false if remote.

url - In case of remote: the URL.

tm - TransactionManager

Throws:

Exception - could not init the JmsManager

getConnectionFactory

ConnectionFactory getConnectionFactory()
                                       throws Exception

Throws:

Exception

getQueueConnectionFactory

QueueConnectionFactory getQueueConnectionFactory()
                                                 throws Exception

Throws:

Exception

getTopicConnectionFactory

TopicConnectionFactory getTopicConnectionFactory()
                                                 throws Exception

Get the unique TopicConnectionFactory registered in JNDI with the name "TCF". Can also got it by a lookup("TCF")

Returns:

the TopicConnectionFactory (TCF)

Throws:

Exception

createQueue

Queue createQueue(String name)
                  throws Exception

Creation of an administered Object Queue and bind it in the registry Can be retrieved later by lookup(name)

Parameters:

name - JNDI name.

Returns:

the created Queue

Throws:

Exception

createTopic

Topic createTopic(String name)
                  throws Exception

Creation of an administered Object Topic and bind it in the registry Can be retrieved later by lookup(name)

Parameters:

name - JNDI name.

Returns:

the created Topic

Throws:

Exception

stop

void stop()
          throws Exception

Terminate the administering process and unbind all objects in JNDI.

Throws:

Exception