org.apache.activemq.artemis.core.server

Interface ActiveMQServer

All Superinterfaces:

ActiveMQComponent, ServiceComponent

All Known Implementing Classes:

ActiveMQServerImpl

public interface ActiveMQServer
extends ServiceComponent

This interface defines the internal interface of the ActiveMQ Artemis Server exposed to other components of the server.

This is not part of our public API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActiveMQServer.SERVER_STATE

Method Summary

Modifier and Type	Method and Description
void	addActivationParam(String key, Object val)
boolean	addAddressInfo(AddressInfo addressInfo) Add the AddressInfo to the broker
boolean	addClientConnection(String clientId, boolean unique)
void	addExternalComponent(ActiveMQComponent externalComponent)
AddressInfo	addOrUpdateAddressInfo(AddressInfo addressInfo) A convenience method to combine the functionality of addAddressInfo and updateAddressInfo.
void	addProtocolManagerFactory(ProtocolManagerFactory factory)
AddressQueryResult	addressQuery(SimpleString name)
void	addScaledDownNode(SimpleString scaledDownNodeId)
default BindingQueryResult	bindingQuery(SimpleString address)
BindingQueryResult	bindingQuery(SimpleString address, boolean newFQQN)
void	callActivationFailureListeners(Exception e) Alert activation failure listeners of a failure.
void	callBrokerAddressPlugins(ActiveMQPluginRunnable<ActiveMQServerAddressPlugin> pluginRun)
void	callBrokerBindingPlugins(ActiveMQPluginRunnable<ActiveMQServerBindingPlugin> pluginRun)
void	callBrokerBridgePlugins(ActiveMQPluginRunnable<ActiveMQServerBridgePlugin> pluginRun)
void	callBrokerConnectionPlugins(ActiveMQPluginRunnable<ActiveMQServerConnectionPlugin> pluginRun)
void	callBrokerConsumerPlugins(ActiveMQPluginRunnable<ActiveMQServerConsumerPlugin> pluginRun)
void	callBrokerCriticalPlugins(ActiveMQPluginRunnable<ActiveMQServerCriticalPlugin> pluginRun)
void	callBrokerMessagePlugins(ActiveMQPluginRunnable<ActiveMQServerMessagePlugin> pluginRun)
void	callBrokerPlugins(ActiveMQPluginRunnable pluginRun)
void	callBrokerQueuePlugins(ActiveMQPluginRunnable<ActiveMQServerQueuePlugin> pluginRun)
void	callBrokerSessionPlugins(ActiveMQPluginRunnable<ActiveMQServerSessionPlugin> pluginRun)
void	callPostQueueCreationCallbacks(SimpleString queueName)
void	callPostQueueDeletionCallbacks(SimpleString address, SimpleString queueName)
void	checkQueueCreationLimit(String username)
void	clearAddressCache()
ActiveMQServer	createBackupServer(Configuration configuration)
PagingManager	createPagingManager()
Queue	createQueue(AddressInfo addressInfo, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, boolean autoCreateAddress)
Queue	createQueue(AddressInfo addressInfo, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue, boolean autoCreateAddress)
Queue	createQueue(AddressInfo addressInfo, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(AddressInfo addressInfo, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, SimpleString groupFirstKey, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, SimpleString groupFirstKey, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString user, SimpleString filterString, boolean durable, boolean temporary)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean ignoreIfExists, boolean transientQueue, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean ignoreIfExists, boolean transientQueue, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean lastValue, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean ignoreIfExists, boolean transientQueue, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean ignoreIfExists, boolean transientQueue, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, SimpleString groupFirstKey, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, boolean autoCreateAddress)
Queue	createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary) Deprecated.
ServerSession	createSession(String name, String username, String password, int minLargeMessageSize, RemotingConnection remotingConnection, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, boolean xa, String defaultAddress, SessionCallback callback, boolean autoCreateQueues, OperationContext context, Map<SimpleString,RoutingType> prefixes)
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable) Creates a transient queue.
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean lastValue)
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteTimeout, long autoDeleteMessageCount)
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, SimpleString groupFirstKey, boolean lastValue, SimpleString lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount)
void	deployBridge(BridgeConfiguration config)
void	deployDivert(DivertConfiguration config)
void	deployFederation(FederationConfiguration config)
Queue	deployQueue(SimpleString address, SimpleString queue, SimpleString filter, boolean durable, boolean temporary) Deprecated.
Queue	deployQueue(String address, String queue, String filter, boolean durable, boolean temporary) Deprecated.
String	describe()
void	destroyBridge(String name)
String	destroyConnectionWithSessionMetadata(String metaKey, String metaValue)
void	destroyDivert(SimpleString name)
void	destroyQueue(SimpleString queueName)
void	destroyQueue(SimpleString queueName, SecurityAuth session)
void	destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount)
void	destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers)
void	destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress)
void	destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress, boolean checkMessageCount)
void	fail(boolean failoverOnServerShutdown)
Activation	getActivation()
ActiveMQServerControlImpl	getActiveMQServerControl() Returns the resource to manage this ActiveMQ Artemis server.
AddressInfo	getAddressInfo(SimpleString address)
HierarchicalRepository<AddressSettings>	getAddressSettingsRepository()
List<ActiveMQServerAddressPlugin>	getBrokerAddressPlugins()
List<ActiveMQServerBindingPlugin>	getBrokerBindingPlugins()
List<ActiveMQServerBridgePlugin>	getBrokerBridgePlugins()
List<ActiveMQServerConnectionPlugin>	getBrokerConnectionPlugins()
List<ActiveMQServerConsumerPlugin>	getBrokerConsumerPlugins()
List<ActiveMQServerCriticalPlugin>	getBrokerCriticalPlugins()
List<ActiveMQServerMessagePlugin>	getBrokerMessagePlugins()
List<ActiveMQServerBasePlugin>	getBrokerPlugins()
List<ActiveMQServerQueuePlugin>	getBrokerQueuePlugins()
List<ActiveMQServerSessionPlugin>	getBrokerSessionPlugins()
ClusterManager	getClusterManager()
Configuration	getConfiguration()
int	getConnectionCount()
ConnectorsService	getConnectorsService()
CriticalAnalyzer	getCriticalAnalyzer()
ExecutorFactory	getExecutorFactory()
List<ActiveMQComponent>	getExternalComponents()
FederationManager	getFederationManager()
GroupingHandler	getGroupingHandler()
HAPolicy	getHAPolicy()
String	getIdentity()
String	getInternalNamingPrefix()
ExecutorFactory	getIOExecutorFactory()
ManagementService	getManagementService()
MetricsManager	getMetricsManager()
NetworkHealthCheck	getNetworkHealthCheck()
SimpleString	getNodeID()
NodeManager	getNodeManager()
PagingManager	getPagingManager()
PostOffice	getPostOffice()
QueueFactory	getQueueFactory()
ReloadManager	getReloadManager()
RemotingService	getRemotingService()
ReplicationEndpoint	getReplicationEndpoint()
ReplicationManager	getReplicationManager()
ResourceManager	getResourceManager()
ScheduledExecutorService	getScheduledPool()
ActiveMQSecurityManager	getSecurityManager()
HierarchicalRepository<Set<Role>>	getSecurityRepository()
SecurityStore	getSecurityStore()
ServiceRegistry	getServiceRegistry()
ServerSession	getSessionByID(String sessionID)
Set<ServerSession>	getSessions()
List<ServerSession>	getSessions(String connectionID)
ActiveMQServer.SERVER_STATE	getState()
StorageManager	getStorageManager()
Executor	getThreadPool()
long	getTotalConnectionCount()
long	getTotalConsumerCount()
long	getTotalMessageCount()
long	getTotalMessagesAcknowledged()
long	getTotalMessagesAdded()
String	getUptime()
long	getUptimeMillis()
Version	getVersion()
boolean	hasBrokerAddressPlugins()
boolean	hasBrokerBindingPlugins()
boolean	hasBrokerBridgePlugins()
boolean	hasBrokerConnectionPlugins()
boolean	hasBrokerConsumerPlugins()
boolean	hasBrokerCriticalPlugins()
boolean	hasBrokerMessagePlugins()
boolean	hasBrokerPlugins()
boolean	hasBrokerQueuePlugins()
boolean	hasBrokerSessionPlugins()
boolean	hasScaledDown(SimpleString scaledDownNodeId)
boolean	isActive()
boolean	isAddressBound(String address) return true if there is a binding for this address (i.e.
boolean	isReplicaSync() Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the live or backup server.
Queue	locateQueue(SimpleString queueName)
void	lockActivation() it will hold a lock for the activation.
ServerSession	lookupSession(String metakey, String metavalue)
OperationContext	newOperationContext()
QueueQueryResult	queueQuery(SimpleString name)
void	registerActivateCallback(ActivateCallback callback)
void	registerActivationFailureListener(ActivationFailureListener listener) Register a listener to detect problems during activation
void	registerBrokerPlugin(ActiveMQServerBasePlugin plugin)
void	registerBrokerPlugins(List<ActiveMQServerBasePlugin> plugins)
void	registerPostQueueCreationCallback(PostQueueCreationCallback callback)
void	registerPostQueueDeletionCallback(PostQueueDeletionCallback callback)
void	removeAddressInfo(SimpleString address, SecurityAuth auth) Remove an AddressInfo from the broker.
void	removeAddressInfo(SimpleString address, SecurityAuth auth, boolean force) Remove an AddressInfo from the broker.
void	removeClientConnection(String clientId)
void	removeProtocolManagerFactory(ProtocolManagerFactory factory)
void	removeSession(String name)
void	setGroupingHandler(GroupingHandler groupingHandler)
void	setHAPolicy(HAPolicy haPolicy)
void	setIdentity(String identity) Sets the server identity.
void	setMBeanServer(MBeanServer mBeanServer)
void	setState(ActiveMQServer.SERVER_STATE state)
void	stop(boolean failoverOnServerShutdown, boolean isExit)
void	threadDump()
void	undeployFederation(String name)
void	unlockActivation() it will release hold a lock for the activation.
void	unregisterActivateCallback(ActivateCallback callback)
void	unregisterActivationFailureListener(ActivationFailureListener listener) Remove a previously registered failure listener
void	unRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)
void	unregisterPostQueueCreationCallback(PostQueueCreationCallback callback)
void	unregisterPostQueueDeletionCallback(PostQueueDeletionCallback callback)
boolean	updateAddressInfo(SimpleString address, Collection<RoutingType> routingTypes) Deprecated.
boolean	updateAddressInfo(SimpleString address, EnumSet<RoutingType> routingTypes) Updates an AddressInfo on the broker with the specified routing types.
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers)
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive)
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, String user)
Queue	updateQueue(String name, RoutingType routingType, String filterString, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, String user)
Queue	updateQueue(String name, RoutingType routingType, String filterString, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, String groupFirstQueue, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, String user)
boolean	waitForActivation(long timeout, TimeUnit unit) Wait for server initialization.

