Package 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	Description
static enum	ActiveMQServer.SERVER_STATE

Method Summary

Modifier and Type	Method	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, boolean start)	Adding external components is allowed only if the stateisn't ActiveMQServer.SERVER_STATE.STOPPED or ActiveMQServer.SERVER_STATE.STOPPING.
AddressInfo	addOrUpdateAddressInfo(AddressInfo addressInfo)	A convenience method to combine the functionality of addAddressInfo and updateAddressInfo.
void	addProtocolManagerFactory(ProtocolManagerFactory factory)	add a ProtocolManagerFactory to be used.
AddressQueryResult	addressQuery(SimpleString name)
void	addScaledDownNode(SimpleString scaledDownNodeId)
void	autoRemoveAddressInfo(SimpleString address, SecurityAuth auth)	Remove an AddressInfo from the broker.
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	callBrokerAMQPFederationPlugins(ActiveMQPluginRunnable<AMQPFederationBrokerPlugin> 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	callBrokerFederationPlugins(ActiveMQPluginRunnable<ActiveMQServerFederationPlugin> pluginRun)
void	callBrokerMessagePlugins(ActiveMQPluginRunnable<ActiveMQServerMessagePlugin> pluginRun)
boolean	callBrokerMessagePluginsCanAccept(ServerConsumer serverConsumer, MessageReference messageReference)
void	callBrokerPlugins(ActiveMQPluginRunnable pluginRun)
void	callBrokerQueuePlugins(ActiveMQPluginRunnable<ActiveMQServerQueuePlugin> pluginRun)
void	callBrokerResourcePlugins(ActiveMQPluginRunnable<ActiveMQServerResourcePlugin> 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)
ServerSession	createInternalSession(String name, int minLargeMessageSize, RemotingConnection remotingConnection, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, boolean xa, String defaultAddress, SessionCallback callback, boolean autoCreateQueues, OperationContext context, Map<SimpleString,RoutingType> prefixes, String securityDomain, boolean isLegacyProducer)	This is to be used in places where security is bypassed, like internal sessions, broker connections, etc...
PagingManager	createPagingManager()
Queue	createQueue(QueueConfiguration queueConfiguration)	Overloaded version of createQueue(QueueConfiguration, boolean) where the boolean parameter is always false (i.e. if the queue already exists then an exception will be thrown).
Queue	createQueue(QueueConfiguration queueConfiguration, boolean ignoreIfExists)	This method creates a queue based on the QueueConfiguration input.
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary)	Deprecated.
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreateAddress)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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, long ringSize)	Deprecated.
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString user, SimpleString filterString, boolean durable, boolean temporary)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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, long ringSize)	Deprecated.
Queue	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, boolean autoCreateAddress)	Deprecated.
Queue	createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary)	Deprecated.
Queue	createQueue(AddressInfo addressInfo, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated, Integer maxConsumers, Boolean purgeOnNoConsumers, boolean autoCreateAddress)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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, Long ringSize)	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, String securityDomain, String validatedUser, boolean isLegacyProducer)
void	createSharedQueue(QueueConfiguration queueConfiguration)	This method is essentially the same as createQueue(QueueConfiguration, boolean) with a few key exceptions.
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable)	Deprecated.
void	createSharedQueue(SimpleString address, RoutingType routingType, SimpleString name, SimpleString filterString, SimpleString user, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean lastValue)	Deprecated.
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)	Deprecated.
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)	Deprecated.
boolean	deployBridge(BridgeConfiguration config)
Divert	deployDivert(DivertConfiguration config)
void	deployFederation(FederationConfiguration config)
Queue	deployQueue(String address, String queue, String filter, boolean durable, boolean temporary)	Deprecated.
Queue	deployQueue(SimpleString address, SimpleString queue, SimpleString filter, boolean durable, boolean temporary)	Deprecated.
String	describe()
void	destroyBridge(String name)
String	destroyConnectionWithSessionMetadata(String metaKey, String metaValue)
void	destroyDivert(SimpleString name)
void	destroyDivert(SimpleString name, boolean deleteFromStorage)
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 forceAutoDeleteAddress)
void	destroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean forceAutoDeleteAddress, 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<AMQPFederationBrokerPlugin>	getBrokerAMQPFederationPlugins()
List<ActiveMQServerBindingPlugin>	getBrokerBindingPlugins()
List<ActiveMQServerBridgePlugin>	getBrokerBridgePlugins()
List<ActiveMQServerConnectionPlugin>	getBrokerConnectionPlugins()
Collection<BrokerConnection>	getBrokerConnections()
List<ActiveMQServerConsumerPlugin>	getBrokerConsumerPlugins()
List<ActiveMQServerCriticalPlugin>	getBrokerCriticalPlugins()
List<ActiveMQServerFederationPlugin>	getBrokerFederationPlugins()
List<ActiveMQServerMessagePlugin>	getBrokerMessagePlugins()
List<ActiveMQServerBasePlugin>	getBrokerPlugins()
List<ActiveMQServerQueuePlugin>	getBrokerQueuePlugins()
List<ActiveMQServerResourcePlugin>	getBrokerResourcePlugins()
List<ActiveMQServerSessionPlugin>	getBrokerSessionPlugins()
ClusterManager	getClusterManager()
Configuration	getConfiguration()
int	getConnectionCount()
ConnectionRouterManager	getConnectionRouterManager()
ConnectorsService	getConnectorsService()
CriticalAnalyzer	getCriticalAnalyzer()
double	getDiskStoreUsage()
ExecutorFactory	getExecutorFactory()
List<ActiveMQComponent>	getExternalComponents()
FederationManager	getFederationManager()
GroupingHandler	getGroupingHandler()
HAPolicy	getHAPolicy()
String	getIdentity()
String	getInternalNamingPrefix()
IOCriticalErrorListener	getIoCriticalErrorListener()	The server has a default listener that will propagate errors to registered listeners.
ExecutorFactory	getIOExecutorFactory()
ManagementService	getManagementService()
MBeanServer	getMBeanServer()
MetricsManager	getMetricsManager()
MirrorController	getMirrorController()
MirrorRegistry	getMirrorRegistry()
NetworkHealthCheck	getNetworkHealthCheck()
SimpleString	getNodeID()
NodeManager	getNodeManager()
PagingManager	getPagingManager()
int	getPendingMirrorAcks()
PostOffice	getPostOffice()
QueueFactory	getQueueFactory()
ReloadManager	getReloadManager()
RemotingService	getRemotingService()
ReplicationManager	getReplicationManager()
ResourceManager	getResourceManager()
ScheduledExecutorService	getScheduledPool()
ActiveMQSecurityManager	getSecurityManager()
HierarchicalRepository<Set<Role>>	getSecurityRepository()
SecurityStore	getSecurityStore()
ServiceRegistry	getServiceRegistry()
ServerSession	getSessionByID(String sessionID)
int	getSessionCount()
Set<ServerSession>	getSessions()
List<ServerSession>	getSessions(String connectionID)
ActiveMQServer.SERVER_STATE	getState()
default String	getStatus()
StorageManager	getStorageManager()
Executor	getThreadPool()
long	getTotalConnectionCount()
long	getTotalConsumerCount()
long	getTotalMessageCount()
long	getTotalMessagesAcknowledged()
long	getTotalMessagesAdded()
long	getTotalSessionCount()
String	getUptime()
long	getUptimeMillis()
Version	getVersion()
boolean	hasBrokerAddressPlugins()
boolean	hasBrokerAMQPFederationPlugins()
boolean	hasBrokerBindingPlugins()
boolean	hasBrokerBridgePlugins()
boolean	hasBrokerConnectionPlugins()
boolean	hasBrokerConsumerPlugins()
boolean	hasBrokerCriticalPlugins()
boolean	hasBrokerFederationPlugins()
boolean	hasBrokerMessagePlugins()
boolean	hasBrokerPlugins()
boolean	hasBrokerQueuePlugins()
boolean	hasBrokerResourcePlugins()
boolean	hasBrokerSessionPlugins()
boolean	hasScaledDown(SimpleString scaledDownNodeId)
void	installMirrorController(MirrorController mirrorController)
boolean	isActive()
boolean	isAddressBound(String address)	Returns true if there is a binding for this address (i.e. if there is a created queue).
boolean	isRebuildCounters()	should the server rebuild page counters upon startup. this will be useful on testing or an embedded broker scenario
boolean	isReplicaSync()	Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the primary or backup server.
default Queue	locateQueue(String queueName)
default Queue	locateQueue(String address, String queue)
Queue	locateQueue(SimpleString queueName)
void	lockActivation()	it will hold a lock for the activation.
ServerSession	lookupSession(String metakey, String metavalue)	Returns a session containing the meta-key and meata-value.
AutoCloseable	managementLock()
OperationContext	newOperationContext()
QueueQueryResult	queueQuery(SimpleString name)
void	registerActivateCallback(ActivateCallback callback)
void	registerActivationFailureListener(ActivationFailureListener listener)	Register a listener to detect problems during activation
void	registerBrokerConnection(BrokerConnection brokerConnection)
void	registerBrokerPlugin(ActiveMQServerBasePlugin plugin)
void	registerBrokerPlugins(List<ActiveMQServerBasePlugin> plugins)
void	registerIOCriticalErrorListener(IOCriticalErrorListener listener)	Register a listener to detect I/O Critical errors
void	registerPostQueueCreationCallback(PostQueueCreationCallback callback)	Register a PostQueueDeletionCallback to be called after a queue is created.
void	registerPostQueueDeletionCallback(PostQueueDeletionCallback callback)	Register a PostQueueDeletionCallback to be called after a queue is deleted.
void	registerQueueOnManagement(Queue queue)
void	registerRecordsLoader(Consumer<RecordInfo> recordsLoader)
void	reloadConfigurationFile()
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	removeMirrorControl()
void	removeProtocolManagerFactory(ProtocolManagerFactory factory)
void	removeSession(String name)
void	replay(Date start, Date end, String address, String target, String filter)
void	scanAddresses(MirrorController mirrorController)	This method will scan all queues and addresses. it is supposed to be called before the mirrorController is started
void	setGroupingHandler(GroupingHandler groupingHandler)
void	setHAPolicy(HAPolicy haPolicy)
void	setIdentity(String identity)	Sets the server identity.
void	setMBeanServer(MBeanServer mBeanServer)
default void	setProperties(String fileUrltoBrokerProperties)
void	setRebuildCounters(boolean rebuildCounters)	should the server rebuild page counters upon startup. this will be useful on testing or an embedded broker scenario
void	setSecurityManager(ActiveMQSecurityManager securityManager)
void	setState(ActiveMQServer.SERVER_STATE state)
void	startBrokerConnection(String name)
void	stop(boolean failoverOnServerShutdown, boolean isExit)
void	stopBrokerConnection(String name)
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	unregisterBrokerConnection(BrokerConnection brokerConnection)	Removes the given broker connection from the tracked set of active broker connection entries.
void	unRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)
void	unregisterPostQueueCreationCallback(PostQueueCreationCallback callback)	Unregister a PostQueueCreationCallback.
void	unregisterPostQueueDeletionCallback(PostQueueDeletionCallback callback)	Unregister a PostQueueDeletionCallback.
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.
Divert	updateDivert(DivertConfiguration config)
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers)	Deprecated.
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive)	Deprecated.
Queue	updateQueue(String name, RoutingType routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, String user)	Deprecated.
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)	Deprecated.
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)	Deprecated.
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, Long ringSize)	Deprecated.
Queue	updateQueue(QueueConfiguration queueConfiguration)	Update the queue named in the QueueConfiguration with the corresponding properties.
Queue	updateQueue(QueueConfiguration queueConfiguration, boolean forceUpdate)	Update a queue's configuration.
void	updateStatus(String component, String statusJson)
String	validateUser(String username, String password, RemotingConnection connection, String securityDomain)
boolean	waitForActivation(long timeout, TimeUnit unit)	Wait for server initialization.

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

