org.hornetq.api.jms.management
Interface JMSServerControl


public interface JMSServerControl

A JMSSserverControl is used to manage HornetQ JMS server.

Author:
Jeff Mesnil, Tim Fox

Method Summary
 boolean closeConnectionsForAddress(String ipAddress)
          Closes all the connections of clients connected to this server which matches the specified IP address.
 void createConnectionFactory(String name, Object[] liveConnectorsTransportClassNames, Object[] liveConnectorTransportParams, Object[] backupConnectorsTransportClassNames, Object[] backupConnectorTransportParams, Object[] bindings)
          Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup servers.
 void createConnectionFactory(String name, String discoveryAddress, int discoveryPort, Object[] bindings)
          Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers.
 void createConnectionFactory(String name, String discoveryAddress, int discoveryPort, String jndiBindings)
          Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers.
 void createConnectionFactory(String name, String liveTransportClassName, Map<String,Object> liveTransportParams, Object[] jndiBindings)
          Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server.
 void createConnectionFactory(String name, String liveTransportClassNames, String liveTransportParams, String backupTransportClassNames, String backupTransportParams, String jndiBindings)
          Create a JMS ConnectionFactory with the specified name connected to a single live-backup pair of servers.
 boolean createQueue(String name)
          Creates a durable JMS Queue.
 boolean createQueue(String name, String jndiBindings)
          Creates a durable JMS Queue with the specified name and JNDI binding.
 boolean createQueue(String name, String jndiBindings, String selector)
          Creates a durable JMS Queue with the specified name, JNDI binding and selector.
 boolean createQueue(String name, String jndiBindings, String selector, boolean durable)
          Creates a JMS Queue with the specified name, durability, selector and JNDI binding.
 boolean createTopic(String name)
          Creates a JMS Topic.
 boolean createTopic(String name, String jndiBindings)
          Creates a JMS Topic with the specified name and JNDI binding.
 void destroyConnectionFactory(String name)
          Destroy the ConnectionFactory corresponding to the specified name.
 boolean destroyQueue(String name)
          Destroys a JMS Queue with the specified name.
 boolean destroyTopic(String name)
          Destroys a JMS Topic with the specified name.
 String[] getConnectionFactoryNames()
          Returns the names of the JMS connection factories available on this server.
 String[] getQueueNames()
          Returns the names of the JMS queues available on this server.
 String[] getTopicNames()
          Returns the names of the JMS topics available on this server.
 String getVersion()
          Returns this server's version
 boolean isStarted()
          Returns whether this server is started.
 String[] listConnectionIDs()
          Lists all the IDs of the connections connected to this server.
 String[] listRemoteAddresses()
          Lists the addresses of all the clients connected to this address.
 String[] listRemoteAddresses(String ipAddress)
          Lists the addresses of the clients connected to this address which matches the specified IP address.
 String[] listSessions(String connectionID)
          Lists all the sessions IDs for the specified connection ID.
 

Method Detail

isStarted

boolean isStarted()
Returns whether this server is started.


getVersion

String getVersion()
Returns this server's version


getTopicNames

String[] getTopicNames()
Returns the names of the JMS topics available on this server.


getQueueNames

String[] getQueueNames()
Returns the names of the JMS queues available on this server.


getConnectionFactoryNames

String[] getConnectionFactoryNames()
Returns the names of the JMS connection factories available on this server.


createQueue

boolean createQueue(String name)
                    throws Exception
Creates a durable JMS Queue.

Returns:
true if the queue was created, false else
Throws:
Exception

createQueue

boolean createQueue(String name,
                    String jndiBindings)
                    throws Exception
Creates a durable JMS Queue with the specified name and JNDI binding.

Returns:
true if the queue was created, false else
Throws:
Exception

createQueue

boolean createQueue(String name,
                    String jndiBindings,
                    String selector)
                    throws Exception
Creates a durable JMS Queue with the specified name, JNDI binding and selector.

Returns:
true if the queue was created, false else
Throws:
Exception

createQueue