Methods inherited from interface org.apache.activemq.artemis.core.server.ServiceComponent

stop

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

isStarted, start, stop

Method Detail

setState

void setState(ActiveMQServer.SERVER_STATE state)

getState

ActiveMQServer.SERVER_STATE getState()

setIdentity

void setIdentity(String identity)

Sets the server identity.

The identity will be exposed on logs. It may help to debug issues on the log traces and debugs.

This method was created mainly for testing but it may be used in scenarios where you need to have more than one Server inside the same VM.

getIdentity

String getIdentity()

describe

String describe()

addActivationParam

void addActivationParam(String key,
                        Object val)

getConfiguration

Configuration getConfiguration()

getServiceRegistry

ServiceRegistry getServiceRegistry()

getRemotingService

RemotingService getRemotingService()

getStorageManager

StorageManager getStorageManager()

getPagingManager

PagingManager getPagingManager()

createPagingManager

PagingManager createPagingManager()
                           throws Exception

Throws:

Exception

getManagementService

ManagementService getManagementService()

getSecurityManager

ActiveMQSecurityManager getSecurityManager()

getNetworkHealthCheck

NetworkHealthCheck getNetworkHealthCheck()

getVersion

Version getVersion()

getNodeManager

NodeManager getNodeManager()

getCriticalAnalyzer