asyncStop, isStarted, start, stop

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

stop

Method Details

managementLock

AutoCloseable managementLock()
                      throws Exception

Throws:

Exception

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()

installMirrorController

void installMirrorController(MirrorController mirrorController)

scanAddresses

void scanAddresses(MirrorController mirrorController)
            throws Exception

This method will scan all queues and addresses. it is supposed to be called before the mirrorController is started

Throws:

Exception

getMirrorController

MirrorController getMirrorController()

removeMirrorControl

void removeMirrorControl()

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()

updateStatus

void updateStatus(String component,
 String statusJson)

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.

getIoCriticalErrorListener

IOCriticalErrorListener getIoCriticalErrorListener()

The server has a default listener that will propagate errors to registered listeners. This will return the main listener

getActiveMQServerControl

ActiveMQServerControlImpl getActiveMQServerControl()

Returns the resource to manage this ActiveMQ Artemis server.

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

See Also:

• ActivationFailureListener

registerIOCriticalErrorListener

void registerIOCriticalErrorListener(IOCriticalErrorListener listener)

Register a listener to detect I/O Critical errors

See Also:

• IOCriticalErrorListener

replay

void replay(Date start,
 Date end,
 String address,
 String target,
 String filter)
     throws Exception

Throws:

Exception

unregisterActivationFailureListener

