org.hornetq.jms.server
Interface JMSServerManager

All Superinterfaces:
org.hornetq.core.server.HornetQComponent
All Known Implementing Classes:
JMSServerManagerImpl

public interface JMSServerManager
extends org.hornetq.core.server.HornetQComponent

The JMS Management interface.

Author:
Andy Taylor, Jeff Mesnil, Tim Fox

Method Summary
 void addAddressSettings(String address, org.hornetq.core.settings.impl.AddressSettings addressSettings)
           
 boolean addConnectionFactoryToJNDI(String name, String binding)
           
 boolean addQueueToJndi(String queueName, String binding)
           
 void addSecurity(String addressMatch, Set<org.hornetq.core.security.Role> roles)
           
 boolean addTopicToJndi(String topicName, String binding)
           
 boolean closeConnectionsForAddress(String ipAddress)
           
 void createConnectionFactory(boolean storeConfig, ConnectionFactoryConfiguration cfConfig, String... bindings)
           
 void createConnectionFactory(String name, boolean ha, JMSFactoryType cfType, List<String> connectorNames, String... bindings)
           
 void createConnectionFactory(String name, boolean ha, JMSFactoryType cfType, List<String> connectorNames, String clientID, long clientFailureCheckPeriod, long connectionTTL, long callTimeout, long callFailoverTimeout, boolean cacheLargeMessagesClient, int minLargeMessageSize, boolean compressLargeMessage, int consumerWindowSize, int consumerMaxRate, int confirmationWindowSize, int producerWindowSize, int producerMaxRate, boolean blockOnAcknowledge, boolean blockOnDurableSend, boolean blockOnNonDurableSend, boolean autoGroup, boolean preAcknowledge, String loadBalancingPolicyClassName, int transactionBatchSize, int dupsOKBatchSize, boolean useGlobalPools, int scheduledThreadPoolMaxSize, int threadPoolMaxSize, long retryInterval, double retryIntervalMultiplier, long maxRetryInterval, int reconnectAttempts, boolean failoverOnInitialConnection, String groupId, String... bindings)
           
 void createConnectionFactory(String name, boolean ha, JMSFactoryType cfType, String discoveryGroupName, String... jndiBindings)
           
 void createConnectionFactory(String name, boolean ha, JMSFactoryType cfType, String discoveryGroupName, String clientID, long clientFailureCheckPeriod, long connectionTTL, long callTimeout, long callFailoverTimeout, boolean cacheLargeMessagesClient, int minLargeMessageSize, boolean compressLargeMessages, int consumerWindowSize, int consumerMaxRate, int confirmationWindowSize, int producerWindowSize, int producerMaxRate, boolean blockOnAcknowledge, boolean blockOnDurableSend, boolean blockOnNonDurableSend, boolean autoGroup, boolean preAcknowledge, String loadBalancingPolicyClassName, int transactionBatchSize, int dupsOKBatchSize, boolean useGlobalPools, int scheduledThreadPoolMaxSize, int threadPoolMaxSize, long retryInterval, double retryIntervalMultiplier, long maxRetryInterval, int reconnectAttempts, boolean failoverOnInitialConnection, String groupId, String... bindings)
           
 boolean createQueue(boolean storeConfig, String queueName, String selectorString, boolean durable, String... bindings)
          Creates a JMS Queue.
 boolean createTopic(boolean storeConfig, String topicName, String... bindings)
          Creates a JMS Topic
 boolean destroyConnectionFactory(String name)
          destroys a connection factory.
 boolean destroyQueue(String name)
          destroys a queue and removes it from JNDI or BindingRegistry
 boolean destroyTopic(String name)
          destroys a topic and removes it from JNDI or BindingRegistry
 org.hornetq.core.settings.impl.AddressSettings getAddressSettings(String address)
           
 org.hornetq.core.server.HornetQServer getHornetQServer()
           
 String[] getJNDIOnConnectionFactory(String factoryName)
           
 String[] getJNDIOnQueue(String queue)
           
 String[] getJNDIOnTopic(String topic)
           
 BindingRegistry getRegistry()
           
 Set<org.hornetq.core.security.Role> getSecurity(String addressMatch)
           
 String getVersion()
           
 boolean isStarted()
          Has the Server been started.
 String[] listConnectionIDs()
           
 String listPreparedTransactionDetailsAsHTML()
           
 String listPreparedTransactionDetailsAsJSON()
           
 String[] listRemoteAddresses()
           
 String[] listRemoteAddresses(String ipAddress)
           
 String[] listSessions(String connectionID)
           
 HornetQConnectionFactory recreateCF(String name, ConnectionFactoryConfiguration cf)
          Call this method to have a CF rebound to JNDI and stored on the Journal
 boolean removeConnectionFactoryFromJNDI(String name)
           
 boolean removeConnectionFactoryFromJNDI(String name, String binding)
           
 boolean removeQueueFromJNDI(String name)
          Remove the queue from JNDI or BindingRegistry.
 boolean removeQueueFromJNDI(String name, String binding)
          Remove the queue from JNDI or BindingRegistry.
 boolean removeTopicFromJNDI(String name)
          Remove the topic from JNDI or BindingRegistry.
 boolean removeTopicFromJNDI(String name, String binding)
          Remove the topic from JNDI or BindingRegistry.
 void setContext(Context context)
           
 void setRegistry(BindingRegistry registry)
          Set this property if you want something other than JNDI for your registry
 