CriticalAnalyzer getCriticalAnalyzer()

getReplicationEndpoint

ReplicationEndpoint getReplicationEndpoint()

Returns:

unlockActivation

void unlockActivation()

it will release hold a lock for the activation.

lockActivation

void lockActivation()

it will hold a lock for the activation. This will prevent the activation from happening.

getActiveMQServerControl

ActiveMQServerControlImpl getActiveMQServerControl()

Returns the resource to manage this ActiveMQ Artemis server.

Throws:

IllegalStateException - if the server is not properly started.

registerActivateCallback

void registerActivateCallback(ActivateCallback callback)

unregisterActivateCallback

void unregisterActivateCallback(ActivateCallback callback)

registerActivationFailureListener

void registerActivationFailureListener(ActivationFailureListener listener)

Register a listener to detect problems during activation

Parameters:

listener - @see org.apache.activemq.artemis.core.server.ActivationFailureListener

unregisterActivationFailureListener

void unregisterActivationFailureListener(ActivationFailureListener listener)

Remove a previously registered failure listener

Parameters:

listener -

callActivationFailureListeners

void callActivationFailureListeners(Exception e)

Alert activation failure listeners of a failure.

Parameters:

e - the exception that caused the activation failure

registerPostQueueCreationCallback

void registerPostQueueCreationCallback(PostQueueCreationCallback callback)