boolean createQueue(String name,
                    String jndiBindings,
                    String selector,
                    boolean durable)
                    throws Exception
Creates a JMS Queue with the specified name, durability, selector and JNDI binding.

Returns:
true if the queue was created, false else
Throws:
Exception

destroyQueue

boolean destroyQueue(String name)
                     throws Exception
Destroys a JMS Queue with the specified name.

Returns:
true if the queue was destroyed, false else
Throws:
Exception

createTopic

boolean createTopic(String name)
                    throws Exception
Creates a JMS Topic.

Returns:
true if the topic was created, false else
Throws:
Exception

createTopic

boolean createTopic(String name,
                    String jndiBindings)
                    throws Exception
Creates a JMS Topic with the specified name and JNDI binding.

Returns:
true if the topic was created, false else
Throws:
Exception

destroyTopic

boolean destroyTopic(String name)
                     throws Exception
Destroys a JMS Topic with the specified name.

Returns:
true if the topic was destroyed, false else
Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             String liveTransportClassName,
                             Map<String,Object> liveTransportParams,
                             Object[] jndiBindings)
                             throws Exception
Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server.
The ConnectionFactory is bound to JNDI for all the specified bindings.

Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             Object[] liveConnectorsTransportClassNames,
                             Object[] liveConnectorTransportParams,
                             Object[] backupConnectorsTransportClassNames,
                             Object[] backupConnectorTransportParams,
                             Object[] bindings)
                             throws Exception
Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup servers.
The ConnectionFactory is bound to JNDI for all the specified bindings Strings.
liveConnectorsTransportClassNames (resp. backupConnectorsTransportClassNames) are the class names of the ConnectorFactory to connect to the live (resp. backup) servers and liveConnectorTransportParams (resp. backupConnectorTransportParams) are Map<String, Object> for the corresponding TransportConfiguration's parameters.

Throws:
Exception
See Also:
ClientSessionFactory.setStaticConnectors(java.util.List)

createConnectionFactory

void createConnectionFactory(String name,
                             String liveTransportClassNames,
                             String liveTransportParams,
                             String backupTransportClassNames,
                             String backupTransportParams,
                             String jndiBindings)
                             throws Exception
Create a JMS ConnectionFactory with the specified name connected to a single live-backup pair of servers.
The ConnectionFactory is bound to JNDI for all the specified bindings Strings.
backupTransportClassNames and backupTransportParams can be null if there is no backup server.

Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             String discoveryAddress,
                             int discoveryPort,
                             Object[] bindings)
                             throws Exception
Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers.
The ConnectionFactory is bound to JNDI for all the specified bindings Strings.
This factory listens to the specified discoveryAddress and discoveryPort to discover which servers it can connect to.

Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             String discoveryAddress,
                             int discoveryPort,
                             String jndiBindings)
                             throws Exception
Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers.
The ConnectionFactory is bound to JNDI for the specified bindings Strings
This factory listens to the specified discoveryAddress and discoveryPort to discover which servers it can connect to.

Throws:
Exception

destroyConnectionFactory

void destroyConnectionFactory(String name)
                              throws Exception
Destroy the ConnectionFactory corresponding to the specified name.

Throws:
Exception

listRemoteAddresses

String[] listRemoteAddresses()
                             throws Exception
Lists the addresses of all the clients connected to this address.

Throws:
Exception

listRemoteAddresses

String[] listRemoteAddresses(String ipAddress)
                             throws Exception
Lists the addresses of the clients connected to this address which matches the specified IP address.

Throws:
Exception

closeConnectionsForAddress

boolean closeConnectionsForAddress(String ipAddress)
                                   throws Exception
Closes all the connections of clients connected to this server which matches the specified IP address.

Throws:
Exception

listConnectionIDs

String[] listConnectionIDs()
                           throws Exception
Lists all the IDs of the connections connected to this server.

Throws:
Exception

listSessions

String[] listSessions(String connectionID)
                      throws Exception
Lists all the sessions IDs for the specified connection ID.

Throws:
Exception


Copyright © 2009 Red Hat Inc. All Rights Reserved.