void unregisterActivationFailureListener(ActivationFailureListener listener)

Remove a previously registered failure 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)

Register a PostQueueDeletionCallback to be called after a queue is created.

Parameters:

callback - the PostQueueCreationCallback to call after a queue is created

unregisterPostQueueCreationCallback

void unregisterPostQueueCreationCallback(PostQueueCreationCallback callback)

Unregister a PostQueueCreationCallback.

Parameters:

callback - the PostQueueCreationCallback to unregister

callPostQueueCreationCallbacks

void callPostQueueCreationCallbacks(SimpleString queueName)
                             throws Exception

Throws:

Exception

registerPostQueueDeletionCallback

void registerPostQueueDeletionCallback(PostQueueDeletionCallback callback)

Register a PostQueueDeletionCallback to be called after a queue is deleted.

Parameters:

callback - the PostQueueDeletionCallback to call after a queue is deleted

unregisterPostQueueDeletionCallback

void unregisterPostQueueDeletionCallback(PostQueueDeletionCallback callback)

Unregister a PostQueueDeletionCallback.

Parameters:

callback - the PostQueueDeletionCallback to unregister

callPostQueueDeletionCallbacks

void callPostQueueDeletionCallbacks(SimpleString address,
 SimpleString queueName)
                             throws Exception

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()