Parameters:

callback - PostQueueCreationCallback

unregisterPostQueueCreationCallback

void unregisterPostQueueCreationCallback(PostQueueCreationCallback callback)

Parameters:

callback - PostQueueCreationCallback

callPostQueueCreationCallbacks

void callPostQueueCreationCallbacks(SimpleString queueName)
                             throws Exception

Parameters:

queueName -

Throws:

Exception

registerPostQueueDeletionCallback

void registerPostQueueDeletionCallback(PostQueueDeletionCallback callback)

Parameters:

callback - PostQueueDeletionCallback

unregisterPostQueueDeletionCallback

void unregisterPostQueueDeletionCallback(PostQueueDeletionCallback callback)

Parameters:

callback - PostQueueDeletionCallback

callPostQueueDeletionCallbacks

void callPostQueueDeletionCallbacks(SimpleString address,
                                    SimpleString queueName)
                             throws Exception

Parameters:

queueName -

Throws:

Exception

registerBrokerPlugin

void registerBrokerPlugin(ActiveMQServerBasePlugin plugin)

unRegisterBrokerPlugin

void unRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)

registerBrokerPlugins

void registerBrokerPlugins(List<ActiveMQServerBasePlugin> plugins)

getBrokerPlugins

List<ActiveMQServerBasePlugin> getBrokerPlugins()

getBrokerConnectionPlugins

List<ActiveMQServerConnectionPlugin> getBrokerConnectionPlugins()

getBrokerSessionPlugins

List<ActiveMQServerSessionPlugin> getBrokerSessionPlugins()

getBrokerConsumerPlugins

List<ActiveMQServerConsumerPlugin> getBrokerConsumerPlugins()

getBrokerAddressPlugins

List<ActiveMQServerAddressPlugin> getBrokerAddressPlugins()

getBrokerQueuePlugins

List<ActiveMQServerQueuePlugin> getBrokerQueuePlugins()

getBrokerBindingPlugins

List<ActiveMQServerBindingPlugin> getBrokerBindingPlugins()

getBrokerMessagePlugins

List<ActiveMQServerMessagePlugin> getBrokerMessagePlugins()

getBrokerBridgePlugins

List<ActiveMQServerBridgePlugin> getBrokerBridgePlugins()

getBrokerCriticalPlugins

List<ActiveMQServerCriticalPlugin> getBrokerCriticalPlugins()

callBrokerPlugins

void callBrokerPlugins(ActiveMQPluginRunnable pluginRun)
                throws ActiveMQException

Throws:

ActiveMQException

callBrokerConnectionPlugins

void callBrokerConnectionPlugins(ActiveMQPluginRunnable<ActiveMQServerConnectionPlugin> pluginRun)
                          throws ActiveMQException

Throws:

ActiveMQException

callBrokerSessionPlugins

void callBrokerSessionPlugins(ActiveMQPluginRunnable<ActiveMQServerSessionPlugin> pluginRun)
                       throws ActiveMQException

Throws:

ActiveMQException

callBrokerConsumerPlugins

void callBrokerConsumerPlugins(ActiveMQPluginRunnable<ActiveMQServerConsumerPlugin> pluginRun)
                        throws ActiveMQException

Throws:

ActiveMQException

