org.jboss.messaging.jms.server
Interface JMSServerManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

JMSServerManagerImpl

public interface JMSServerManager
extends java.io.Serializable

The JMS Management interface.

Author:

Andy Taylor

Nested Class Summary

static class

JMSServerManager.ListType

Method Summary

boolean	createConnectionFactory(java.lang.String name, java.lang.String clientID, int dupsOKBatchSize, int consumerWindowSize, int consumerMaxRate, int producerWindowSize, int producerMaxRate, boolean blockOnAcknowledge, boolean defaultSendNonPersistentMessagesBlocking, boolean defaultSendPersistentMessagesBlocking, java.util.List<java.lang.String> jndiBindings) Creates a connection factory
boolean	createConnectionFactory(java.lang.String name, java.lang.String clientID, int dupsOKBatchSize, int consumerWindowSize, int consumerMaxRate, int producerWindowSize, int producerMaxRate, boolean blockOnAcknowledge, boolean defaultSendNonPersistentMessagesBlocking, boolean defaultSendPersistentMessagesBlocking, java.lang.String jndiBinding) Creates a connection factory
boolean	createQueue(java.lang.String queueName, java.lang.String jndiBinding) Creates a JMS Queue.
boolean	createTopic(java.lang.String topicName, java.lang.String jndiBinding) Creates a JMS Topic
boolean	destroyConnectionFactory(java.lang.String name) destroys a connection factory.
boolean	destroyQueue(java.lang.String name) destroys a queue and removes it from JNDI
boolean	destroyTopic(java.lang.String name) destroys a topic and removes it from JNDI
int	getMessageCountForQueue(java.lang.String queue) returns how many messages a queue is currently holding
boolean	isStarted() Has the Server been started.
java.util.List<SubscriptionInfo>	listSubscriptions(java.lang.String topic) lists all the subscriptions for a specific topic
void	removeAllMessagesForQueue(java.lang.String queue) removes all messages from a particular queue
void	removeAllMessagesForTopic(java.lang.String topic) removes all the messages from a topic

Method Detail

isStarted

boolean isStarted()

Has the Server been started.

Returns:

true if the server us running

createQueue

boolean createQueue(java.lang.String queueName,
                    java.lang.String jndiBinding)
                    throws java.lang.Exception

Creates a JMS Queue.

Parameters:

queueName - The name of the queue to create

jndiBinding - the name of the binding for JNDI

Returns:

true if the queue is created or if it existed and was added to JNDI

Throws:

java.lang.Exception - if problems were encountered creating the queue.

createTopic

boolean createTopic(java.lang.String topicName,
                    java.lang.String jndiBinding)
                    throws java.lang.Exception

Creates a JMS Topic

Parameters:

topicName - the name of the topic

jndiBinding - the name of the binding for JNDI

Returns:

true if the topic was created or if it existed and was added to JNDI

Throws:

java.lang.Exception - if a problem occurred creating the topic

destroyQueue

boolean destroyQueue(java.lang.String name)
                     throws java.lang.Exception

destroys a queue and removes it from JNDI

Parameters:

name - the name of the queue to destroy

Returns:

true if destroyed

Throws:

java.lang.Exception - if a problem occurred destroying the queue

destroyTopic

boolean destroyTopic(java.lang.String name)
                     throws java.lang.Exception

destroys a topic and removes it from JNDI

Parameters:

name - the name of the topic to destroy

Returns:

true if the topic was destroyed

Throws:

java.lang.Exception - if a problem occurred destroying the topic

createConnectionFactory

boolean createConnectionFactory(java.lang.String name,
                                java.lang.String clientID,
                                int dupsOKBatchSize,
                                int consumerWindowSize,
                                int consumerMaxRate,
                                int producerWindowSize,
                                int producerMaxRate,
                                boolean blockOnAcknowledge,
                                boolean defaultSendNonPersistentMessagesBlocking,
                                boolean defaultSendPersistentMessagesBlocking,
                                java.lang.String jndiBinding)
                                throws java.lang.Exception

Creates a connection factory

Parameters:

name - the name of this connection factory

clientID - the client id

dupsOKBatchSize - the bath size

consumerWindowSize - The consumer window size

consumerMaxRate - the Consumer max rate

producerWindowSize - the producer window size

producerMaxRate - the producer max rate

jndiBinding - the binding name for JNDI

Returns:

true if the connection factory was created

Throws:

java.lang.Exception - if a problem occurred creating the connection factory

createConnectionFactory

boolean createConnectionFactory(java.lang.String name,
                                java.lang.String clientID,
                                int dupsOKBatchSize,
                                int consumerWindowSize,
                                int consumerMaxRate,
                                int producerWindowSize,
                                int producerMaxRate,
                                boolean blockOnAcknowledge,
                                boolean defaultSendNonPersistentMessagesBlocking,
                                boolean defaultSendPersistentMessagesBlocking,
                                java.util.List<java.lang.String> jndiBindings)
                                throws java.lang.Exception

Creates a connection factory

Parameters:

name - the name of this connection factory

clientID - the client id

dupsOKBatchSize - the bath size

consumerWindowSize - The consumer window size

consumerMaxRate - the Consumer max rate

producerWindowSize - the producer window size

producerMaxRate - the producer max rate

jndiBindings - the binding names for JNDI

Returns:

true if the connection factory was created

Throws:

java.lang.Exception - if a problem occurred creating the connection factory

destroyConnectionFactory

boolean destroyConnectionFactory(java.lang.String name)
                                 throws java.lang.Exception

destroys a connection factory.

Parameters:

name - the name of the connection factory to destroy

Returns:

true if the connection factory was destroyed

Throws:

java.lang.Exception - if a problem occurred destroying the connection factory

removeAllMessagesForQueue

void removeAllMessagesForQueue(java.lang.String queue)
                               throws java.lang.Exception

removes all messages from a particular queue

Parameters:

queue - the name of the queue

Throws:

java.lang.Exception - if a problem occurred

removeAllMessagesForTopic

void removeAllMessagesForTopic(java.lang.String topic)
                               throws java.lang.Exception

removes all the messages from a topic

Parameters:

topic - the name of the topic

Throws:

java.lang.Exception - if a problem occurred

getMessageCountForQueue

int getMessageCountForQueue(java.lang.String queue)
                            throws java.lang.Exception

returns how many messages a queue is currently holding

Parameters:

queue - the name of the queue

Returns:

the number of messages

Throws:

java.lang.Exception - if a problem occurred

listSubscriptions

java.util.List<SubscriptionInfo> listSubscriptions(java.lang.String topic)
                                                   throws java.lang.Exception

lists all the subscriptions for a specific topic

Parameters:

topic - the name of the topic

Returns:

the subscriptions

Throws:

java.lang.Exception - if a problem occurred