ActiveMQServer (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

All Superinterfaces:

ActiveMQComponent

All Known Implementing Classes:

ActiveMQServerImpl
```
public interface ActiveMQServer
extends ActiveMQComponent
```
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addActivationParam(String key, Object val)`
`boolean`	`addClientConnection(String clientId, boolean unique)`
`void`	`addExternalComponent(ActiveMQComponent externalComponent)`
`void`	`addProtocolManagerFactory(ProtocolManagerFactory factory)`
`void`	`addScaledDownNode(SimpleString scaledDownNodeId)`
`BindingQueryResult`	`bindingQuery(SimpleString address)`
`void`	`callActivationFailureListeners(Exception e)` Alert activation failure listeners of a failure.
`void`	`callPostQueueCreationCallbacks(SimpleString queueName)`
`void`	`callPostQueueDeletionCallbacks(SimpleString address, SimpleString queueName)`
`void`	`checkQueueCreationLimit(String username)`
`ActiveMQServer`	`createBackupServer(Configuration configuration)`
`Queue`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable, boolean temporary)`
`Queue`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary)`
`Queue`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filter, SimpleString user, boolean durable, boolean temporary, boolean autoCreated)`
`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)`
`void`	`createSharedQueue(SimpleString address, SimpleString name, SimpleString filterString, SimpleString user, boolean durable)` Creates a transient queue.
`void`	`deployBridge(BridgeConfiguration config)`
`void`	`deployDivert(DivertConfiguration config)`
`Queue`	`deployQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable, boolean temporary)`
`Queue`	`deployQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable, boolean temporary, boolean autoCreated)`
`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)`
`Activation`	`getActivation()`
`ActiveMQServerControlImpl`	`getActiveMQServerControl()` Returns the resource to manage this ActiveMQ Artemis server.
`HierarchicalRepository<AddressSettings>`	`getAddressSettingsRepository()`
`ClusterManager`	`getClusterManager()`
`Configuration`	`getConfiguration()`
`int`	`getConnectionCount()`
`ConnectorsService`	`getConnectorsService()`
`IOCriticalErrorListener`	`getCriticalIOErrorListener()`
`ExecutorFactory`	`getExecutorFactory()`
`GroupingHandler`	`getGroupingHandler()`
`HAPolicy`	`getHAPolicy()`
`String`	`getIdentity()`
`ExecutorFactory`	`getIOExecutorFactory()`
`QueueCreator`	`getJMSDestinationCreator()`
`QueueDeleter`	`getJMSQueueDeleter()`
`ManagementService`	`getManagementService()`
`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)`
`StorageManager`	`getStorageManager()`
`long`	`getTotalConnectionCount()`
`long`	`getTotalConsumerCount()`
`long`	`getTotalMessageCount()`
`long`	`getTotalMessagesAcknowledged()`
`long`	`getTotalMessagesAdded()`
`String`	`getUptime()`
`long`	`getUptimeMillis()`
`Version`	`getVersion()`
`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`	`registerPostQueueCreationCallback(PostQueueCreationCallback callback)`
`void`	`registerPostQueueDeletionCallback(PostQueueDeletionCallback callback)`
`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`	`setJMSQueueCreator(QueueCreator queueCreator)` This is the queue creator responsible for automatic JMS Queue creations.
`void`	`setJMSQueueDeleter(QueueDeleter queueDeleter)` This is the queue deleter responsible for automatic JMS Queue deletions.
`void`	`setMBeanServer(MBeanServer mBeanServer)`
`void`	`stop(boolean failoverOnServerShutdown)`
`void`	`threadDump()`
`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`	`unregisterPostQueueCreationCallback(PostQueueCreationCallback callback)`
`void`	`unregisterPostQueueDeletionCallback(PostQueueDeletionCallback callback)`
`boolean`	`waitForActivation(long timeout, TimeUnit unit)` Wait for server initialization.

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent
isStarted, start, stop

Method Detail

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

getManagementService

ManagementService getManagementService()

getSecurityManager