callBrokerAddressPlugins

void callBrokerAddressPlugins(ActiveMQPluginRunnable<ActiveMQServerAddressPlugin> pluginRun)
                       throws ActiveMQException

Throws:

ActiveMQException

callBrokerQueuePlugins

void callBrokerQueuePlugins(ActiveMQPluginRunnable<ActiveMQServerQueuePlugin> pluginRun)
                     throws ActiveMQException

Throws:

ActiveMQException

callBrokerBindingPlugins

void callBrokerBindingPlugins(ActiveMQPluginRunnable<ActiveMQServerBindingPlugin> pluginRun)
                       throws ActiveMQException

Throws:

ActiveMQException

callBrokerMessagePlugins

void callBrokerMessagePlugins(ActiveMQPluginRunnable<ActiveMQServerMessagePlugin> pluginRun)
                       throws ActiveMQException

Throws:

ActiveMQException

callBrokerBridgePlugins

void callBrokerBridgePlugins(ActiveMQPluginRunnable<ActiveMQServerBridgePlugin> pluginRun)
                      throws ActiveMQException

Throws:

ActiveMQException

callBrokerCriticalPlugins

void callBrokerCriticalPlugins(ActiveMQPluginRunnable<ActiveMQServerCriticalPlugin> pluginRun)
                        throws ActiveMQException

Throws:

ActiveMQException

hasBrokerPlugins

boolean hasBrokerPlugins()

hasBrokerConnectionPlugins

boolean hasBrokerConnectionPlugins()

hasBrokerSessionPlugins

boolean hasBrokerSessionPlugins()

hasBrokerConsumerPlugins

boolean hasBrokerConsumerPlugins()

hasBrokerAddressPlugins

boolean hasBrokerAddressPlugins()

hasBrokerQueuePlugins

boolean hasBrokerQueuePlugins()

hasBrokerBindingPlugins

boolean hasBrokerBindingPlugins()

hasBrokerMessagePlugins

boolean hasBrokerMessagePlugins()

hasBrokerBridgePlugins

boolean hasBrokerBridgePlugins()

hasBrokerCriticalPlugins

boolean hasBrokerCriticalPlugins()

checkQueueCreationLimit

void checkQueueCreationLimit(String username)
                      throws Exception

Throws:

Exception

createSession

ServerSession createSession(String name,
                            String username,
                            String password,
                            int minLargeMessageSize,
                            RemotingConnection remotingConnection,
                            boolean autoCommitSends,
                            boolean autoCommitAcks,
                            boolean preAcknowledge,
                            boolean xa,
                            String defaultAddress,
                            SessionCallback callback,
                            boolean autoCreateQueues,
                            OperationContext context,
                            Map<SimpleString,RoutingType> prefixes)
                     throws Exception

Throws:

Exception

getSecurityStore

SecurityStore getSecurityStore()

removeSession

void removeSession(String name)
            throws Exception

Throws:

Exception

getSessions

Set<ServerSession> getSessions()

getSecurityRepository

HierarchicalRepository<Set<Role>> getSecurityRepository()

getAddressSettingsRepository

HierarchicalRepository<AddressSettings> getAddressSettingsRepository()

newOperationContext

OperationContext newOperationContext()

getConnectionCount

int getConnectionCount()

getTotalConnectionCount

long getTotalConnectionCount()

getTotalMessageCount

long getTotalMessageCount()

getTotalMessagesAdded

long getTotalMessagesAdded()

getTotalMessagesAcknowledged

long getTotalMessagesAcknowledged()

getTotalConsumerCount

long getTotalConsumerCount()

getPostOffice

PostOffice getPostOffice()

clearAddressCache

void clearAddressCache()

getQueueFactory

QueueFactory getQueueFactory()

getResourceManager

ResourceManager getResourceManager()

getMetricsManager

MetricsManager getMetricsManager()

getSessions

List<ServerSession> getSessions(String connectionID)

lookupSession

ServerSession lookupSession(String metakey,
                            String metavalue)

Returns:

a session containing the meta-key and meata-value

getClusterManager

ClusterManager getClusterManager()

getNodeID

SimpleString getNodeID()

isActive

boolean isActive()

getUptime

String getUptime()

getUptimeMillis

long getUptimeMillis()

isReplicaSync

