org.jboss.messaging.core.management
Interface MessagingServerManagement

All Known Implementing Classes:

MessagingServerManagementImpl

public interface MessagingServerManagement

This interface describes the core management interface exposed by the server

Author:

Andy Taylor, Tim Fox

Method Summary

boolean	addDestination(SimpleString address) add an address to the post office
void	createQueue(SimpleString address, SimpleString name) creates a queue with the specified address
void	destroyQueue(SimpleString name) destroy a particular queue
Configuration	getConfiguration() list all available addresses
int	getMessageCountForQueue(SimpleString queue) count the number of messages in a queue
java.util.List<Queue>	getQueuesForAddress(SimpleString address) returns all the queues for a specific address
boolean	isStarted() is the server started
void	removeAllMessagesForAddress(SimpleString address) remove all the messages for a specific address
boolean	removeDestination(SimpleString address) remove an address from the post office

Method Detail

isStarted

boolean isStarted()

is the server started

Returns:

true if the server is running

createQueue

void createQueue(SimpleString address,
                 SimpleString name)
                 throws java.lang.Exception

creates a queue with the specified address

Parameters:

address - the address

name - the name of the queue

Throws:

java.lang.Exception - if a problem occurred

destroyQueue

void destroyQueue(SimpleString name)
                  throws java.lang.Exception

destroy a particular queue

Parameters:

name - the name of the queue

Throws:

java.lang.Exception - if a problem occurred

addDestination

boolean addDestination(SimpleString address)
                       throws java.lang.Exception

add an address to the post office

Parameters:

address - the address to add

Returns:

true if the address was added

Throws:

java.lang.Exception - if a problem occurred

removeDestination

boolean removeDestination(SimpleString address)
                          throws java.lang.Exception

remove an address from the post office

Parameters:

address - the address to remove

Returns:

true if the address was removed

Throws:

java.lang.Exception - if a problem occurred

getQueuesForAddress

java.util.List<Queue> getQueuesForAddress(SimpleString address)
                                          throws java.lang.Exception

returns all the queues for a specific address

Parameters:

address - the address

Returns:

the queues

Throws:

java.lang.Exception - if a problem occurred

removeAllMessagesForAddress

void removeAllMessagesForAddress(SimpleString address)
                                 throws java.lang.Exception

remove all the messages for a specific address

Parameters:

address - the address

Throws:

java.lang.Exception - if a problem occurred

getMessageCountForQueue

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

count the number of messages in a queue

Parameters:

queue - the name of the queue

Returns:

the number of messages in a queue

Throws:

java.lang.Exception - if a problem occurred

getConfiguration

Configuration getConfiguration()

list all available addresses

Returns:

the addresses