getBrokerFederationPlugins

List<ActiveMQServerFederationPlugin> getBrokerFederationPlugins()

getBrokerAMQPFederationPlugins

List<AMQPFederationBrokerPlugin> getBrokerAMQPFederationPlugins()

getBrokerResourcePlugins

List<ActiveMQServerResourcePlugin> getBrokerResourcePlugins()

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

callBrokerMessagePluginsCanAccept

boolean callBrokerMessagePluginsCanAccept(ServerConsumer serverConsumer,
 MessageReference messageReference)
                                   throws ActiveMQException

Throws:

ActiveMQException

callBrokerBridgePlugins

void callBrokerBridgePlugins(ActiveMQPluginRunnable<ActiveMQServerBridgePlugin> pluginRun)
                      throws ActiveMQException

Throws:

ActiveMQException

callBrokerCriticalPlugins

void callBrokerCriticalPlugins(ActiveMQPluginRunnable<ActiveMQServerCriticalPlugin> pluginRun)
                        throws ActiveMQException

Throws:

ActiveMQException

callBrokerFederationPlugins

void callBrokerFederationPlugins(ActiveMQPluginRunnable<ActiveMQServerFederationPlugin> pluginRun)
                          throws ActiveMQException

Throws:

ActiveMQException

callBrokerAMQPFederationPlugins

void callBrokerAMQPFederationPlugins(ActiveMQPluginRunnable<AMQPFederationBrokerPlugin> pluginRun)
                              throws ActiveMQException

Throws:

ActiveMQException

callBrokerResourcePlugins

void callBrokerResourcePlugins(ActiveMQPluginRunnable<ActiveMQServerResourcePlugin> 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()

hasBrokerFederationPlugins

boolean hasBrokerFederationPlugins()

hasBrokerAMQPFederationPlugins

boolean hasBrokerAMQPFederationPlugins()

hasBrokerResourcePlugins

boolean hasBrokerResourcePlugins()

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,
 String securityDomain,
 String validatedUser,
 boolean isLegacyProducer)
                     throws Exception

Throws:

Exception

createInternalSession

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

This is to be used in places where security is bypassed, like internal sessions, broker connections, etc...

Throws:

Exception

isRebuildCounters

boolean isRebuildCounters()