boolean isReplicaSync()

Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the live or backup server.

waitForActivation

boolean waitForActivation(long timeout,
                          TimeUnit unit)
                   throws InterruptedException

Wait for server initialization.

Parameters:

timeout -

unit -

Returns:

true if the server was already initialized or if it was initialized within the timeout period, false otherwise.

Throws:

InterruptedException

See Also:

CountDownLatch.await(long, java.util.concurrent.TimeUnit)

createSharedQueue

void createSharedQueue(SimpleString address,
                       RoutingType routingType,
                       SimpleString name,
                       SimpleString filterString,
                       SimpleString user,
                       boolean durable)
                throws Exception

Creates a transient queue. A queue that will exist as long as there are consumers. The queue will be deleted as soon as all the consumers are removed.

Notice: the queue won't be deleted until the first consumer arrives.

Parameters:

address -

name -

filterString -

durable -

Throws:

ActiveMQInvalidTransientQueueUseException - if the shared queue already exists with a different address or filterString

NullPointerException - if address is null

Exception

createSharedQueue

void createSharedQueue(SimpleString address,
                       RoutingType routingType,
                       SimpleString name,
                       SimpleString filterString,
                       SimpleString user,
                       boolean durable,
                       int maxConsumers,
                       boolean purgeOnNoConsumers,
                       boolean exclusive,
                       boolean lastValue)
                throws Exception

Throws:

Exception

createSharedQueue

void createSharedQueue(SimpleString address,
                       RoutingType routingType,
                       SimpleString name,
                       SimpleString filterString,
                       SimpleString user,
                       boolean durable,
                       int maxConsumers,
                       boolean purgeOnNoConsumers,
                       boolean exclusive,
                       boolean groupRebalance,
                       int groupBuckets,
                       boolean lastValue,
                       SimpleString lastValueKey,
                       boolean nonDestructive,
                       int consumersBeforeDispatch,
                       long delayBeforeDispatch,
                       boolean autoDelete,
                       long autoDeleteTimeout,
                       long autoDeleteMessageCount)
                throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  boolean durable,
                  boolean temporary)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString user,
                  SimpleString filterString,
                  boolean durable,
                  boolean temporary)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  boolean durable,
                  boolean temporary,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  boolean durable,
                  boolean temporary,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean exclusive,
                  boolean groupRebalance,
                  int groupBuckets,
                  boolean lastValue,
                  SimpleString lastValueKey,
                  boolean nonDestructive,
                  int consumersBeforeDispatch,
                  long delayBeforeDispatch,
                  boolean autoDelete,
                  long autoDeleteDelay,
                  long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  boolean durable,
                  boolean temporary,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean exclusive,
                  boolean groupRebalance,
                  int groupBuckets,
                  SimpleString groupFirstKey,
                  boolean lastValue,
                  SimpleString lastValueKey,
                  boolean nonDestructive,
                  int consumersBeforeDispatch,
                  long delayBeforeDispatch,
                  boolean autoDelete,
                  long autoDeleteDelay,
                  long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean lastValue,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  Boolean lastValue,
                  SimpleString lastValueKey,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  Boolean autoDelete,
                  Long autoDeleteDelay,
                  Long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  SimpleString groupFirstKey,
                  Boolean lastValue,
                  SimpleString lastValueKey,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  Boolean autoDelete,
                  Long autoDeleteDelay,
                  Long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean ignoreIfExists,
                  boolean transientQueue,
                  boolean autoCreated,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean ignoreIfExists,
                  boolean transientQueue,
                  boolean autoCreated,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean exclusive,
                  boolean lastValue,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean ignoreIfExists,
                  boolean transientQueue,
                  boolean autoCreated,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean exclusive,
                  boolean groupRebalance,
                  int groupBuckets,
                  boolean lastValue,
                  SimpleString lastValueKey,
                  boolean nonDestructive,
                  int consumersBeforeDispatch,
                  long delayBeforeDispatch,
                  boolean autoDelete,
                  long autoDeleteDelay,
                  long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  RoutingType routingType,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean ignoreIfExists,
                  boolean transientQueue,
                  boolean autoCreated,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean exclusive,
                  boolean groupRebalance,
                  int groupBuckets,
                  SimpleString groupFirstKey,
                  boolean lastValue,
                  SimpleString lastValueKey,
                  boolean nonDestructive,
                  int consumersBeforeDispatch,
                  long delayBeforeDispatch,
                  boolean autoDelete,
                  long autoDeleteDelay,
                  long autoDeleteMessageCount,
                  boolean autoCreateAddress)
           throws Exception