ActiveMQSecurityManager getSecurityManager()

getNetworkHealthCheck

NetworkHealthCheck getNetworkHealthCheck()

getVersion
```
Version getVersion()
```

getNodeManager
```
NodeManager getNodeManager()
```

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

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

getQueueFactory
```
QueueFactory getQueueFactory()
```

getResourceManager
```
ResourceManager getResourceManager()
```

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

setJMSQueueCreator
```
void setJMSQueueCreator(QueueCreator queueCreator)
```
This is the queue creator responsible for automatic JMS Queue creations.

Parameters:

queueCreator -

getJMSDestinationCreator
```
QueueCreator getJMSDestinationCreator()
```
See Also:

setJMSQueueCreator(QueueCreator)

setJMSQueueDeleter
```
void setJMSQueueDeleter(QueueDeleter queueDeleter)
```
This is the queue deleter responsible for automatic JMS Queue deletions.

Parameters:

queueDeleter -

getJMSQueueDeleter
```
QueueDeleter getJMSQueueDeleter()
```
See Also:

setJMSQueueDeleter(QueueDeleter)

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,
                       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

createQueue

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

Throws:: Exception

createQueue

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

Throws:: Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString queueName,
                  SimpleString filter,
                  SimpleString user,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated)
           throws Exception

Throws:: Exception

deployQueue

Queue deployQueue(SimpleString address,
                  SimpleString queueName,
                  SimpleString filterString,
                  boolean durable,
                  boolean temporary)
           throws Exception

Throws:: Exception

deployQueue

Queue deployQueue(SimpleString address,
                  SimpleString queueName,
                  SimpleString filterString,
                  boolean durable,
                  boolean temporary,
                  boolean autoCreated)
           throws Exception

Throws:: Exception

locateQueue

Queue locateQueue(SimpleString queueName)

bindingQuery

BindingQueryResult bindingQuery(SimpleString address)
                         throws Exception

Throws:: Exception

queueQuery

QueueQueryResult queueQuery(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

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

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

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

stop

void stop(boolean failoverOnServerShutdown)
   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)

addClientConnection

boolean addClientConnection(String clientId,
                            boolean unique)

removeClientConnection

void removeClientConnection(String clientId)

getCriticalIOErrorListener

IOCriticalErrorListener getCriticalIOErrorListener()

Interface ActiveMQServer

Method Summary

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

Method Detail

setIdentity

getIdentity

describe

addActivationParam

getConfiguration

getServiceRegistry

getRemotingService

getStorageManager

getPagingManager

getManagementService

getSecurityManager

getNetworkHealthCheck

getVersion

getNodeManager

getReplicationEndpoint

unlockActivation

lockActivation

getActiveMQServerControl

registerActivateCallback

unregisterActivateCallback

registerActivationFailureListener

unregisterActivationFailureListener

callActivationFailureListeners

registerPostQueueCreationCallback

unregisterPostQueueCreationCallback

callPostQueueCreationCallbacks

registerPostQueueDeletionCallback

unregisterPostQueueDeletionCallback

callPostQueueDeletionCallbacks

checkQueueCreationLimit

createSession

getSecurityStore

removeSession

getSessions

getSecurityRepository

getAddressSettingsRepository

newOperationContext

getConnectionCount

getTotalConnectionCount

getTotalMessageCount

getTotalMessagesAdded

getTotalMessagesAcknowledged

getTotalConsumerCount

getPostOffice

getQueueFactory

getResourceManager

getSessions

lookupSession

getClusterManager

getNodeID

isActive

getUptime

getUptimeMillis

setJMSQueueCreator

getJMSDestinationCreator

setJMSQueueDeleter

getJMSQueueDeleter

isReplicaSync

waitForActivation

createSharedQueue

createQueue

createQueue

createQueue

deployQueue

deployQueue

locateQueue

bindingQuery

queueQuery

destroyQueue

destroyQueue

destroyQueue

destroyQueue

destroyConnectionWithSessionMetadata

getScheduledPool

getExecutorFactory

getIOExecutorFactory