Methods inherited from interface org.hornetq.core.server.HornetQComponent
start, stop
 

Method Detail

getVersion

String getVersion()

isStarted

boolean isStarted()
Has the Server been started.

Specified by:
isStarted in interface org.hornetq.core.server.HornetQComponent
Returns:
true if the server us running

createQueue

boolean createQueue(boolean storeConfig,
                    String queueName,
                    String selectorString,
                    boolean durable,
                    String... bindings)
                    throws Exception
Creates a JMS Queue.

Parameters:
queueName - The name of the queue to create
selectorString -
durable -
Returns:
true if the queue is created or if it existed and was added to JNDI
Throws:
Exception - if problems were encountered creating the queue.

addTopicToJndi

boolean addTopicToJndi(String topicName,
                       String binding)
                       throws Exception
Throws:
Exception

addQueueToJndi

boolean addQueueToJndi(String queueName,
                       String binding)
                       throws Exception
Throws:
Exception

addConnectionFactoryToJNDI

boolean addConnectionFactoryToJNDI(String name,
                                   String binding)
                                   throws Exception
Throws:
Exception

createTopic

boolean createTopic(boolean storeConfig,
                    String topicName,
                    String... bindings)
                    throws Exception
Creates a JMS Topic

Parameters:
topicName - the name of the topic
bindings - the names of the binding for JNDI or BindingRegistry
Returns:
true if the topic was created or if it existed and was added to JNDI
Throws:
Exception - if a problem occurred creating the topic

removeTopicFromJNDI

boolean removeTopicFromJNDI(String name,
                            String binding)
                            throws Exception
Remove the topic from JNDI or BindingRegistry. Calling this method does not destroy the destination.

Parameters:
name - the name of the destination to remove from JNDI or BindingRegistry
Returns:
true if removed
Throws:
Exception - if a problem occurred removing the destination

removeTopicFromJNDI

boolean removeTopicFromJNDI(String name)
                            throws Exception
Remove the topic from JNDI or BindingRegistry. Calling this method does not destroy the destination.

Parameters:
name - the name of the destination to remove from JNDI or BindingRegistry
Returns:
true if removed
Throws:
Exception - if a problem occurred removing the destination

removeQueueFromJNDI

boolean removeQueueFromJNDI(String name,
                            String binding)
                            throws Exception
Remove the queue from JNDI or BindingRegistry. Calling this method does not destroy the destination.

Parameters:
name - the name of the destination to remove from JNDI or BindingRegistry
Returns:
true if removed
Throws:
Exception - if a problem occurred removing the destination

removeQueueFromJNDI

boolean removeQueueFromJNDI(String name)
                            throws Exception
Remove the queue from JNDI or BindingRegistry. Calling this method does not destroy the destination.

Parameters:
name - the name of the destination to remove from JNDI or BindingRegistry
Returns:
true if removed
Throws:
Exception - if a problem occurred removing the destination

removeConnectionFactoryFromJNDI

boolean removeConnectionFactoryFromJNDI(String name,
                                        String binding)
                                        throws Exception
Throws:
Exception

removeConnectionFactoryFromJNDI

boolean removeConnectionFactoryFromJNDI(String name)
                                        throws Exception
Throws:
Exception

destroyQueue

boolean destroyQueue(String name)
                     throws Exception
destroys a queue and removes it from JNDI or BindingRegistry

Parameters:
name - the name of the queue to destroy
Returns:
true if destroyed
Throws:
Exception - if a problem occurred destroying the queue

getJNDIOnQueue

String[] getJNDIOnQueue(String queue)

getJNDIOnTopic

String[] getJNDIOnTopic(String topic)

getJNDIOnConnectionFactory

String[] getJNDIOnConnectionFactory(String factoryName)

destroyTopic

boolean destroyTopic(String name)
                     throws Exception
destroys a topic and removes it from JNDI or BindingRegistry

Parameters:
name - the name of the topic to destroy
Returns:
true if the topic was destroyed
Throws:
Exception - if a problem occurred destroying the topic

recreateCF

HornetQConnectionFactory recreateCF(String name,
                                    ConnectionFactoryConfiguration cf)
                                    throws Exception