Throws:

Exception

createQueue

@Deprecated
Queue createQueue(SimpleString address,
                              SimpleString queueName,
                              SimpleString filter,
                              boolean durable,
                              boolean temporary)
                       throws Exception

Deprecated.

Throws:

Exception

deployQueue

@Deprecated
Queue deployQueue(String address,
                              String queue,
                              String filter,
                              boolean durable,
                              boolean temporary)
                       throws Exception

Deprecated.

Throws:

Exception

deployQueue

@Deprecated
Queue deployQueue(SimpleString address,
                              SimpleString queue,
                              SimpleString filter,
                              boolean durable,
                              boolean temporary)
                       throws Exception

Deprecated.

Throws:

Exception

createSharedQueue

void createSharedQueue(SimpleString address,
                       RoutingType routingType,
                       SimpleString name,
                       SimpleString filterString,
                       SimpleString user,
                       boolean durable,
                       int maxConsumers,
                       boolean purgeOnNoConsumers,
                       boolean exclusive,
                       boolean groupRebalance,
                       int groupBuckets,
                       SimpleString groupFirstKey,
                       boolean lastValue,
                       SimpleString lastValueKey,
                       boolean nonDestructive,
                       int consumersBeforeDispatch,
                       long delayBeforeDispatch,
                       boolean autoDelete,
                       long autoDeleteDelay,
                       long autoDeleteMessageCount)
                throws Exception

Throws:

Exception

locateQueue

Queue locateQueue(SimpleString queueName)

bindingQuery

default BindingQueryResult bindingQuery(SimpleString address)
                                 throws Exception

Throws:

Exception

bindingQuery

BindingQueryResult bindingQuery(SimpleString address,
                                boolean newFQQN)
                         throws Exception

Throws:

Exception

queueQuery

QueueQueryResult queueQuery(SimpleString name)
                     throws Exception

Throws:

Exception

addressQuery

AddressQueryResult addressQuery(SimpleString name)
                         throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
                  SecurityAuth session)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
                  SecurityAuth session,
                  boolean checkConsumerCount)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
                  SecurityAuth session,
                  boolean checkConsumerCount,
                  boolean removeConsumers)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
                  SecurityAuth session,
                  boolean checkConsumerCount,
                  boolean removeConsumers,
                  boolean autoDeleteAddress)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
                  SecurityAuth session,
                  boolean checkConsumerCount,
                  boolean removeConsumers,
                  boolean autoDeleteAddress,
                  boolean checkMessageCount)
           throws Exception

Throws:

Exception

destroyConnectionWithSessionMetadata

String destroyConnectionWithSessionMetadata(String metaKey,
                                            String metaValue)
                                     throws Exception

Throws:

Exception

getScheduledPool

ScheduledExecutorService getScheduledPool()

getExecutorFactory

ExecutorFactory getExecutorFactory()

getIOExecutorFactory

ExecutorFactory getIOExecutorFactory()

setGroupingHandler

void setGroupingHandler(GroupingHandler groupingHandler)

getGroupingHandler

GroupingHandler getGroupingHandler()

getReplicationManager

ReplicationManager getReplicationManager()

getFederationManager

FederationManager getFederationManager()

deployDivert

void deployDivert(DivertConfiguration config)
           throws Exception

Throws:

Exception

destroyDivert

void destroyDivert(SimpleString name)
            throws Exception

Throws:

Exception

getConnectorsService

ConnectorsService getConnectorsService()

deployBridge

void deployBridge(BridgeConfiguration config)
           throws Exception

Throws:

Exception

destroyBridge

void destroyBridge(String name)
            throws Exception

Throws:

Exception

deployFederation

void deployFederation(FederationConfiguration config)
               throws Exception

Throws:

Exception

undeployFederation

void undeployFederation(String name)
                 throws Exception

Throws:

Exception

getSessionByID

ServerSession getSessionByID(String sessionID)

threadDump

void threadDump()

isAddressBound

boolean isAddressBound(String address)
                throws Exception

