org.exolab.jmscts.provider
Interface Administrator

public interface Administrator

This interface specifies methods for obtaining and manipulating administered objects managed by the JMS provider.
Although the JMS specification states that administered objects should be accessible via JNDI, not all providers implement this, and for those that do, there is no standard registration scheme (eg. some use LDAP).
This interface therefore avoids making assumptions on how administered objects are accessed.

Version:

$Revision: 1.2 $ $Date: 2004/02/02 03:50:09 $

Author:

Tim Anderson

See Also:

Provider

Method Summary

void	createDestination(java.lang.String name, boolean queue) Create an administered destination
boolean	destinationExists(java.lang.String name) Determines if an administered destination exists
void	destroyDestination(java.lang.String name) Destroy an administered destination
java.lang.String	getQueueConnectionFactory() Returns the name of the QueueConnectionFactory bound in JNDI
java.lang.String	getTopicConnectionFactory() Returns the name of the TopicConnectionFactory bound in JNDI
java.lang.String	getXAQueueConnectionFactory() Returns the name of the XAQueueConnectionFactory bound in JNDI
java.lang.String	getXATopicConnectionFactory() Returns the name of the XATopicConnectionFactory bound in JNDI
java.lang.Object	lookup(java.lang.String name) Look up the named administered object in JNDI

Method Detail

getQueueConnectionFactory

public java.lang.String getQueueConnectionFactory()

Returns the name of the QueueConnectionFactory bound in JNDI

Returns:

the default QueueConnectionFactory name

getTopicConnectionFactory

public java.lang.String getTopicConnectionFactory()

Returns the name of the TopicConnectionFactory bound in JNDI

Returns:

the default TopicConnectionFactory name

getXAQueueConnectionFactory

public java.lang.String getXAQueueConnectionFactory()

Returns the name of the XAQueueConnectionFactory bound in JNDI

Returns:

the default XAQueueConnectionFactory name

getXATopicConnectionFactory

public java.lang.String getXATopicConnectionFactory()

Returns the name of the XATopicConnectionFactory bound in JNDI

Returns:

the default XATopicConnectionFactory name

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException

Look up the named administered object in JNDI

Parameters:

name - the name that the administered object is bound to

Returns:

the administered object bound to name

Throws:

javax.naming.NamingException - if the object is not bound, or the lookup fails

createDestination

public void createDestination(java.lang.String name,
                              boolean queue)
                       throws javax.jms.JMSException

Create an administered destination

Parameters:

name - the destination name

queue - if true, create a queue, else create a topic

Throws:

javax.jms.JMSException - if the destination cannot be created

destroyDestination

public void destroyDestination(java.lang.String name)
                        throws javax.jms.JMSException

Destroy an administered destination

Parameters:

name - the destination name

Throws:

javax.jms.JMSException - if the destination cannot be destroyed

destinationExists

public boolean destinationExists(java.lang.String name)
                          throws javax.jms.JMSException

Determines if an administered destination exists

Parameters:

name - the destination name

Returns:

true if the destination exists

Throws:

javax.jms.JMSException - for any internal JMS provider error