Call this method to have a CF rebound to JNDI and stored on the Journal

Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             boolean ha,
                             JMSFactoryType cfType,
                             String discoveryGroupName,
                             String... jndiBindings)
                             throws Exception
Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             boolean ha,
                             JMSFactoryType cfType,
                             List<String> connectorNames,
                             String... bindings)
                             throws Exception
Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             boolean ha,
                             JMSFactoryType cfType,
                             List<String> connectorNames,
                             String clientID,
                             long clientFailureCheckPeriod,
                             long connectionTTL,
                             long callTimeout,
                             long callFailoverTimeout,
                             boolean cacheLargeMessagesClient,
                             int minLargeMessageSize,
                             boolean compressLargeMessage,
                             int consumerWindowSize,
                             int consumerMaxRate,
                             int confirmationWindowSize,
                             int producerWindowSize,
                             int producerMaxRate,
                             boolean blockOnAcknowledge,
                             boolean blockOnDurableSend,
                             boolean blockOnNonDurableSend,
                             boolean autoGroup,
                             boolean preAcknowledge,
                             String loadBalancingPolicyClassName,
                             int transactionBatchSize,
                             int dupsOKBatchSize,
                             boolean useGlobalPools,
                             int scheduledThreadPoolMaxSize,
                             int threadPoolMaxSize,
                             long retryInterval,
                             double retryIntervalMultiplier,
                             long maxRetryInterval,
                             int reconnectAttempts,
                             boolean failoverOnInitialConnection,
                             String groupId,
                             String... bindings)
                             throws Exception
Throws:
Exception

createConnectionFactory

void createConnectionFactory(String name,
                             boolean ha,
                             JMSFactoryType cfType,
                             String discoveryGroupName,
                             String clientID,
                             long clientFailureCheckPeriod,
                             long connectionTTL,
                             long callTimeout,
                             long callFailoverTimeout,
                             boolean cacheLargeMessagesClient,
                             int minLargeMessageSize,
                             boolean compressLargeMessages,
                             int consumerWindowSize,
                             int consumerMaxRate,
                             int confirmationWindowSize,
                             int producerWindowSize,
                             int producerMaxRate,
                             boolean blockOnAcknowledge,
                             boolean blockOnDurableSend,
                             boolean blockOnNonDurableSend,
                             boolean autoGroup,
                             boolean preAcknowledge,
                             String loadBalancingPolicyClassName,
                             int transactionBatchSize,
                             int dupsOKBatchSize,
                             boolean useGlobalPools,
                             int scheduledThreadPoolMaxSize,
                             int threadPoolMaxSize,
                             long retryInterval,
                             double retryIntervalMultiplier,
                             long maxRetryInterval,
                             int reconnectAttempts,
                             boolean failoverOnInitialConnection,
                             String groupId,
                             String... bindings)
                             throws Exception
Throws:
Exception

createConnectionFactory

void createConnectionFactory(boolean storeConfig,
                             ConnectionFactoryConfiguration cfConfig,
                             String... bindings)
                             throws Exception
Throws:
Exception

destroyConnectionFactory

boolean destroyConnectionFactory(String name)
                                 throws Exception
destroys a connection factory.

Parameters:
name - the name of the connection factory to destroy
Returns:
true if the connection factory was destroyed
Throws:
Exception - if a problem occurred destroying the connection factory

listRemoteAddresses

String[] listRemoteAddresses()
                             throws Exception
Throws:
Exception

listRemoteAddresses

String[] listRemoteAddresses(String ipAddress)
                             throws Exception
Throws:
Exception

closeConnectionsForAddress

boolean closeConnectionsForAddress(String ipAddress)
                                   throws Exception
Throws:
Exception

listConnectionIDs

String[] listConnectionIDs()
                           throws Exception
Throws:
Exception

listSessions

String[] listSessions(String connectionID)
                      throws Exception
Throws:
Exception

listPreparedTransactionDetailsAsJSON

String listPreparedTransactionDetailsAsJSON()
                                            throws Exception
Throws:
Exception

listPreparedTransactionDetailsAsHTML

String listPreparedTransactionDetailsAsHTML()
                                            throws Exception
Throws:
Exception

setContext

void setContext(Context context)

getHornetQServer

org.hornetq.core.server.HornetQServer getHornetQServer()

addAddressSettings

void addAddressSettings(String address,
                        org.hornetq.core.settings.impl.AddressSettings addressSettings)

getAddressSettings

org.hornetq.core.settings.impl.AddressSettings getAddressSettings(String address)

addSecurity

void addSecurity(String addressMatch,
                 Set<org.hornetq.core.security.Role> roles)

getSecurity

Set<org.hornetq.core.security.Role> getSecurity(String addressMatch)

getRegistry

BindingRegistry getRegistry()

setRegistry

void setRegistry(BindingRegistry registry)
Set this property if you want something other than JNDI for your registry

Parameters:
registry -


Copyright © 2012 JBoss, a division of Red Hat. All Rights Reserved.