return true if there is a binding for this address (i.e. if there is a created queue)

Parameters:

address -

Returns:

Throws:

Exception

fail

void fail(boolean failoverOnServerShutdown)
   throws Exception

Throws:

Exception

stop

void stop(boolean failoverOnServerShutdown,
          boolean isExit)
   throws Exception

Throws:

Exception

updateQueue

Queue updateQueue(String name,
                  RoutingType routingType,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers)
           throws Exception

Throws:

Exception

updateQueue

Queue updateQueue(String name,
                  RoutingType routingType,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive)
           throws Exception

Throws:

Exception

updateQueue

Queue updateQueue(String name,
                  RoutingType routingType,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  String user)
           throws Exception

Throws:

Exception

updateQueue

Queue updateQueue(String name,
                  RoutingType routingType,
                  String filterString,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  String user)
           throws Exception

Throws:

Exception

updateQueue

Queue updateQueue(String name,
                  RoutingType routingType,
                  String filterString,
                  Integer maxConsumers,
                  Boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  String groupFirstQueue,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  String user)
           throws Exception

Throws:

Exception

addProtocolManagerFactory

void addProtocolManagerFactory(ProtocolManagerFactory factory)

removeProtocolManagerFactory

void removeProtocolManagerFactory(ProtocolManagerFactory factory)

getReloadManager

ReloadManager getReloadManager()

createBackupServer

ActiveMQServer createBackupServer(Configuration configuration)

addScaledDownNode

void addScaledDownNode(SimpleString scaledDownNodeId)

hasScaledDown

boolean hasScaledDown(SimpleString scaledDownNodeId)

getActivation

Activation getActivation()

getHAPolicy

HAPolicy getHAPolicy()

setHAPolicy

void setHAPolicy(HAPolicy haPolicy)

setMBeanServer

void setMBeanServer(MBeanServer mBeanServer)

addExternalComponent

void addExternalComponent(ActiveMQComponent externalComponent)

getExternalComponents

List<ActiveMQComponent> getExternalComponents()

addClientConnection

boolean addClientConnection(String clientId,
                            boolean unique)

removeClientConnection

void removeClientConnection(String clientId)

getThreadPool

Executor getThreadPool()

getAddressInfo

AddressInfo getAddressInfo(SimpleString address)

updateAddressInfo

boolean updateAddressInfo(SimpleString address,
                          EnumSet<RoutingType> routingTypes)
                   throws Exception

Updates an AddressInfo on the broker with the specified routing types.

Parameters:

address - the name of the AddressInfo to update

routingTypes - the routing types to update the AddressInfo with

Returns:

true if the AddressInfo was updated, false otherwise

Throws:

Exception

updateAddressInfo

@Deprecated
boolean updateAddressInfo(SimpleString address,
                                      Collection<RoutingType> routingTypes)
                               throws Exception

Deprecated.

Throws:

Exception

addAddressInfo

boolean addAddressInfo(AddressInfo addressInfo)
                throws Exception

Add the AddressInfo to the broker

Parameters:

addressInfo - the AddressInfo to add

Returns:

true if the AddressInfo was added, false otherwise

Throws:

Exception

addOrUpdateAddressInfo

AddressInfo addOrUpdateAddressInfo(AddressInfo addressInfo)
                            throws Exception

A convenience method to combine the functionality of addAddressInfo and updateAddressInfo. It will add the AddressInfo object to the broker if it doesn't exist or update it if it does.

Parameters:

addressInfo - the AddressInfo to add or the info used to update the existing AddressInfo

Returns:

the resulting AddressInfo

Throws:

Exception

removeAddressInfo

void removeAddressInfo(SimpleString address,
                       SecurityAuth auth)
                throws Exception

Remove an AddressInfo from the broker.

Parameters:

address - the AddressInfo to remove

auth - authorization information; null is valid

Throws:

Exception

removeAddressInfo

void removeAddressInfo(SimpleString address,
                       SecurityAuth auth,
                       boolean force)
                throws Exception

Remove an AddressInfo from the broker.

Parameters:

address - the AddressInfo to remove

auth - authorization information; null is valid

force - It will disconnect everything from the address including queues and consumers

Throws:

Exception

getInternalNamingPrefix

String getInternalNamingPrefix()