jrun.jms.core.server.rmi
Interface RemoteJmsAdminServerIfc

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RmiJmsAdminServer

public interface RemoteJmsAdminServerIfc

extends java.rmi.Remote

This specifies all the administration methods that can be used to control the JMS server through an RMI connector. The control logic is all at the org.exolab.jms.server package level

Version:

$Revision: 1.7 $ $Date: 2001/05/24 16:36:16 $

Author:

Jim Alateras

See Also:

Remote

Field Summary

static java.lang.String

Name Define the administration server name for the RMI binding

Method Summary

boolean	addDestination(java.lang.String destination, java.lang.Boolean queue) Add a specific destination with the specified name
boolean	addDurableConsumer(java.lang.String topic, java.lang.String name) Add a consumer for the specified topic
boolean	durableConsumerExists(java.lang.String name) Check if a durable consumer, with the specified name, already exists
java.util.Vector	getAllDestinations() Return a list of all registered destinations.
int	getDurableConsumerMessageCount(java.lang.String topic, java.lang.String name) Return the number of outstanding messages for a particular destination.
java.util.Vector	getDurableConsumers(java.lang.String destination) Return the collection of durable consumer names for a particular topic destination.
int	getQueueMessageCount(java.lang.String queue) Return the number of outstanding messages for a particular queue.
boolean	isConnected(java.lang.String name) Check to see if the given consumer is currently connected to the OpenJMSServer.
int	purgeMessages() Purge all processed messages from the database
boolean	removeDestination(java.lang.String name) Destroy the specified destination and all associated messsages and consumers.
boolean	removeDurableConsumer(java.lang.String name) Remove the consumer attached to the specified destination and with the passed in name
void	stopServer() Terminate the JMS Server.
boolean	unregisterConsumer(java.lang.String name) De-Activate an active persistent consumer.

Field Detail

Name

public static final java.lang.String Name

Define the administration server name for the RMI binding

Method Detail

addDurableConsumer

public boolean addDurableConsumer(java.lang.String topic,
                                  java.lang.String name)
                           throws java.rmi.RemoteException

Add a consumer for the specified topic

Parameters:

topic - name of the destination

name - name of the consumer

Returns:

boolean true if successful

Throws:

java.rmi.RemoteException -

removeDurableConsumer

public boolean removeDurableConsumer(java.lang.String name)
                              throws java.rmi.RemoteException

Remove the consumer attached to the specified destination and with the passed in name

Parameters:

name - name of the consumer

Returns:

boolean true if successful

Throws:

java.rmi.RemoteException -

durableConsumerExists

public boolean durableConsumerExists(java.lang.String name)
                              throws java.rmi.RemoteException

Check if a durable consumer, with the specified name, already exists

Parameters:

name - name of the consumer

Returns:

boolean true if it exists

Throws:

java.rmi.RemoteException -

getDurableConsumers

public java.util.Vector getDurableConsumers(java.lang.String destination)
                                     throws java.rmi.RemoteException

Return the collection of durable consumer names for a particular topic destination.

Parameters:

topic - the topic name

Returns:

Vector collection of strings

Throws:

java.rmi.RemoteException -

unregisterConsumer

public boolean unregisterConsumer(java.lang.String name)
                           throws java.rmi.RemoteException

De-Activate an active persistent consumer.

Parameters:

name - name of the consumer

Returns:

boolean true if successful

Throws:

java.rmi.RemoteException -

isConnected

public boolean isConnected(java.lang.String name)
                    throws java.rmi.RemoteException

Check to see if the given consumer is currently connected to the OpenJMSServer. This is only valid when in online mode.

Parameters:

name - The name of the onsumer.

Returns:

boolean True if the consumer is connected.

Throws:

java.rmi.RemoteException -

addDestination

public boolean addDestination(java.lang.String destination,
                              java.lang.Boolean queue)
                       throws java.rmi.RemoteException

Add a specific destination with the specified name

Parameters:

name - destination name

queue - whether it is queue or a topic

Returns:

boolean true if successful

Throws:

java.rmi.RemoteException -

removeDestination

public boolean removeDestination(java.lang.String name)
                          throws java.rmi.RemoteException

Destroy the specified destination and all associated messsages and consumers. This is a very dangerous operation to execute while there are clients online

Parameters:

destination - destination to destroy

Throws:

java.rmi.RemoteException -

getAllDestinations

public java.util.Vector getAllDestinations()
                                    throws java.rmi.RemoteException

Return a list of all registered destinations.

Returns:

Vector collection of strings

Throws:

java.rmi.RemoteException -

getDurableConsumerMessageCount

public int getDurableConsumerMessageCount(java.lang.String topic,
                                          java.lang.String name)
                                   throws java.rmi.RemoteException

Return the number of outstanding messages for a particular destination.

Parameters:

topic - name of the topic

name - durable consumer name

Returns:

int message count

Throws:

java.rmi.RemoteException -

getQueueMessageCount

public int getQueueMessageCount(java.lang.String queue)
                         throws java.rmi.RemoteException

Return the number of outstanding messages for a particular queue.

Parameters:

queue - the queue name

Returns:

int message count

Throws:

java.rmi.RemoteException -

purgeMessages

public int purgeMessages()
                  throws java.rmi.RemoteException

Purge all processed messages from the database

Returns:

int the number of purged messages

Throws:

java.rmi.RemoteException -

stopServer

public void stopServer()
                throws java.rmi.RemoteException

Terminate the JMS Server. If it is running as a standalone application then exit the application. It is running as an embedded application then just terminate the thread