should the server rebuild page counters upon startup. this will be useful on testing or an embedded broker scenario

setRebuildCounters

void setRebuildCounters(boolean rebuildCounters)

should the server rebuild page counters upon startup. this will be useful on testing or an embedded broker scenario

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()

getSessionCount

int getSessionCount()

getTotalSessionCount

long getTotalSessionCount()

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.

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 primary or backup server.

Returns:

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

waitForActivation

boolean waitForActivation(long timeout,
 TimeUnit unit)
                   throws InterruptedException

Wait for server initialization.

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

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

Deprecated.

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.

Throws:

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

NullPointerException - if address is null

Exception

createSharedQueue

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

Deprecated.

Throws:

Exception

createSharedQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

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

Deprecated.

Throws:

Exception

createQueue

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

Deprecated.

Throws:

Exception

createQueue

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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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,
 long ringSize)
           throws Exception

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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,
 Long ringSize)
           throws Exception

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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

Deprecated.

Throws:

Exception

createQueue

@Deprecated
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,
 long ringSize)
           throws Exception

Deprecated.

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

createQueue

Queue createQueue(QueueConfiguration queueConfiguration)
           throws Exception

Overloaded version of createQueue(QueueConfiguration, boolean) where the boolean parameter is always false (i.e. if the queue already exists then an exception will be thrown).

Throws:

Exception

See Also:

• createQueue(QueueConfiguration, boolean)

createQueue

Queue createQueue(QueueConfiguration queueConfiguration,
 boolean ignoreIfExists)
           throws Exception

This method creates a queue based on the QueueConfiguration input. See QueueConfiguration for more details on configuration specifics.

Some dynamic defaults will be enforced via address-settings for the corresponding unset properties:

• maxConsumers
• exclusive
• groupRebalance
• groupBuckets
• groupFirstKey
• lastValue
• lastValueKey
• nonDestructive
• consumersBeforeDispatch
• delayBeforeDispatch
• ringSize
• routingType
• purgeOnNoConsumers
• autoCreateAddress
• autoDelete (only set if queue was auto-created)
• autoDeleteDelay
• autoDeleteMessageCount

Parameters:

queueConfiguration - the configuration to use when creating the queue

ignoreIfExists - whether to simply return without an exception if the queue exists

Returns:

the Queue instance that was created

Throws:

Exception

createSharedQueue

void createSharedQueue(QueueConfiguration queueConfiguration)
                throws Exception

This method is essentially the same as createQueue(QueueConfiguration, boolean) with a few key exceptions.

If durable is true then:

• transient will be forced to false
• temporary will be forced to false

If durable is false then:

• transient will be forced to true
• temporary will be forced to true

> In all instances autoCreated will be forced to false and autoCreatedAddress will be forced to true.

The boolean passed to createQueue(QueueConfiguration, boolean) will always be true;

Throws:

Exception

See Also:

• createQueue(QueueConfiguration, boolean)

createSharedQueue

@Deprecated
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

Deprecated.

Throws:

Exception

locateQueue

Queue locateQueue(SimpleString queueName)

locateQueue

default Queue locateQueue(String queueName)

locateQueue

default Queue locateQueue(String address,
 String queue)
                   throws Exception

Throws:

Exception

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 forceAutoDeleteAddress)
           throws Exception

Throws:

Exception

destroyQueue

void destroyQueue(SimpleString queueName,
 SecurityAuth session,
 boolean checkConsumerCount,
 boolean removeConsumers,
 boolean forceAutoDeleteAddress,
 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

Divert deployDivert(DivertConfiguration config)
             throws Exception

Throws:

Exception

updateDivert

Divert updateDivert(DivertConfiguration config)
             throws Exception

Throws:

Exception

destroyDivert

void destroyDivert(SimpleString name)
            throws Exception

Throws:

Exception

destroyDivert

void destroyDivert(SimpleString name,
 boolean deleteFromStorage)
            throws Exception

Throws:

Exception

getConnectorsService

ConnectorsService getConnectorsService()

deployBridge

boolean 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()

registerBrokerConnection

void registerBrokerConnection(BrokerConnection brokerConnection)

unregisterBrokerConnection

void unregisterBrokerConnection(BrokerConnection brokerConnection)

Removes the given broker connection from the tracked set of active broker connection entries. Unregistering the connection results in it being forgotten and the caller is responsible for stopping the connection.

Parameters:

brokerConnection - The broker connection that should be forgotten.

startBrokerConnection

void startBrokerConnection(String name)
                    throws Exception

Throws:

Exception

stopBrokerConnection

void stopBrokerConnection(String name)
                   throws Exception

Throws:

Exception

getBrokerConnections

Collection<BrokerConnection> getBrokerConnections()

isAddressBound

boolean isAddressBound(String address)
                throws Exception

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

Returns:

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

Throws:

Exception

fail

void fail(boolean failoverOnServerShutdown)
   throws Exception

Throws:

Exception

stop

void stop(boolean failoverOnServerShutdown,
 boolean isExit)
   throws Exception

Throws:

Exception

updateQueue

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

Deprecated.

Throws:

Exception

updateQueue

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

Deprecated.

Throws:

Exception

updateQueue

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

Deprecated.

Throws:

Exception

updateQueue

@Deprecated
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

Deprecated.

Throws:

Exception

updateQueue

@Deprecated
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

Deprecated.

Throws:

Exception

updateQueue

@Deprecated
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,
 Long ringSize)
           throws Exception

Deprecated.

Throws:

Exception

updateQueue

Queue updateQueue(QueueConfiguration queueConfiguration)
           throws Exception

Update the queue named in the QueueConfiguration with the corresponding properties. Set only the properties that you wish to change from their existing values. Only the following properties can actually be updated:

• routingType
• filter
• maxConsumers
• purgeOnNoConsumers
• exclusive
• nonDestructive
• groupRebalance
• groupFirstKey
• groupBuckets
• consumersBeforeDispatch
• delayBeforeDispatch
• configurationManaged
• user
• ringSize

The other configuration attributes are immutable and will be ignored if set.

Parameters:

queueConfiguration - the QueueConfiguration to use

Returns:

the updated Queue instance

Throws:

Exception

updateQueue

Queue updateQueue(QueueConfiguration queueConfiguration,
 boolean forceUpdate)
           throws Exception

Update a queue's configuration.

Parameters:

queueConfiguration - the QueueConfiguration to use

forceUpdate - If true, no null check is performed and unset queueConfiguration values are reset to null

Returns:

the updated Queue instance

Throws:

Exception

See Also:

• updateQueue(QueueConfiguration)

addProtocolManagerFactory

void addProtocolManagerFactory(ProtocolManagerFactory factory)

add a ProtocolManagerFactory to be used. Note if Configuration.isResolveProtocols() is true then this factory will replace any factories with the same protocol

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)

getMBeanServer

MBeanServer getMBeanServer()

setSecurityManager

void setSecurityManager(ActiveMQSecurityManager securityManager)

addExternalComponent

void addExternalComponent(ActiveMQComponent externalComponent,
 boolean start)
                   throws Exception

Adding external components is allowed only if the stateisn't ActiveMQServer.SERVER_STATE.STOPPED or ActiveMQServer.SERVER_STATE.STOPPING.

It atomically starts the externalComponent while being added if start == true.

This atomicity is necessary to prevent ActiveMQComponent.stop() to stop the component right after adding it, but before starting it.

Throws:

IllegalStateException - if the state is ActiveMQServer.SERVER_STATE.STOPPED or ActiveMQServer.SERVER_STATE.STOPPING

Exception

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

autoRemoveAddressInfo

void autoRemoveAddressInfo(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

registerQueueOnManagement

void registerQueueOnManagement(Queue queue)
                        throws Exception

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()

getDiskStoreUsage

double getDiskStoreUsage()

reloadConfigurationFile

void reloadConfigurationFile()
                      throws Exception

Throws:

Exception

getConnectionRouterManager

ConnectionRouterManager getConnectionRouterManager()

validateUser

String validateUser(String username,
 String password,
 RemotingConnection connection,
 String securityDomain)
             throws Exception

Throws:

Exception

setProperties

default void setProperties(String fileUrltoBrokerProperties)

getStatus

default String getStatus()

registerRecordsLoader

void registerRecordsLoader(Consumer<RecordInfo> recordsLoader)

getMirrorRegistry

MirrorRegistry getMirrorRegistry()

getPendingMirrorAcks

int getPendingMirrorAcks()