java.lang.Object
- javax.management.StandardMBean
- - org.apache.activemq.artemis.core.management.impl.AbstractControl
  - - org.apache.activemq.artemis.core.management.impl.ActiveMQServerControlImpl

All Implemented Interfaces:: DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter, ActiveMQServerControl, NotificationListener

public class ActiveMQServerControlImpl
extends AbstractControl
implements ActiveMQServerControl, NotificationEmitter, NotificationListener

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ActiveMQServerControlImpl.QueueTextFormatter

Field Summary
- Fields inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl
  storageManager
- Fields inherited from interface org.apache.activemq.artemis.api.core.management.ActiveMQServerControl
  ADDRESS_MEMORY_USAGE_DESCRIPTION, ADDRESS_MEMORY_USAGE_PERCENTAGE_DESCRIPTION, CONNECTION_COUNT_DESCRIPTION, DISK_STORE_USAGE_DESCRIPTION, TOTAL_CONNECTION_COUNT_DESCRIPTION

Constructor Summary

Constructors
Constructor	Description
`ActiveMQServerControlImpl(PostOffice postOffice, Configuration configuration, ResourceManager resourceManager, RemotingService remotingService, ActiveMQServer messagingServer, MessageCounterManager messageCounterManager, StorageManager storageManager, NotificationBroadcasterSupport broadcaster)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	addAddressSettings(String address, String DLA, String expiryAddress, long expiryDelay, boolean lastValueQueue, int deliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageMaxCacheSize, long redeliveryDelay, double redeliveryMultiplier, long maxRedeliveryDelay, long redistributionDelay, boolean sendToDLAOnNoRoute, String addressFullMessagePolicy, long slowConsumerThreshold, long slowConsumerCheckPeriod, String slowConsumerPolicy, boolean autoCreateJmsQueues, boolean autoDeleteJmsQueues, boolean autoCreateJmsTopics, boolean autoDeleteJmsTopics)	adds a new address setting for a specific address
`void`	addAddressSettings(String address, String DLA, String expiryAddress, long expiryDelay, boolean defaultLastValueQueue, int maxDeliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageMaxCacheSize, long redeliveryDelay, double redeliveryMultiplier, long maxRedeliveryDelay, long redistributionDelay, boolean sendToDLAOnNoRoute, String addressFullMessagePolicy, long slowConsumerThreshold, long slowConsumerCheckPeriod, String slowConsumerPolicy, boolean autoCreateJmsQueues, boolean autoDeleteJmsQueues, boolean autoCreateJmsTopics, boolean autoDeleteJmsTopics, boolean autoCreateQueues, boolean autoDeleteQueues, boolean autoCreateAddresses, boolean autoDeleteAddresses)	adds a new address setting for a specific address
`void`	addAddressSettings(String address, String DLA, String expiryAddress, long expiryDelay, boolean defaultLastValueQueue, int maxDeliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageMaxCacheSize, long redeliveryDelay, double redeliveryMultiplier, long maxRedeliveryDelay, long redistributionDelay, boolean sendToDLAOnNoRoute, String addressFullMessagePolicy, long slowConsumerThreshold, long slowConsumerCheckPeriod, String slowConsumerPolicy, boolean autoCreateJmsQueues, boolean autoDeleteJmsQueues, boolean autoCreateJmsTopics, boolean autoDeleteJmsTopics, boolean autoCreateQueues, boolean autoDeleteQueues, boolean autoCreateAddresses, boolean autoDeleteAddresses, String configDeleteQueues, String configDeleteAddresses, long maxSizeBytesRejectThreshold, String defaultLastValueKey, boolean defaultNonDestructive, boolean defaultExclusiveQueue, boolean defaultGroupRebalance, int defaultGroupBuckets, String defaultGroupFirstKey, int defaultMaxConsumers, boolean defaultPurgeOnNoConsumers, int defaultConsumersBeforeDispatch, long defaultDelayBeforeDispatch, String defaultQueueRoutingType, String defaultAddressRoutingType, int defaultConsumerWindowSize, long defaultRingSize, boolean autoDeleteCreatedQueues, long autoDeleteQueuesDelay, long autoDeleteQueuesMessageCount, long autoDeleteAddressesDelay, double redeliveryCollisionAvoidanceFactor, long retroactiveMessageCount)	adds a new address setting for a specific address
`void`	addAddressSettings(String address, String DLA, String expiryAddress, long expiryDelay, boolean defaultLastValueQueue, int maxDeliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageMaxCacheSize, long redeliveryDelay, double redeliveryMultiplier, long maxRedeliveryDelay, long redistributionDelay, boolean sendToDLAOnNoRoute, String addressFullMessagePolicy, long slowConsumerThreshold, long slowConsumerCheckPeriod, String slowConsumerPolicy, boolean autoCreateJmsQueues, boolean autoDeleteJmsQueues, boolean autoCreateJmsTopics, boolean autoDeleteJmsTopics, boolean autoCreateQueues, boolean autoDeleteQueues, boolean autoCreateAddresses, boolean autoDeleteAddresses, String configDeleteQueues, String configDeleteAddresses, long maxSizeBytesRejectThreshold, String defaultLastValueKey, boolean defaultNonDestructive, boolean defaultExclusiveQueue, boolean defaultGroupRebalance, int defaultGroupBuckets, String defaultGroupFirstKey, int defaultMaxConsumers, boolean defaultPurgeOnNoConsumers, int defaultConsumersBeforeDispatch, long defaultDelayBeforeDispatch, String defaultQueueRoutingType, String defaultAddressRoutingType, int defaultConsumerWindowSize, long defaultRingSize, boolean autoDeleteCreatedQueues, long autoDeleteQueuesDelay, long autoDeleteQueuesMessageCount, long autoDeleteAddressesDelay, double redeliveryCollisionAvoidanceFactor, long retroactiveMessageCount, boolean autoCreateDeadLetterResources, String deadLetterQueuePrefix, String deadLetterQueueSuffix, boolean autoCreateExpiryResources, String expiryQueuePrefix, String expiryQueueSuffix)	adds a new address setting for a specific address
`void`	addAddressSettings(String address, String DLA, String expiryAddress, long expiryDelay, boolean defaultLastValueQueue, int maxDeliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageMaxCacheSize, long redeliveryDelay, double redeliveryMultiplier, long maxRedeliveryDelay, long redistributionDelay, boolean sendToDLAOnNoRoute, String addressFullMessagePolicy, long slowConsumerThreshold, long slowConsumerCheckPeriod, String slowConsumerPolicy, boolean autoCreateJmsQueues, boolean autoDeleteJmsQueues, boolean autoCreateJmsTopics, boolean autoDeleteJmsTopics, boolean autoCreateQueues, boolean autoDeleteQueues, boolean autoCreateAddresses, boolean autoDeleteAddresses, String configDeleteQueues, String configDeleteAddresses, long maxSizeBytesRejectThreshold, String defaultLastValueKey, boolean defaultNonDestructive, boolean defaultExclusiveQueue, boolean defaultGroupRebalance, int defaultGroupBuckets, String defaultGroupFirstKey, int defaultMaxConsumers, boolean defaultPurgeOnNoConsumers, int defaultConsumersBeforeDispatch, long defaultDelayBeforeDispatch, String defaultQueueRoutingType, String defaultAddressRoutingType, int defaultConsumerWindowSize, long defaultRingSize, boolean autoDeleteCreatedQueues, long autoDeleteQueuesDelay, long autoDeleteQueuesMessageCount, long autoDeleteAddressesDelay, double redeliveryCollisionAvoidanceFactor, long retroactiveMessageCount, boolean autoCreateDeadLetterResources, String deadLetterQueuePrefix, String deadLetterQueueSuffix, boolean autoCreateExpiryResources, String expiryQueuePrefix, String expiryQueueSuffix, long minExpiryDelay, long maxExpiryDelay, boolean enableMetrics)	adds a new address setting for a specific address
`void`	`addConnector(String name, String url)`
`void`	`addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)`
`void`	`addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles)`
`void`	`addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles, String browseRoles)`
`void`	`addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles, String browseRoles, String createAddressRoles, String deleteAddressRoles)`
`void`	`addUser(String username, String password, String roles, boolean plaintext)`	Add a user (only applicable when using the JAAS PropertiesLoginModule)
`void`	`buildSessionJSON(JsonArrayBuilder array, ServerSession sess)`
`boolean`	`closeConnectionsForAddress(String ipAddress)`	Closes all the connections of clients connected to this server which matches the specified IP address.
`boolean`	`closeConnectionsForUser(String userName)`	Closes all the connections of sessions with a matching user name.
`boolean`	`closeConnectionWithID(String ID)`	Closes the connection with the given id.
`boolean`	`closeConsumerConnectionsForAddress(String address)`	Closes all the connections of clients connected to this server which matches the specified IP address.
`boolean`	`closeConsumerWithID(String sessionID, String ID)`	Closes the consumer with the given id.
`boolean`	`closeSessionWithID(String connectionID, String ID)`	Closes the session with the given id.
`boolean`	`commitPreparedTransaction(String transactionAsBase64)`	Heuristically commits a prepared transaction.
`String`	`createAddress(String name, String routingTypes)`
`void`	`createBridge(String bridgeConfigurationAsJson)`	Create a bridge.
`void`	`createBridge(String name, String queueName, String forwardingAddress, String filterString, String transformerClassName, long retryInterval, double retryIntervalMultiplier, int initialConnectAttempts, int reconnectAttempts, boolean useDuplicateDetection, int confirmationWindowSize, int producerWindowSize, long clientFailureCheckPeriod, String staticConnectorsOrDiscoveryGroup, boolean useDiscoveryGroup, boolean ha, String user, String password)`
`void`	`createBridge(String name, String queueName, String forwardingAddress, String filterString, String transformerClassName, long retryInterval, double retryIntervalMultiplier, int initialConnectAttempts, int reconnectAttempts, boolean useDuplicateDetection, int confirmationWindowSize, long clientFailureCheckPeriod, String staticConnectorsOrDiscoveryGroup, boolean useDiscoveryGroup, boolean ha, String user, String password)`
`void`	createBridge(String name, String queueName, String forwardingAddress, String filterString, String transformerClassName, String transformerPropertiesAsJSON, long retryInterval, double retryIntervalMultiplier, int initialConnectAttempts, int reconnectAttempts, boolean useDuplicateDetection, int confirmationWindowSize, int producerWindowSize, long clientFailureCheckPeriod, String staticConnectorsOrDiscoveryGroup, boolean useDiscoveryGroup, boolean ha, String user, String password)
`void`	createBridge(String name, String queueName, String forwardingAddress, String filterString, String transformerClassName, Map<String,String> transformerProperties, long retryInterval, double retryIntervalMultiplier, int initialConnectAttempts, int reconnectAttempts, boolean useDuplicateDetection, int confirmationWindowSize, int producerWindowSize, long clientFailureCheckPeriod, String staticConnectorsOrDiscoveryGroup, boolean useDiscoveryGroup, boolean ha, String user, String password)
`void`	`createConnectorService(String name, String factoryClass, Map<String,Object> parameters)`
`void`	`createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName)`
`void`	`createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, String routingType)`
`void`	`createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, String transformerPropertiesAsJSON, String routingType)`
`void`	`createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, Map<String,String> transformerProperties, String routingType)`
`String`	`createQueue(String queueConfigurationAsJson)`	Create a queue.
`String`	`createQueue(String queueConfigurationAsJson, boolean ignoreIfExists)`	Create a queue.
`void`	`createQueue(String address, String name)`	Create a durable queue.
`void`	`createQueue(String address, String name, boolean durable)`	Create a queue.
`void`	`createQueue(String address, String name, boolean durable, String routingType)`	Create a queue.
`void`	`createQueue(String address, String name, String routingType)`	Create a durable queue.
`void`	`createQueue(String address, String name, String filterStr, boolean durable)`	Create a queue.
`void`	`createQueue(String address, String name, String filterStr, boolean durable, String routingType)`	Create a queue.
`String`	`createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreateAddress)`	Create a queue.
`String`	`createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, boolean lastValue, String lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoCreateAddress)`	Create a queue.
`String`	`createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, boolean lastValue, String lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)`	Create a queue.
`String`	`createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, String groupFirstKey, boolean lastValue, String lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress)`	Create a queue.
`String`	`createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean exclusive, boolean groupRebalance, int groupBuckets, String groupFirstKey, boolean lastValue, String lastValueKey, boolean nonDestructive, int consumersBeforeDispatch, long delayBeforeDispatch, boolean autoDelete, long autoDeleteDelay, long autoDeleteMessageCount, boolean autoCreateAddress, long ringSize)`	Create a queue.
`void`	`deleteAddress(String name)`
`void`	`deleteAddress(String name, boolean force)`
`void`	`deployQueue(String address, String name, String filterString)`	Deprecated.
`void`	`deployQueue(String address, String name, String filterStr, boolean durable)`	Deprecated.
`void`	`destroyBridge(String name)`
`void`	`destroyConnectorService(String name)`
`void`	`destroyDivert(String name)`
`void`	`destroyQueue(String name)`	Destroys the queue corresponding to the specified name.
`void`	`destroyQueue(String name, boolean removeConsumers)`	Destroys the queue corresponding to the specified name.
`void`	`destroyQueue(String name, boolean removeConsumers, boolean forceAutoDeleteAddress)`	Destroys the queue corresponding to the specified name and delete it's address if there are no other queues
`void`	`disableMessageCounters()`	Disables message counters for this server.
`void`	`enableMessageCounters()`	Enables message counters for this server.
`protected MBeanAttributeInfo[]`	`fillMBeanAttributeInfo()`
`protected MBeanOperationInfo[]`	`fillMBeanOperationInfo()`
`void`	`forceFailover()`
`boolean`	`freezeReplication()`
`Object[]`	`getAcceptors()`	Returns the acceptors configured for this server.
`String`	`getAcceptorsAsJSON()`	Returns the acceptors configured for this server using JSON serialization.
`long`	`getActivationSequence()`	Returns the current activation sequence number of this server.
`int`	`getAddressCount()`	Returns the number of addresses created on this server.
`String`	`getAddressInfo(String address)`
`long`	`getAddressMemoryUsage()`	Returns the memory used by all the addresses on broker for in-memory messages
`int`	`getAddressMemoryUsagePercentage()`	Returns the memory used by all the addresses on broker as a percentage of the global-max-size
`String[]`	`getAddressNames()`	Returns the names of the addresses created on this server.
`String`	`getAddressSettingsAsJSON(String address)`	returns the address settings as a JSON string
`long`	`getAuthenticationCacheSize()`	Returns the runtime size of the authentication cache
`long`	`getAuthorizationCacheSize()`	Returns the runtime size of the authorization cache
`String`	`getBindingsDirectory()`	Returns the file system directory used to store bindings.
`String[]`	`getBridgeNames()`
`String[]`	`getClusterConnectionNames()`	Returns the names of the cluster-connections deployed on this server.
`int`	`getConnectionCount()`	Returns the number of clients connected to this server.
`long`	`getConnectionTTLOverride()`	Returns the connection time to live.
`Object[]`	`getConnectors()`	Returns the connectors configured for this server.
`String`	`getConnectorsAsJSON()`	Returns the connectors configured for this server using JSON serialization.
`String[]`	`getConnectorServices()`
`int`	`getDiskScanPeriod()`	Returns how often the server checks for disk space usage.
`double`	`getDiskStoreUsage()`	Returns the percentage of total disk store use
`String[]`	`getDivertNames()`
`long`	`getGlobalMaxSize()`	Returns the global max bytes limit for in-memory messages.
`String`	`getHAPolicy()`
`int`	`getIDCacheSize()`	Returns the size of the cache for pre-creating message IDs.
`String[]`	`getIncomingInterceptorClassNames()`	Returns the list of interceptors used by this server for incoming messages.
`String[]`	`getInterceptorClassNames()`
`int`	`getJournalBufferSize()`	Returns the size of the internal buffer on the journal.
`int`	`getJournalBufferTimeout()`	Returns the timeout (in nanoseconds) used to flush internal buffers on the journal.
`int`	`getJournalCompactMinFiles()`	Returns the minimal number of journal files before compacting.
`int`	`getJournalCompactPercentage()`	Return the percentage of live data before compacting the journal.
`String`	`getJournalDirectory()`	Returns the file system directory used to store journal log.
`int`	`getJournalFileSize()`	Returns the size (in bytes) of each journal files.
`int`	`getJournalMaxIO()`	Returns the maximum number of write requests that can be in the AIO queue at any given time.
`int`	`getJournalMinFiles()`	Returns the number of journal files to pre-create.
`int`	`getJournalPoolFiles()`	Number of files that would be acceptable to keep on a pool
`String`	`getJournalType()`	Returns the type of journal used by this server (either `NIO` or `ASYNCIO`).
`String`	`getLargeMessagesDirectory()`	Returns the file system directory used to store large messages.
`String`	`getManagementAddress()`	Returns the management address of this server.
`String`	`getManagementNotificationAddress()`	Returns the management notification address of this server.
`int`	`getMaxDiskUsage()`	Returns the disk use max limit.
`int`	`getMessageCounterMaxDayCount()`	Returns the maximum number of days kept in memory for message counter.
`long`	`getMessageCounterSamplePeriod()`	Returns the sample period (in milliseconds) to take message counter snapshot.
`long`	`getMessageExpiryScanPeriod()`	Returns the frequency (in milliseconds) to scan messages to detect which messages have expired.
`long`	`getMessageExpiryThreadPriority()`	Deprecated.
`String`	`getNodeID()`	Returns the node ID of this server.
`MBeanNotificationInfo[]`	`getNotificationInfo()`
`String[]`	`getOutgoingInterceptorClassNames()`	Returns the list of interceptors used by this server for outgoing messages.
`String`	`getPagingDirectory()`	Returns the file system directory used to store paging files.
`int`	`getQueueCount()`	Returns the number of queues created on this server.
`String[]`	`getQueueNames()`	Returns the names of the queues created on this server.
`String[]`	`getQueueNames(String routingType)`	Returns the names of the queues created on this server with the given routing-type.
`Object[]`	`getRoles(String addressMatch)`
`String`	`getRolesAsJSON(String addressMatch)`
`int`	`getScheduledThreadPoolMaxSize()`	Returns the maximum number of threads in the scheduled thread pool.
`long`	`getSecurityInvalidationInterval()`	Returns the interval time (in milliseconds) to invalidate security credentials.
`int`	`getThreadPoolMaxSize()`	Returns the maximum number of threads in the thread pool.
`long`	`getTotalConnectionCount()`	Returns the number of clients which have connected to this server since it was started.
`long`	`getTotalConsumerCount()`	Returns the number of messages sent to this server since it was started.
`long`	`getTotalMessageCount()`	Returns the number of messages in all queues on the server.
`long`	`getTotalMessagesAcknowledged()`	Returns the number of messages sent to this server since it was started.
`long`	`getTotalMessagesAdded()`	Returns the number of messages sent to this server since it was started.
`long`	`getTransactionTimeout()`	Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.
`long`	`getTransactionTimeoutScanPeriod()`	Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.
`String`	`getUptime()`	Returns the uptime of this server.
`long`	`getUptimeMillis()`	Returns the uptime of this server.
`String`	`getVersion()`	Returns this server's version.
`boolean`	`isActive()`
`boolean`	`isAsyncConnectionExecutionEnabled()`	Returns whether code coming from connection is executed asynchronously or not.
`boolean`	`isBackup()`	Returns `true` if this server is a backup, `false` if it is a live server.
`boolean`	`isClustered()`	Returns whether this server is clustered.
`boolean`	`isCreateBindingsDir()`	Returns whether the bindings directory is created on this server startup.
`boolean`	`isCreateJournalDir()`	Returns whether the journal directory is created on this server startup.
`boolean`	`isFailoverOnServerShutdown()`	returns if clients failover on a server shutdown
`boolean`	`isJournalSyncNonTransactional()`	Returns whether the journal is synchronized when receiving non-transactional data.
`boolean`	`isJournalSyncTransactional()`	Returns whether the journal is synchronized when receiving transactional data.
`boolean`	`isMessageCounterEnabled()`	Returns whether message counter is enabled for this server.
`boolean`	`isPersistDeliveryCountBeforeDelivery()`	Returns whether delivery count is persisted before messages are delivered to the consumers.
`boolean`	`isPersistenceEnabled()`	Returns whether this server is using persistence and store data.
`boolean`	`isPersistIDCache()`	Returns whether message ID cache is persisted.
`boolean`	`isReplicaSync()`	Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the live or backup server.
`boolean`	`isSecurityEnabled()`	Returns whether security is enabled for this server.
`boolean`	`isSharedStore()`	Returns whether this server shares its data store with a corresponding live or backup server.
`boolean`	`isStarted()`	Return whether this server is started.
`boolean`	`isWildcardRoutingEnabled()`	Returns whether wildcard routing is supported by this server.
`String`	`listAddresses(String separator)`
`String`	`listAddresses(String options, int page, int pageSize)`
`String`	`listAllConsumersAsJSON()`	Lists all the consumers connected to this server.
`String`	`listAllSessionsAsJSON()`	Lists details about all sessions.
`String`	`listBindingsForAddress(String address)`
`String`	`listBrokerConnections()`
`String[]`	`listConnectionIDs()`	Lists all the IDs of the connections connected to this server.
`String`	`listConnections(String options, int page, int pageSize)`
`String`	`listConnectionsAsJSON()`	Lists all the connections connected to this server.
`String`	`listConsumers(String options, int page, int pageSize)`
`String`	`listConsumersAsJSON(String connectionID)`	Lists all the consumers which belongs to the connection specified by the connectionID.
`String[]`	`listHeuristicCommittedTransactions()`	List transactions which have been heuristically committed.
`String[]`	`listHeuristicRolledBackTransactions()`	List transactions which have been heuristically rolled back.
`String`	`listNetworkTopology()`
`String`	`listPreparedTransactionDetailsAsHTML()`	Deprecated.
`String`	`listPreparedTransactionDetailsAsHTML(TransactionDetailFactory factory)`	Deprecated.
`String`	`listPreparedTransactionDetailsAsJSON()`	List all the prepared transaction, sorted by date, oldest first, with details, in text format.
`String`	`listPreparedTransactionDetailsAsJSON(TransactionDetailFactory factory)`
`String[]`	`listPreparedTransactions()`	List all the prepared transaction, sorted by date, oldest first.
`String`	`listProducers(String options, int page, int pageSize)`
`String`	`listProducersInfoAsJSON()`
`String`	`listQueues(String options, int page, int pageSize)`
`String[]`	`listRemoteAddresses()`	Lists the addresses of all the clients connected to this address.
`String[]`	`listRemoteAddresses(String ipAddress)`	Lists the addresses of the clients connected to this address which matches the specified IP address.
`String[]`	`listSessions(String connectionID)`	Lists all the sessions IDs for the specified connection ID.
`String`	`listSessions(String options, int page, int pageSize)`
`String`	`listSessionsAsJSON(String connectionID)`	Lists details about all the sessions for the specified connection ID.
`String[]`	`listTargetAddresses(String sessionID)`
`String`	`listUser(String username)`	List the information about a user or all users if no username is supplied (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
`void`	`onNotification(Notification notification)`
`void`	`reloadConfigurationFile()`
`void`	`removeAddressSettings(String addressMatch)`
`void`	`removeConnector(String name)`
`void`	`removeNotificationListener(NotificationListener listener)`
`void`	`removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)`
`void`	`removeSecuritySettings(String addressMatch)`
`void`	`removeUser(String username)`	Remove a user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
`void`	`replay(String address, String target, String filter)`
`void`	`replay(String startScan, String endScan, String address, String target, String filter)`
`void`	`resetAllMessageCounterHistories()`	Reset histories for all message counters.
`void`	`resetAllMessageCounters()`	Reset all message counters.
`void`	`resetUser(String username, String password, String roles)`	Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
`void`	`resetUser(String username, String password, String roles, boolean plaintext)`	Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
`boolean`	`rollbackPreparedTransaction(String transactionAsBase64)`	Heuristically rolls back a prepared transaction.
`void`	`scaleDown(String connector)`
`void`	`sendQueueInfoToQueue(String queueName, String address)`
`void`	`setFailoverOnServerShutdown(boolean failoverOnServerShutdown)`	do any clients failover on a server shutdown
`void`	`setMessageCounterMaxDayCount(int count)`	Sets the maximum number of days kept in memory for message counter.
`void`	`setMessageCounterSamplePeriod(long newPeriod)`	Sets the sample period to take message counter snapshot.
`void`	`startBrokerConnection(String name)`
`void`	`stopBrokerConnection(String name)`
`String`	`updateAddress(String name, String routingTypes)`
`void`	`updateDivert(String name, String forwardingAddress, String filterString, String transformerClassName, Map<String,String> transformerProperties, String routingType)`	update a divert
`void`	`updateDuplicateIdCache(String address, Object[] ids)`
`String`	`updateQueue(String queueConfigurationAsJson)`	Update a queue.
`String`	`updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers)`	Deprecated.
`String`	`updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive)`	Deprecated.
`String`	`updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, String user)`	Update a queue
`String`	`updateQueue(String name, String routingType, String filter, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, String user)`	Update a queue
`String`	`updateQueue(String name, String routingType, String filter, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, String groupFirstKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, String user)`	Update a queue
`String`	`updateQueue(String name, String routingType, String filter, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, String groupFirstKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, String user, Long ringSize)`	Update a queue

Methods inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl
blockOnIO, clearIO, getMBeanInfo, sendMessage, tcclCall, tcclInvoke

Methods inherited from class javax.management.StandardMBean
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.api.core.management.ActiveMQServerControl
listDivertNames

Constructor Detail

ActiveMQServerControlImpl

public ActiveMQServerControlImpl(PostOffice postOffice,
                                 Configuration configuration,
                                 ResourceManager resourceManager,
                                 RemotingService remotingService,
                                 ActiveMQServer messagingServer,
                                 MessageCounterManager messageCounterManager,
                                 StorageManager storageManager,
                                 NotificationBroadcasterSupport broadcaster)
                          throws Exception

Throws:: Exception

Method Detail

isStarted
```
public boolean isStarted()
```
Description copied from interface: ActiveMQServerControl

Return whether this server is started.

Specified by:

isStarted in interface ActiveMQServerControl

getVersion
```
public String getVersion()
```
Description copied from interface: ActiveMQServerControl

Returns this server's version.

Specified by:

getVersion in interface ActiveMQServerControl

isActive
```
public boolean isActive()
```
Specified by:

isActive in interface ActiveMQServerControl

isBackup
```
public boolean isBackup()
```
Description copied from interface: ActiveMQServerControl

Returns true if this server is a backup, false if it is a live server.
If a backup server has been activated, returns false.

Specified by:

isBackup in interface ActiveMQServerControl

isSharedStore
```
public boolean isSharedStore()
```
Description copied from interface: ActiveMQServerControl

Returns whether this server shares its data store with a corresponding live or backup server.

Specified by:

isSharedStore in interface ActiveMQServerControl

getBindingsDirectory
```
public String getBindingsDirectory()
```
Description copied from interface: ActiveMQServerControl

Returns the file system directory used to store bindings.

Specified by:

getBindingsDirectory in interface ActiveMQServerControl

getInterceptorClassNames

public String[] getInterceptorClassNames()

getIncomingInterceptorClassNames
```
public String[] getIncomingInterceptorClassNames()
```
Description copied from interface: ActiveMQServerControl

Returns the list of interceptors used by this server for incoming messages.

Specified by:

getIncomingInterceptorClassNames in interface ActiveMQServerControl

See Also:

Interceptor

getOutgoingInterceptorClassNames
```
public String[] getOutgoingInterceptorClassNames()
```
Description copied from interface: ActiveMQServerControl

Returns the list of interceptors used by this server for outgoing messages.

Specified by:

getOutgoingInterceptorClassNames in interface ActiveMQServerControl

See Also:

Interceptor

getJournalPoolFiles
```
public int getJournalPoolFiles()
```
Description copied from interface: ActiveMQServerControl

Number of files that would be acceptable to keep on a pool

Specified by:

getJournalPoolFiles in interface ActiveMQServerControl

getJournalBufferSize
```
public int getJournalBufferSize()
```
Description copied from interface: ActiveMQServerControl

Returns the size of the internal buffer on the journal.

Specified by:

getJournalBufferSize in interface ActiveMQServerControl

getJournalBufferTimeout
```
public int getJournalBufferTimeout()
```
Description copied from interface: ActiveMQServerControl

Returns the timeout (in nanoseconds) used to flush internal buffers on the journal.

Specified by:

getJournalBufferTimeout in interface ActiveMQServerControl

setFailoverOnServerShutdown
```
public void setFailoverOnServerShutdown(boolean failoverOnServerShutdown)
```
Description copied from interface: ActiveMQServerControl

do any clients failover on a server shutdown

Specified by:

setFailoverOnServerShutdown in interface ActiveMQServerControl

isFailoverOnServerShutdown
```
public boolean isFailoverOnServerShutdown()
```
Description copied from interface: ActiveMQServerControl

returns if clients failover on a server shutdown

Specified by:

isFailoverOnServerShutdown in interface ActiveMQServerControl

getJournalMaxIO
```
public int getJournalMaxIO()
```
Description copied from interface: ActiveMQServerControl

Returns the maximum number of write requests that can be in the AIO queue at any given time.

Specified by:

getJournalMaxIO in interface ActiveMQServerControl

getJournalDirectory
```
public String getJournalDirectory()
```
Description copied from interface: ActiveMQServerControl

Returns the file system directory used to store journal log.

Specified by:

getJournalDirectory in interface ActiveMQServerControl

getJournalFileSize
```
public int getJournalFileSize()
```
Description copied from interface: ActiveMQServerControl

Returns the size (in bytes) of each journal files.

Specified by:

getJournalFileSize in interface ActiveMQServerControl

getJournalMinFiles
```
public int getJournalMinFiles()
```
Description copied from interface: ActiveMQServerControl

Returns the number of journal files to pre-create.

Specified by:

getJournalMinFiles in interface ActiveMQServerControl

getJournalCompactMinFiles
```
public int getJournalCompactMinFiles()
```
Description copied from interface: ActiveMQServerControl

Returns the minimal number of journal files before compacting.

Specified by:

getJournalCompactMinFiles in interface ActiveMQServerControl

getJournalCompactPercentage
```
public int getJournalCompactPercentage()
```
Description copied from interface: ActiveMQServerControl

Return the percentage of live data before compacting the journal.

Specified by:

getJournalCompactPercentage in interface ActiveMQServerControl

isPersistenceEnabled
```
public boolean isPersistenceEnabled()
```
Description copied from interface: ActiveMQServerControl

Returns whether this server is using persistence and store data.

Specified by:

isPersistenceEnabled in interface ActiveMQServerControl

getJournalType
```
public String getJournalType()
```
Description copied from interface: ActiveMQServerControl

Returns the type of journal used by this server (either NIO or ASYNCIO).

Specified by:

getJournalType in interface ActiveMQServerControl

getPagingDirectory
```
public String getPagingDirectory()
```
Description copied from interface: ActiveMQServerControl

Returns the file system directory used to store paging files.

Specified by:

getPagingDirectory in interface ActiveMQServerControl

getScheduledThreadPoolMaxSize
```
public int getScheduledThreadPoolMaxSize()
```
Description copied from interface: ActiveMQServerControl

Returns the maximum number of threads in the scheduled thread pool.

Specified by:

getScheduledThreadPoolMaxSize in interface ActiveMQServerControl

getThreadPoolMaxSize
```
public int getThreadPoolMaxSize()
```
Description copied from interface: ActiveMQServerControl

Returns the maximum number of threads in the thread pool.

Specified by:

getThreadPoolMaxSize in interface ActiveMQServerControl

getSecurityInvalidationInterval
```
public long getSecurityInvalidationInterval()
```
Description copied from interface: ActiveMQServerControl

Returns the interval time (in milliseconds) to invalidate security credentials.

Specified by:

getSecurityInvalidationInterval in interface ActiveMQServerControl

isClustered
```
public boolean isClustered()
```
Description copied from interface: ActiveMQServerControl

Returns whether this server is clustered.

Specified by:

isClustered in interface ActiveMQServerControl

isCreateBindingsDir
```
public boolean isCreateBindingsDir()
```
Description copied from interface: ActiveMQServerControl

Returns whether the bindings directory is created on this server startup.

Specified by:

isCreateBindingsDir in interface ActiveMQServerControl

isCreateJournalDir
```
public boolean isCreateJournalDir()
```
Description copied from interface: ActiveMQServerControl

Returns whether the journal directory is created on this server startup.

Specified by:

isCreateJournalDir in interface ActiveMQServerControl

isJournalSyncNonTransactional
```
public boolean isJournalSyncNonTransactional()
```
Description copied from interface: ActiveMQServerControl

Returns whether the journal is synchronized when receiving non-transactional data.

Specified by:

isJournalSyncNonTransactional in interface ActiveMQServerControl

isJournalSyncTransactional
```
public boolean isJournalSyncTransactional()
```
Description copied from interface: ActiveMQServerControl

Returns whether the journal is synchronized when receiving transactional data.

Specified by:

isJournalSyncTransactional in interface ActiveMQServerControl

isSecurityEnabled
```
public boolean isSecurityEnabled()
```
Description copied from interface: ActiveMQServerControl

Returns whether security is enabled for this server.

Specified by:

isSecurityEnabled in interface ActiveMQServerControl

isAsyncConnectionExecutionEnabled
```
public boolean isAsyncConnectionExecutionEnabled()
```
Description copied from interface: ActiveMQServerControl

Returns whether code coming from connection is executed asynchronously or not.

Specified by:

isAsyncConnectionExecutionEnabled in interface ActiveMQServerControl

getDiskScanPeriod
```
public int getDiskScanPeriod()
```
Description copied from interface: ActiveMQServerControl

Returns how often the server checks for disk space usage.

Specified by:

getDiskScanPeriod in interface ActiveMQServerControl

getMaxDiskUsage
```
public int getMaxDiskUsage()
```
Description copied from interface: ActiveMQServerControl

Returns the disk use max limit.

Specified by:

getMaxDiskUsage in interface ActiveMQServerControl

getGlobalMaxSize
```
public long getGlobalMaxSize()
```
Description copied from interface: ActiveMQServerControl

Returns the global max bytes limit for in-memory messages.

Specified by:

getGlobalMaxSize in interface ActiveMQServerControl

getAddressMemoryUsage
```
public long getAddressMemoryUsage()
```
Description copied from interface: ActiveMQServerControl

Returns the memory used by all the addresses on broker for in-memory messages

Specified by:

getAddressMemoryUsage in interface ActiveMQServerControl

getDiskStoreUsage
```
public double getDiskStoreUsage()
```
Description copied from interface: ActiveMQServerControl

Returns the percentage of total disk store use

Specified by:

getDiskStoreUsage in interface ActiveMQServerControl

getAddressMemoryUsagePercentage
```
public int getAddressMemoryUsagePercentage()
```
Description copied from interface: ActiveMQServerControl

Returns the memory used by all the addresses on broker as a percentage of the global-max-size

Specified by:

getAddressMemoryUsagePercentage in interface ActiveMQServerControl

getHAPolicy
```
public String getHAPolicy()
```
Specified by:

getHAPolicy in interface ActiveMQServerControl

getAuthenticationCacheSize
```
public long getAuthenticationCacheSize()
```
Description copied from interface: ActiveMQServerControl

Returns the runtime size of the authentication cache

Specified by:

getAuthenticationCacheSize in interface ActiveMQServerControl

getAuthorizationCacheSize
```
public long getAuthorizationCacheSize()
```
Description copied from interface: ActiveMQServerControl

Returns the runtime size of the authorization cache

Specified by:

getAuthorizationCacheSize in interface ActiveMQServerControl

freezeReplication
```
public boolean freezeReplication()
```
Specified by:

freezeReplication in interface ActiveMQServerControl

createAddress

public String createAddress(String name,
                            String routingTypes)
                     throws Exception

Specified by:: createAddress in interface ActiveMQServerControl
Throws:: Exception

updateAddress

public String updateAddress(String name,
                            String routingTypes)
                     throws Exception

Specified by:: updateAddress in interface ActiveMQServerControl
Throws:: Exception

deleteAddress
```
public void deleteAddress(String name)
                   throws Exception
```
Specified by:

deleteAddress in interface ActiveMQServerControl

Throws:

Exception

deleteAddress

public void deleteAddress(String name,
                          boolean force)
                   throws Exception

Specified by:: deleteAddress in interface ActiveMQServerControl
Throws:: Exception

deployQueue
```
@Deprecated
public void deployQueue(String address,
                        String name,
                        String filterString)
                 throws Exception
```
Deprecated.

Description copied from interface: ActiveMQServerControl

Deploy a durable queue.
If address is null it will be defaulted to name.
This method will do nothing if the queue with the given name already exists on the server.

Specified by:

deployQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

filterString - of the queue

Throws:

Exception

deployQueue
```
@Deprecated
public void deployQueue(String address,
                        String name,
                        String filterStr,
                        boolean durable)
                 throws Exception
```
Deprecated.

Description copied from interface: ActiveMQServerControl

Deploy a queue.
If address is null it will be defaulted to name.
This method will do nothing if the queue with the given name already exists on the server.

Specified by:

deployQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

filterStr - of the queue

durable - whether the queue is durable

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a durable queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name,
                        String routingType)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a durable queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

routingType - The routing type used for this address, MULTICAST or ANYCAST

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name,
                        boolean durable)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

durable - whether the queue is durable

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name,
                        boolean durable,
                        String routingType)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

durable - whether the queue is durable

routingType - The routing type used for this address, MULTICAST or ANYCAST

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name,
                        String filterStr,
                        boolean durable)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

filterStr - of the queue

durable - whether the queue is durable

Throws:

Exception

createQueue
```
public void createQueue(String address,
                        String name,
                        String filterStr,
                        boolean durable,
                        String routingType)
                 throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

name - name of the queue

filterStr - of the queue

durable - whether the queue is durable

routingType - The routing type used for this address, MULTICAST or ANYCAST

Throws:

Exception

createQueue
```
public String createQueue(String address,
                          String routingType,
                          String name,
                          String filterStr,
                          boolean durable,
                          int maxConsumers,
                          boolean purgeOnNoConsumers,
                          boolean autoCreateAddress)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

routingType - the routing type used for this address, MULTICAST or ANYCAST

name - name of the queue

filterStr - filter of the queue

durable - is the queue durable?

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

autoCreateAddress - create an address with default values should a matching address not be found

Returns:

a textual summary of the queue

Throws:

Exception

createQueue
```
public String createQueue(String address,
                          String routingType,
                          String name,
                          String filterStr,
                          boolean durable,
                          int maxConsumers,
                          boolean purgeOnNoConsumers,
                          boolean exclusive,
                          boolean groupRebalance,
                          int groupBuckets,
                          boolean lastValue,
                          String lastValueKey,
                          boolean nonDestructive,
                          int consumersBeforeDispatch,
                          long delayBeforeDispatch,
                          boolean autoCreateAddress)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

address - address to bind the queue to

routingType - the routing type used for this address, MULTICAST or ANYCAST

name - name of the queue

filterStr - filter of the queue

durable - is the queue durable?

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

lastValue - use last-value semantics

consumersBeforeDispatch - number of consumers needed before dispatch can start

delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met

autoCreateAddress - create an address with default values should a matching address not be found

Returns:

a textual summary of the queue

Throws:

Exception

createQueue

public String createQueue(String address,
                          String routingType,
                          String name,
                          String filterStr,
                          boolean durable,
                          int maxConsumers,
                          boolean purgeOnNoConsumers,
                          boolean exclusive,
                          boolean groupRebalance,
                          int groupBuckets,
                          boolean lastValue,
                          String lastValueKey,
                          boolean nonDestructive,
                          int consumersBeforeDispatch,
                          long delayBeforeDispatch,
                          boolean autoDelete,
                          long autoDeleteDelay,
                          long autoDeleteMessageCount,
                          boolean autoCreateAddress)
                   throws Exception

Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:: createQueue in interface ActiveMQServerControl
Parameters:: address - address to bind the queue to; routingType - the routing type used for this address, MULTICAST or ANYCAST; name - name of the queue; filterStr - filter of the queue; durable - is the queue durable?; maxConsumers - the maximum number of consumers allowed on this queue at any one time; purgeOnNoConsumers - delete this queue when the last consumer disconnects; exclusive - if the queue should route exclusively to one consumer; lastValue - use last-value semantics; consumersBeforeDispatch - number of consumers needed before dispatch can start; delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met; autoCreateAddress - create an address with default values should a matching address not be found
Returns:: a textual summary of the queue
Throws:: Exception

createQueue

public String createQueue(String address,
                          String routingType,
                          String name,
                          String filterStr,
                          boolean durable,
                          int maxConsumers,
                          boolean purgeOnNoConsumers,
                          boolean exclusive,
                          boolean groupRebalance,
                          int groupBuckets,
                          String groupFirstKey,
                          boolean lastValue,
                          String lastValueKey,
                          boolean nonDestructive,
                          int consumersBeforeDispatch,
                          long delayBeforeDispatch,
                          boolean autoDelete,
                          long autoDeleteDelay,
                          long autoDeleteMessageCount,
                          boolean autoCreateAddress)
                   throws Exception

Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:: createQueue in interface ActiveMQServerControl
Parameters:: address - address to bind the queue to; routingType - the routing type used for this address, MULTICAST or ANYCAST; name - name of the queue; filterStr - filter of the queue; durable - is the queue durable?; maxConsumers - the maximum number of consumers allowed on this queue at any one time; purgeOnNoConsumers - delete this queue when the last consumer disconnects; exclusive - if the queue should route exclusively to one consumer; lastValue - use last-value semantics; consumersBeforeDispatch - number of consumers needed before dispatch can start; delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met; autoCreateAddress - create an address with default values should a matching address not be found
Returns:: a textual summary of the queue
Throws:: Exception

createQueue

public String createQueue(String address,
                          String routingType,
                          String name,
                          String filterStr,
                          boolean durable,
                          int maxConsumers,
                          boolean purgeOnNoConsumers,
                          boolean exclusive,
                          boolean groupRebalance,
                          int groupBuckets,
                          String groupFirstKey,
                          boolean lastValue,
                          String lastValueKey,
                          boolean nonDestructive,
                          int consumersBeforeDispatch,
                          long delayBeforeDispatch,
                          boolean autoDelete,
                          long autoDeleteDelay,
                          long autoDeleteMessageCount,
                          boolean autoCreateAddress,
                          long ringSize)
                   throws Exception

Description copied from interface: ActiveMQServerControl

Create a queue.
If address is null it will be defaulted to name.
This method throws a ActiveMQQueueExistsException) exception if the queue already exits.

Specified by:: createQueue in interface ActiveMQServerControl
Parameters:: address - address to bind the queue to; routingType - the routing type used for this address, MULTICAST or ANYCAST; name - name of the queue; filterStr - filter of the queue; durable - is the queue durable?; maxConsumers - the maximum number of consumers allowed on this queue at any one time; purgeOnNoConsumers - delete this queue when the last consumer disconnects; exclusive - if the queue should route exclusively to one consumer; lastValue - use last-value semantics; consumersBeforeDispatch - number of consumers needed before dispatch can start; delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met; autoCreateAddress - create an address with default values should a matching address not be found; ringSize - the size this queue should maintain according to ring semantics
Returns:: a textual summary of the queue
Throws:: Exception

createQueue
```
public String createQueue(String queueConfigurationAsJson)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
This method throws a ActiveMQQueueExistsException) exception if the queue already exists.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

queueConfigurationAsJson - the configuration of the queue in JSON format

Returns:

the configuration of the created queue in JSON format

Throws:

Exception

createQueue
```
public String createQueue(String queueConfigurationAsJson,
                          boolean ignoreIfExists)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a queue.
This method throws a ActiveMQQueueExistsException) exception if the queue already exists and ignoreIfExists is false.

Specified by:

createQueue in interface ActiveMQServerControl

Parameters:

queueConfigurationAsJson - the configuration of the queue in JSON format

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

Returns:

the configuration of the created queue in JSON format

Throws:

Exception

updateQueue
```
public String updateQueue(String queueConfigurationAsJson)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Update a queue.

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

queueConfigurationAsJson - the configuration of the queue in JSON format

Returns:

the configuration of the created queue in JSON format

Throws:

Exception

updateQueue
```
@Deprecated
public String updateQueue(String name,
                          String routingType,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers)
                   throws Exception
```
Deprecated.

Description copied from interface: ActiveMQServerControl

Update a queue.

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

Returns:

a textual summary of the queue

Throws:

Exception

updateQueue
```
@Deprecated
public String updateQueue(String name,
                          String routingType,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers,
                          Boolean exclusive)
                   throws Exception
```
Deprecated.

Description copied from interface: ActiveMQServerControl

Update a queue.

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

Returns:

a textual summary of the queue

Throws:

Exception

updateQueue
```
public String updateQueue(String name,
                          String routingType,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers,
                          Boolean exclusive,
                          String user)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Update a queue

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

user - the user associated with this queue

Returns:

Throws:

Exception

updateQueue
```
public String updateQueue(String name,
                          String routingType,
                          String filter,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers,
                          Boolean exclusive,
                          Boolean groupRebalance,
                          Integer groupBuckets,
                          Boolean nonDestructive,
                          Integer consumersBeforeDispatch,
                          Long delayBeforeDispatch,
                          String user)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Update a queue

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

filter - the filter to use on the queue

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

groupRebalance - if the queue should rebalance groups when a consumer is added

groupBuckets - number of buckets that should be used for message groups, -1 (default) is unlimited, and groups by raw key instead

nonDestructive - If the queue is non-destructive

consumersBeforeDispatch - number of consumers needed before dispatch can start

delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met

user - the user associated with this queue

Returns:

Throws:

Exception

updateQueue
```
public String updateQueue(String name,
                          String routingType,
                          String filter,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers,
                          Boolean exclusive,
                          Boolean groupRebalance,
                          Integer groupBuckets,
                          String groupFirstKey,
                          Boolean nonDestructive,
                          Integer consumersBeforeDispatch,
                          Long delayBeforeDispatch,
                          String user)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Update a queue

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

filter - the filter to use on the queue

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

groupRebalance - if the queue should rebalance groups when a consumer is added

groupBuckets - number of buckets that should be used for message groups, -1 (default) is unlimited, and groups by raw key instead

groupFirstKey - key used to mark a message is first in a group for a consumer

nonDestructive - If the queue is non-destructive

consumersBeforeDispatch - number of consumers needed before dispatch can start

delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met

user - the user associated with this queue

Returns:

Throws:

Exception

updateQueue
```
public String updateQueue(String name,
                          String routingType,
                          String filter,
                          Integer maxConsumers,
                          Boolean purgeOnNoConsumers,
                          Boolean exclusive,
                          Boolean groupRebalance,
                          Integer groupBuckets,
                          String groupFirstKey,
                          Boolean nonDestructive,
                          Integer consumersBeforeDispatch,
                          Long delayBeforeDispatch,
                          String user,
                          Long ringSize)
                   throws Exception
```
Description copied from interface: ActiveMQServerControl

Update a queue

Specified by:

updateQueue in interface ActiveMQServerControl

Parameters:

name - name of the queue

routingType - the routing type used for this address, MULTICAST or ANYCAST

filter - the filter to use on the queue

maxConsumers - the maximum number of consumers allowed on this queue at any one time

purgeOnNoConsumers - delete this queue when the last consumer disconnects

exclusive - if the queue should route exclusively to one consumer

groupRebalance - if the queue should rebalance groups when a consumer is added

groupBuckets - number of buckets that should be used for message groups, -1 (default) is unlimited, and groups by raw key instead

groupFirstKey - key used to mark a message is first in a group for a consumer

nonDestructive - If the queue is non-destructive

consumersBeforeDispatch - number of consumers needed before dispatch can start

delayBeforeDispatch - delay to wait before dispatching if number of consumers before dispatch is not met

user - the user associated with this queue

ringSize - the size this queue should maintain according to ring semantics

Returns:

Throws:

Exception

getQueueCount
```
public int getQueueCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of queues created on this server.

Specified by:

getQueueCount in interface ActiveMQServerControl

getQueueNames
```
public String[] getQueueNames()
```
Description copied from interface: ActiveMQServerControl

Returns the names of the queues created on this server.

Specified by:

getQueueNames in interface ActiveMQServerControl

getQueueNames
```
public String[] getQueueNames(String routingType)
```
Description copied from interface: ActiveMQServerControl

Returns the names of the queues created on this server with the given routing-type.

Specified by:

getQueueNames in interface ActiveMQServerControl

getClusterConnectionNames
```
public String[] getClusterConnectionNames()
```
Description copied from interface: ActiveMQServerControl

Returns the names of the cluster-connections deployed on this server.

Specified by:

getClusterConnectionNames in interface ActiveMQServerControl

getUptime
```
public String getUptime()
```
Description copied from interface: ActiveMQServerControl

Returns the uptime of this server.

Specified by:

getUptime in interface ActiveMQServerControl

getUptimeMillis
```
public long getUptimeMillis()
```
Description copied from interface: ActiveMQServerControl

Returns the uptime of this server.

Specified by:

getUptimeMillis in interface ActiveMQServerControl

isReplicaSync
```
public boolean isReplicaSync()
```
Description copied from interface: ActiveMQServerControl

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

Specified by:

isReplicaSync in interface ActiveMQServerControl

getAddressCount
```
public int getAddressCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of addresses created on this server.

Specified by:

getAddressCount in interface ActiveMQServerControl

getAddressNames
```
public String[] getAddressNames()
```
Description copied from interface: ActiveMQServerControl

Returns the names of the addresses created on this server.

Specified by:

getAddressNames in interface ActiveMQServerControl

destroyQueue
```
public void destroyQueue(String name,
                         boolean removeConsumers,
                         boolean forceAutoDeleteAddress)
                  throws Exception
```
Description copied from interface: ActiveMQServerControl

Destroys the queue corresponding to the specified name and delete it's address if there are no other queues

Specified by:

destroyQueue in interface ActiveMQServerControl

Throws:

Exception

destroyQueue
```
public void destroyQueue(String name,
                         boolean removeConsumers)
                  throws Exception
```
Description copied from interface: ActiveMQServerControl

Destroys the queue corresponding to the specified name.

Specified by:

destroyQueue in interface ActiveMQServerControl

Throws:

Exception

destroyQueue
```
public void destroyQueue(String name)
                  throws Exception
```
Description copied from interface: ActiveMQServerControl

Destroys the queue corresponding to the specified name.

Specified by:

destroyQueue in interface ActiveMQServerControl

Throws:

Exception

getAddressInfo

public String getAddressInfo(String address)
                      throws ActiveMQAddressDoesNotExistException

Specified by:: getAddressInfo in interface ActiveMQServerControl
Throws:: ActiveMQAddressDoesNotExistException

listBindingsForAddress

public String listBindingsForAddress(String address)
                              throws Exception

Specified by:: listBindingsForAddress in interface ActiveMQServerControl
Throws:: Exception

listAddresses

public String listAddresses(String separator)
                     throws Exception

Specified by:: listAddresses in interface ActiveMQServerControl
Throws:: Exception

getConnectionCount
```
public int getConnectionCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of clients connected to this server.

Specified by:

getConnectionCount in interface ActiveMQServerControl

getTotalConnectionCount
```
public long getTotalConnectionCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of clients which have connected to this server since it was started.

Specified by:

getTotalConnectionCount in interface ActiveMQServerControl

getTotalMessageCount
```
public long getTotalMessageCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of messages in all queues on the server.

Specified by:

getTotalMessageCount in interface ActiveMQServerControl

getTotalMessagesAdded
```
public long getTotalMessagesAdded()
```
Description copied from interface: ActiveMQServerControl

Returns the number of messages sent to this server since it was started.

Specified by:

getTotalMessagesAdded in interface ActiveMQServerControl

getTotalMessagesAcknowledged
```
public long getTotalMessagesAcknowledged()
```
Description copied from interface: ActiveMQServerControl

Returns the number of messages sent to this server since it was started.

Specified by:

getTotalMessagesAcknowledged in interface ActiveMQServerControl

getTotalConsumerCount
```
public long getTotalConsumerCount()
```
Description copied from interface: ActiveMQServerControl

Returns the number of messages sent to this server since it was started.

Specified by:

getTotalConsumerCount in interface ActiveMQServerControl

enableMessageCounters
```
public void enableMessageCounters()
```
Description copied from interface: ActiveMQServerControl

Enables message counters for this server.

Specified by:

enableMessageCounters in interface ActiveMQServerControl

disableMessageCounters
```
public void disableMessageCounters()
```
Description copied from interface: ActiveMQServerControl

Disables message counters for this server.

Specified by:

disableMessageCounters in interface ActiveMQServerControl

resetAllMessageCounters
```
public void resetAllMessageCounters()
```
Description copied from interface: ActiveMQServerControl

Reset all message counters.

Specified by:

resetAllMessageCounters in interface ActiveMQServerControl

resetAllMessageCounterHistories
```
public void resetAllMessageCounterHistories()
```
Description copied from interface: ActiveMQServerControl

Reset histories for all message counters.

Specified by:

resetAllMessageCounterHistories in interface ActiveMQServerControl

isMessageCounterEnabled
```
public boolean isMessageCounterEnabled()
```
Description copied from interface: ActiveMQServerControl

Returns whether message counter is enabled for this server.

Specified by:

isMessageCounterEnabled in interface ActiveMQServerControl

getMessageCounterSamplePeriod
```
public long getMessageCounterSamplePeriod()
```
Description copied from interface: ActiveMQServerControl

Returns the sample period (in milliseconds) to take message counter snapshot.

Specified by:

getMessageCounterSamplePeriod in interface ActiveMQServerControl

setMessageCounterSamplePeriod
```
public void setMessageCounterSamplePeriod(long newPeriod)
```
Description copied from interface: ActiveMQServerControl

Sets the sample period to take message counter snapshot.

Specified by:

setMessageCounterSamplePeriod in interface ActiveMQServerControl

Parameters:

newPeriod - value must be greater than 1000ms

getMessageCounterMaxDayCount
```
public int getMessageCounterMaxDayCount()
```
Description copied from interface: ActiveMQServerControl

Returns the maximum number of days kept in memory for message counter.

Specified by:

getMessageCounterMaxDayCount in interface ActiveMQServerControl

setMessageCounterMaxDayCount
```
public void setMessageCounterMaxDayCount(int count)
```
Description copied from interface: ActiveMQServerControl

Sets the maximum number of days kept in memory for message counter.

Specified by:

setMessageCounterMaxDayCount in interface ActiveMQServerControl

Parameters:

count - value must be greater than 0

listPreparedTransactions
```
public String[] listPreparedTransactions()
```
Description copied from interface: ActiveMQServerControl

List all the prepared transaction, sorted by date, oldest first.
The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Specified by:

listPreparedTransactions in interface ActiveMQServerControl

See Also:

ActiveMQServerControl.commitPreparedTransaction(String), ActiveMQServerControl.rollbackPreparedTransaction(String)

listPreparedTransactionDetailsAsJSON
```
public String listPreparedTransactionDetailsAsJSON()
                                            throws Exception
```
Description copied from interface: ActiveMQServerControl

List all the prepared transaction, sorted by date, oldest first, with details, in text format.

Specified by:

listPreparedTransactionDetailsAsJSON in interface ActiveMQServerControl

Throws:

Exception

listPreparedTransactionDetailsAsJSON

public String listPreparedTransactionDetailsAsJSON(TransactionDetailFactory factory)
                                            throws Exception

Throws:: Exception

listPreparedTransactionDetailsAsHTML
```
@Deprecated
public String listPreparedTransactionDetailsAsHTML()
                                            throws Exception
```
Deprecated.

Description copied from interface: ActiveMQServerControl

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format

Specified by:

listPreparedTransactionDetailsAsHTML in interface ActiveMQServerControl

Throws:

Exception

listPreparedTransactionDetailsAsHTML

@Deprecated
public String listPreparedTransactionDetailsAsHTML(TransactionDetailFactory factory)
                                            throws Exception

Deprecated.

Throws:: Exception

listHeuristicCommittedTransactions
```
public String[] listHeuristicCommittedTransactions()
```
Description copied from interface: ActiveMQServerControl

List transactions which have been heuristically committed.

Specified by:

listHeuristicCommittedTransactions in interface ActiveMQServerControl

listHeuristicRolledBackTransactions
```
public String[] listHeuristicRolledBackTransactions()
```
Description copied from interface: ActiveMQServerControl

List transactions which have been heuristically rolled back.

Specified by:

listHeuristicRolledBackTransactions in interface ActiveMQServerControl

commitPreparedTransaction
```
public boolean commitPreparedTransaction(String transactionAsBase64)
                                  throws Exception
```
Description copied from interface: ActiveMQServerControl

Heuristically commits a prepared transaction.

Specified by:

commitPreparedTransaction in interface ActiveMQServerControl

Parameters:

transactionAsBase64 - base 64 representation of a prepare transaction

Returns:

true if the transaction was successfully committed, false else

Throws:

Exception

See Also:

ActiveMQServerControl.listPreparedTransactions()

rollbackPreparedTransaction
```
public boolean rollbackPreparedTransaction(String transactionAsBase64)
                                    throws Exception
```
Description copied from interface: ActiveMQServerControl

Heuristically rolls back a prepared transaction.

Specified by:

rollbackPreparedTransaction in interface ActiveMQServerControl

Parameters:

transactionAsBase64 - base 64 representation of a prepare transaction

Returns:

true if the transaction was successfully rolled back, false else

Throws:

Exception

See Also:

ActiveMQServerControl.listPreparedTransactions()

listRemoteAddresses
```
public String[] listRemoteAddresses()
```
Description copied from interface: ActiveMQServerControl

Lists the addresses of all the clients connected to this address.

Specified by:

listRemoteAddresses in interface ActiveMQServerControl

listRemoteAddresses
```
public String[] listRemoteAddresses(String ipAddress)
```
Description copied from interface: ActiveMQServerControl

Lists the addresses of the clients connected to this address which matches the specified IP address.

Specified by:

listRemoteAddresses in interface ActiveMQServerControl

closeConnectionsForAddress
```
public boolean closeConnectionsForAddress(String ipAddress)
```
Description copied from interface: ActiveMQServerControl

Closes all the connections of clients connected to this server which matches the specified IP address.

Specified by:

closeConnectionsForAddress in interface ActiveMQServerControl

closeConsumerConnectionsForAddress
```
public boolean closeConsumerConnectionsForAddress(String address)
```
Description copied from interface: ActiveMQServerControl

Closes all the connections of clients connected to this server which matches the specified IP address.

Specified by:

closeConsumerConnectionsForAddress in interface ActiveMQServerControl

closeConnectionsForUser
```
public boolean closeConnectionsForUser(String userName)
```
Description copied from interface: ActiveMQServerControl

Closes all the connections of sessions with a matching user name.

Specified by:

closeConnectionsForUser in interface ActiveMQServerControl

closeConnectionWithID
```
public boolean closeConnectionWithID(String ID)
```
Description copied from interface: ActiveMQServerControl

Closes the connection with the given id.

Specified by:

closeConnectionWithID in interface ActiveMQServerControl

closeSessionWithID

public boolean closeSessionWithID(String connectionID,
                                  String ID)
                           throws Exception

Description copied from interface: ActiveMQServerControl

Closes the session with the given id.

Specified by:: closeSessionWithID in interface ActiveMQServerControl
Throws:: Exception

closeConsumerWithID
```
public boolean closeConsumerWithID(String sessionID,
                                   String ID)
                            throws Exception
```
Description copied from interface: ActiveMQServerControl

Closes the consumer with the given id.

Specified by:

closeConsumerWithID in interface ActiveMQServerControl

Throws:

Exception

listConnectionIDs
```
public String[] listConnectionIDs()
```
Description copied from interface: ActiveMQServerControl

Lists all the IDs of the connections connected to this server.

Specified by:

listConnectionIDs in interface ActiveMQServerControl

listSessions
```
public String[] listSessions(String connectionID)
```
Description copied from interface: ActiveMQServerControl

Lists all the sessions IDs for the specified connection ID.

Specified by:

listSessions in interface ActiveMQServerControl

listProducersInfoAsJSON
```
public String listProducersInfoAsJSON()
                               throws Exception
```
Specified by:

listProducersInfoAsJSON in interface ActiveMQServerControl

Throws:

Exception

listConnections

public String listConnections(String options,
                              int page,
                              int pageSize)
                       throws Exception

Specified by:: listConnections in interface ActiveMQServerControl
Throws:: Exception

listSessions

public String listSessions(String options,
                           int page,
                           int pageSize)
                    throws Exception

Specified by:: listSessions in interface ActiveMQServerControl
Throws:: Exception

listConsumers

public String listConsumers(String options,
                            int page,
                            int pageSize)
                     throws Exception

Specified by:: listConsumers in interface ActiveMQServerControl
Throws:: Exception

listAddresses

public String listAddresses(String options,
                            int page,
                            int pageSize)
                     throws Exception

Specified by:: listAddresses in interface ActiveMQServerControl
Throws:: Exception

listQueues

public String listQueues(String options,
                         int page,
                         int pageSize)
                  throws Exception

Specified by:: listQueues in interface ActiveMQServerControl
Throws:: Exception

listProducers

public String listProducers(String options,
                            int page,
                            int pageSize)
                     throws Exception

Specified by:: listProducers in interface ActiveMQServerControl
Throws:: Exception

listConnectionsAsJSON

public String listConnectionsAsJSON()
                             throws Exception

Description copied from interface: ActiveMQServerControl

Lists all the connections connected to this server. The returned String is a JSON string containing details about each connection, e.g.:

 [
   {
     "creationTime": 1469240429671,
     "sessionCount": 1,
     "implementation": "RemotingConnectionImpl",
     "connectionID": "1648309901",
     "clientAddress": "\/127.0.0.1:57649"
   }
 ]

Specified by:: listConnectionsAsJSON in interface ActiveMQServerControl
Throws:: Exception

listSessionsAsJSON
```
public String listSessionsAsJSON(String connectionID)
                          throws Exception
```
Description copied from interface: ActiveMQServerControl
Lists details about all the sessions for the specified connection ID. The returned String is a JSON string containing details about each session associated with the specified ID, e.g.:
```
 [
   {
     "principal": "myUser",
     "creationTime": 1469240773157,
     "consumerCount": 0,
     "sessionID": "d33d10db-507c-11e6-9e47-e8b1fc439540"
   }
 ]
 
```
Specified by:

listSessionsAsJSON in interface ActiveMQServerControl

Throws:

Exception

listAllSessionsAsJSON

public String listAllSessionsAsJSON()
                             throws Exception

Description copied from interface: ActiveMQServerControl

Lists details about all sessions. The returned String is a JSON string containing details about each and every session, e.g.:

 [
   {
     "sessionID":"e71d61d7-2176-11e8-9057-a0afbd82eaba",
     "creationTime":1520365520212,
     "consumerCount":1,
     "principal":"myUser"
   },
   {
     "sessionID":"e718a6e6-2176-11e8-9057-a0afbd82eaba",
     "creationTime":1520365520191,
     "consumerCount":0,
     "principal":"guest"
   }
 ]

Specified by:: listAllSessionsAsJSON in interface ActiveMQServerControl
Throws:: Exception

buildSessionJSON

public void buildSessionJSON(JsonArrayBuilder array,
                             ServerSession sess)

listConsumersAsJSON

public String listConsumersAsJSON(String connectionID)
                           throws Exception

Description copied from interface: ActiveMQServerControl

Lists all the consumers which belongs to the connection specified by the connectionID. The returned String is a JSON string containing details about each consumer, e.g.:

 [
   {
     "filter": "color = 'RED'",
     "queueName": "2ea5b050-28bf-4ee2-9b24-b73f5983192a",
     "creationTime": 1469239602459,
     "deliveringCount": 0,
     "consumerID": 1,
     "browseOnly": true,
     "connectionID": "1963ece3-507a-11e6-94ff-e8b1fc439540",
     "sessionID": "19676f55-507a-11e6-94ff-e8b1fc439540"
   }
 ]

Specified by:: listConsumersAsJSON in interface ActiveMQServerControl
Throws:: Exception

listAllConsumersAsJSON

public String listAllConsumersAsJSON()
                              throws Exception

Description copied from interface: ActiveMQServerControl

Lists all the consumers connected to this server. The returned String is a JSON string containing details about each consumer, e.g.:

 [
   {
     "queueName": "fa87c64c-0a38-4697-8421-72e34d17429d",
     "creationTime": 1469235956168,
     "deliveringCount": 0,
     "consumerID": 0,
     "browseOnly": false,
     "connectionID": "9c0d42e7-5071-11e6-9e29-e8b1fc439540",
     "sessionID": "9c0d9109-5071-11e6-9e29-e8b1fc439540"
   }
 ]

Specified by:: listAllConsumersAsJSON in interface ActiveMQServerControl
Throws:: Exception

getConnectors
```
public Object[] getConnectors()
                       throws Exception
```
Description copied from interface: ActiveMQServerControl

Returns the connectors configured for this server.

Specified by:

getConnectors in interface ActiveMQServerControl

Throws:

Exception

getAcceptors
```
public Object[] getAcceptors()
                      throws Exception
```
Description copied from interface: ActiveMQServerControl

Returns the acceptors configured for this server.

Specified by:

getAcceptors in interface ActiveMQServerControl

Throws:

Exception

getConnectorsAsJSON
```
public String getConnectorsAsJSON()
                           throws Exception
```
Description copied from interface: ActiveMQServerControl

Returns the connectors configured for this server using JSON serialization.

Specified by:

getConnectorsAsJSON in interface ActiveMQServerControl

Throws:

Exception

getAcceptorsAsJSON
```
public String getAcceptorsAsJSON()
                          throws Exception
```
Description copied from interface: ActiveMQServerControl

Returns the acceptors configured for this server using JSON serialization.

Specified by:

getAcceptorsAsJSON in interface ActiveMQServerControl

Throws:

Exception

addSecuritySettings

public void addSecuritySettings(String addressMatch,
                                String sendRoles,
                                String consumeRoles,
                                String createDurableQueueRoles,
                                String deleteDurableQueueRoles,
                                String createNonDurableQueueRoles,
                                String deleteNonDurableQueueRoles,
                                String manageRoles)
                         throws Exception

Specified by:: addSecuritySettings in interface ActiveMQServerControl
Throws:: Exception

addSecuritySettings

public void addSecuritySettings(String addressMatch,
                                String sendRoles,
                                String consumeRoles,
                                String createDurableQueueRoles,
                                String deleteDurableQueueRoles,
                                String createNonDurableQueueRoles,
                                String deleteNonDurableQueueRoles,
                                String manageRoles,
                                String browseRoles)
                         throws Exception

Specified by:: addSecuritySettings in interface ActiveMQServerControl
Throws:: Exception

addSecuritySettings

public void addSecuritySettings(String addressMatch,
                                String sendRoles,
                                String consumeRoles,
                                String createDurableQueueRoles,
                                String deleteDurableQueueRoles,
                                String createNonDurableQueueRoles,
                                String deleteNonDurableQueueRoles,
                                String manageRoles,
                                String browseRoles,
                                String createAddressRoles,
                                String deleteAddressRoles)
                         throws Exception

Specified by:: addSecuritySettings in interface ActiveMQServerControl
Throws:: Exception

removeSecuritySettings

public void removeSecuritySettings(String addressMatch)
                            throws Exception

Specified by:: removeSecuritySettings in interface ActiveMQServerControl
Throws:: Exception

getRoles

public Object[] getRoles(String addressMatch)
                  throws Exception

Specified by:: getRoles in interface ActiveMQServerControl
Throws:: Exception

getRolesAsJSON

public String getRolesAsJSON(String addressMatch)
                      throws Exception

Specified by:: getRolesAsJSON in interface ActiveMQServerControl
Throws:: Exception

getAddressSettingsAsJSON
```
public String getAddressSettingsAsJSON(String address)
                                throws Exception
```
Description copied from interface: ActiveMQServerControl

returns the address settings as a JSON string

Specified by:

getAddressSettingsAsJSON in interface ActiveMQServerControl

Throws:

Exception

addAddressSettings

public void addAddressSettings(String address,
                               String DLA,
                               String expiryAddress,
                               long expiryDelay,
                               boolean lastValueQueue,
                               int deliveryAttempts,
                               long maxSizeBytes,
                               int pageSizeBytes,
                               int pageMaxCacheSize,
                               long redeliveryDelay,
                               double redeliveryMultiplier,
                               long maxRedeliveryDelay,
                               long redistributionDelay,
                               boolean sendToDLAOnNoRoute,
                               String addressFullMessagePolicy,
                               long slowConsumerThreshold,
                               long slowConsumerCheckPeriod,
                               String slowConsumerPolicy,
                               boolean autoCreateJmsQueues,
                               boolean autoDeleteJmsQueues,
                               boolean autoCreateJmsTopics,
                               boolean autoDeleteJmsTopics)
                        throws Exception

Description copied from interface: ActiveMQServerControl

adds a new address setting for a specific address

Specified by:: addAddressSettings in interface ActiveMQServerControl
Throws:: Exception

addAddressSettings

public void addAddressSettings(String address,
                               String DLA,
                               String expiryAddress,
                               long expiryDelay,
                               boolean defaultLastValueQueue,
                               int maxDeliveryAttempts,
                               long maxSizeBytes,
                               int pageSizeBytes,
                               int pageMaxCacheSize,
                               long redeliveryDelay,
                               double redeliveryMultiplier,
                               long maxRedeliveryDelay,
                               long redistributionDelay,
                               boolean sendToDLAOnNoRoute,
                               String addressFullMessagePolicy,
                               long slowConsumerThreshold,
                               long slowConsumerCheckPeriod,
                               String slowConsumerPolicy,
                               boolean autoCreateJmsQueues,
                               boolean autoDeleteJmsQueues,
                               boolean autoCreateJmsTopics,
                               boolean autoDeleteJmsTopics,
                               boolean autoCreateQueues,
                               boolean autoDeleteQueues,
                               boolean autoCreateAddresses,
                               boolean autoDeleteAddresses)
                        throws Exception

Description copied from interface: ActiveMQServerControl

adds a new address setting for a specific address

Specified by:: addAddressSettings in interface ActiveMQServerControl
Throws:: Exception

addAddressSettings

public void addAddressSettings(String address,
                               String DLA,
                               String expiryAddress,
                               long expiryDelay,
                               boolean defaultLastValueQueue,
                               int maxDeliveryAttempts,
                               long maxSizeBytes,
                               int pageSizeBytes,
                               int pageMaxCacheSize,
                               long redeliveryDelay,
                               double redeliveryMultiplier,
                               long maxRedeliveryDelay,
                               long redistributionDelay,
                               boolean sendToDLAOnNoRoute,
                               String addressFullMessagePolicy,
                               long slowConsumerThreshold,
                               long slowConsumerCheckPeriod,
                               String slowConsumerPolicy,
                               boolean autoCreateJmsQueues,
                               boolean autoDeleteJmsQueues,
                               boolean autoCreateJmsTopics,
                               boolean autoDeleteJmsTopics,
                               boolean autoCreateQueues,
                               boolean autoDeleteQueues,
                               boolean autoCreateAddresses,
                               boolean autoDeleteAddresses,
                               String configDeleteQueues,
                               String configDeleteAddresses,
                               long maxSizeBytesRejectThreshold,
                               String defaultLastValueKey,
                               boolean defaultNonDestructive,
                               boolean defaultExclusiveQueue,
                               boolean defaultGroupRebalance,
                               int defaultGroupBuckets,
                               String defaultGroupFirstKey,
                               int defaultMaxConsumers,
                               boolean defaultPurgeOnNoConsumers,
                               int defaultConsumersBeforeDispatch,
                               long defaultDelayBeforeDispatch,
                               String defaultQueueRoutingType,
                               String defaultAddressRoutingType,
                               int defaultConsumerWindowSize,
                               long defaultRingSize,
                               boolean autoDeleteCreatedQueues,
                               long autoDeleteQueuesDelay,
                               long autoDeleteQueuesMessageCount,
                               long autoDeleteAddressesDelay,
                               double redeliveryCollisionAvoidanceFactor,
                               long retroactiveMessageCount)
                        throws Exception

Description copied from interface: ActiveMQServerControl

adds a new address setting for a specific address

Specified by:: addAddressSettings in interface ActiveMQServerControl
Throws:: Exception

addAddressSettings

public void addAddressSettings(String address,
                               String DLA,
                               String expiryAddress,
                               long expiryDelay,
                               boolean defaultLastValueQueue,
                               int maxDeliveryAttempts,
                               long maxSizeBytes,
                               int pageSizeBytes,
                               int pageMaxCacheSize,
                               long redeliveryDelay,
                               double redeliveryMultiplier,
                               long maxRedeliveryDelay,
                               long redistributionDelay,
                               boolean sendToDLAOnNoRoute,
                               String addressFullMessagePolicy,
                               long slowConsumerThreshold,
                               long slowConsumerCheckPeriod,
                               String slowConsumerPolicy,
                               boolean autoCreateJmsQueues,
                               boolean autoDeleteJmsQueues,
                               boolean autoCreateJmsTopics,
                               boolean autoDeleteJmsTopics,
                               boolean autoCreateQueues,
                               boolean autoDeleteQueues,
                               boolean autoCreateAddresses,
                               boolean autoDeleteAddresses,
                               String configDeleteQueues,
                               String configDeleteAddresses,
                               long maxSizeBytesRejectThreshold,
                               String defaultLastValueKey,
                               boolean defaultNonDestructive,
                               boolean defaultExclusiveQueue,
                               boolean defaultGroupRebalance,
                               int defaultGroupBuckets,
                               String defaultGroupFirstKey,
                               int defaultMaxConsumers,
                               boolean defaultPurgeOnNoConsumers,
                               int defaultConsumersBeforeDispatch,
                               long defaultDelayBeforeDispatch,
                               String defaultQueueRoutingType,
                               String defaultAddressRoutingType,
                               int defaultConsumerWindowSize,
                               long defaultRingSize,
                               boolean autoDeleteCreatedQueues,
                               long autoDeleteQueuesDelay,
                               long autoDeleteQueuesMessageCount,
                               long autoDeleteAddressesDelay,
                               double redeliveryCollisionAvoidanceFactor,
                               long retroactiveMessageCount,
                               boolean autoCreateDeadLetterResources,
                               String deadLetterQueuePrefix,
                               String deadLetterQueueSuffix,
                               boolean autoCreateExpiryResources,
                               String expiryQueuePrefix,
                               String expiryQueueSuffix)
                        throws Exception

Description copied from interface: ActiveMQServerControl

adds a new address setting for a specific address

Specified by:: addAddressSettings in interface ActiveMQServerControl
Throws:: Exception

addAddressSettings

public void addAddressSettings(String address,
                               String DLA,
                               String expiryAddress,
                               long expiryDelay,
                               boolean defaultLastValueQueue,
                               int maxDeliveryAttempts,
                               long maxSizeBytes,
                               int pageSizeBytes,
                               int pageMaxCacheSize,
                               long redeliveryDelay,
                               double redeliveryMultiplier,
                               long maxRedeliveryDelay,
                               long redistributionDelay,
                               boolean sendToDLAOnNoRoute,
                               String addressFullMessagePolicy,
                               long slowConsumerThreshold,
                               long slowConsumerCheckPeriod,
                               String slowConsumerPolicy,
                               boolean autoCreateJmsQueues,
                               boolean autoDeleteJmsQueues,
                               boolean autoCreateJmsTopics,
                               boolean autoDeleteJmsTopics,
                               boolean autoCreateQueues,
                               boolean autoDeleteQueues,
                               boolean autoCreateAddresses,
                               boolean autoDeleteAddresses,
                               String configDeleteQueues,
                               String configDeleteAddresses,
                               long maxSizeBytesRejectThreshold,
                               String defaultLastValueKey,
                               boolean defaultNonDestructive,
                               boolean defaultExclusiveQueue,
                               boolean defaultGroupRebalance,
                               int defaultGroupBuckets,
                               String defaultGroupFirstKey,
                               int defaultMaxConsumers,
                               boolean defaultPurgeOnNoConsumers,
                               int defaultConsumersBeforeDispatch,
                               long defaultDelayBeforeDispatch,
                               String defaultQueueRoutingType,
                               String defaultAddressRoutingType,
                               int defaultConsumerWindowSize,
                               long defaultRingSize,
                               boolean autoDeleteCreatedQueues,
                               long autoDeleteQueuesDelay,
                               long autoDeleteQueuesMessageCount,
                               long autoDeleteAddressesDelay,
                               double redeliveryCollisionAvoidanceFactor,
                               long retroactiveMessageCount,
                               boolean autoCreateDeadLetterResources,
                               String deadLetterQueuePrefix,
                               String deadLetterQueueSuffix,
                               boolean autoCreateExpiryResources,
                               String expiryQueuePrefix,
                               String expiryQueueSuffix,
                               long minExpiryDelay,
                               long maxExpiryDelay,
                               boolean enableMetrics)
                        throws Exception

Description copied from interface: ActiveMQServerControl

adds a new address setting for a specific address

Specified by:: addAddressSettings in interface ActiveMQServerControl
Throws:: Exception

removeAddressSettings

public void removeAddressSettings(String addressMatch)
                           throws Exception

Specified by:: removeAddressSettings in interface ActiveMQServerControl
Throws:: Exception

sendQueueInfoToQueue

public void sendQueueInfoToQueue(String queueName,
                                 String address)
                          throws Exception

Throws:: Exception

getDivertNames
```
public String[] getDivertNames()
```
Specified by:

getDivertNames in interface ActiveMQServerControl

createDivert

public void createDivert(String name,
                         String routingName,
                         String address,
                         String forwardingAddress,
                         boolean exclusive,
                         String filterString,
                         String transformerClassName)
                  throws Exception

Specified by:: createDivert in interface ActiveMQServerControl
Throws:: Exception

createDivert

public void createDivert(String name,
                         String routingName,
                         String address,
                         String forwardingAddress,
                         boolean exclusive,
                         String filterString,
                         String transformerClassName,
                         String routingType)
                  throws Exception

Specified by:: createDivert in interface ActiveMQServerControl
Throws:: Exception

createDivert

public void createDivert(String name,
                         String routingName,
                         String address,
                         String forwardingAddress,
                         boolean exclusive,
                         String filterString,
                         String transformerClassName,
                         String transformerPropertiesAsJSON,
                         String routingType)
                  throws Exception

Specified by:: createDivert in interface ActiveMQServerControl
Throws:: Exception

createDivert

public void createDivert(String name,
                         String routingName,
                         String address,
                         String forwardingAddress,
                         boolean exclusive,
                         String filterString,
                         String transformerClassName,
                         Map<String,String> transformerProperties,
                         String routingType)
                  throws Exception

Specified by:: createDivert in interface ActiveMQServerControl
Throws:: Exception

updateDivert

public void updateDivert(String name,
                         String forwardingAddress,
                         String filterString,
                         String transformerClassName,
                         Map<String,String> transformerProperties,
                         String routingType)
                  throws Exception

Description copied from interface: ActiveMQServerControl

update a divert

Specified by:: updateDivert in interface ActiveMQServerControl
Throws:: Exception

destroyDivert
```
public void destroyDivert(String name)
                   throws Exception
```
Specified by:

destroyDivert in interface ActiveMQServerControl

Throws:

Exception

getBridgeNames
```
public String[] getBridgeNames()
```
Specified by:

getBridgeNames in interface ActiveMQServerControl

createBridge

public void createBridge(String name,
                         String queueName,
                         String forwardingAddress,
                         String filterString,
                         String transformerClassName,
                         long retryInterval,
                         double retryIntervalMultiplier,
                         int initialConnectAttempts,
                         int reconnectAttempts,
                         boolean useDuplicateDetection,
                         int confirmationWindowSize,
                         int producerWindowSize,
                         long clientFailureCheckPeriod,
                         String staticConnectorsOrDiscoveryGroup,
                         boolean useDiscoveryGroup,
                         boolean ha,
                         String user,
                         String password)
                  throws Exception

Specified by:: createBridge in interface ActiveMQServerControl
Throws:: Exception

createBridge

public void createBridge(String name,
                         String queueName,
                         String forwardingAddress,
                         String filterString,
                         String transformerClassName,
                         String transformerPropertiesAsJSON,
                         long retryInterval,
                         double retryIntervalMultiplier,
                         int initialConnectAttempts,
                         int reconnectAttempts,
                         boolean useDuplicateDetection,
                         int confirmationWindowSize,
                         int producerWindowSize,
                         long clientFailureCheckPeriod,
                         String staticConnectorsOrDiscoveryGroup,
                         boolean useDiscoveryGroup,
                         boolean ha,
                         String user,
                         String password)
                  throws Exception

Specified by:: createBridge in interface ActiveMQServerControl
Throws:: Exception

createBridge

public void createBridge(String name,
                         String queueName,
                         String forwardingAddress,
                         String filterString,
                         String transformerClassName,
                         Map<String,String> transformerProperties,
                         long retryInterval,
                         double retryIntervalMultiplier,
                         int initialConnectAttempts,
                         int reconnectAttempts,
                         boolean useDuplicateDetection,
                         int confirmationWindowSize,
                         int producerWindowSize,
                         long clientFailureCheckPeriod,
                         String staticConnectorsOrDiscoveryGroup,
                         boolean useDiscoveryGroup,
                         boolean ha,
                         String user,
                         String password)
                  throws Exception

Specified by:: createBridge in interface ActiveMQServerControl
Throws:: Exception

createBridge

public void createBridge(String name,
                         String queueName,
                         String forwardingAddress,
                         String filterString,
                         String transformerClassName,
                         long retryInterval,
                         double retryIntervalMultiplier,
                         int initialConnectAttempts,
                         int reconnectAttempts,
                         boolean useDuplicateDetection,
                         int confirmationWindowSize,
                         long clientFailureCheckPeriod,
                         String staticConnectorsOrDiscoveryGroup,
                         boolean useDiscoveryGroup,
                         boolean ha,
                         String user,
                         String password)
                  throws Exception

Specified by:: createBridge in interface ActiveMQServerControl
Throws:: Exception

createBridge
```
public void createBridge(String bridgeConfigurationAsJson)
                  throws Exception
```
Description copied from interface: ActiveMQServerControl

Create a bridge.

Specified by:

createBridge in interface ActiveMQServerControl

Parameters:

bridgeConfigurationAsJson - the configuration of the queue in JSON format

Throws:

Exception

addConnector

public void addConnector(String name,
                         String url)
                  throws Exception

Specified by:: addConnector in interface ActiveMQServerControl
Throws:: Exception

removeConnector
```
public void removeConnector(String name)
                     throws Exception
```
Specified by:

removeConnector in interface ActiveMQServerControl

Throws:

Exception

listBrokerConnections
```
public String listBrokerConnections()
```
Specified by:

listBrokerConnections in interface ActiveMQServerControl

startBrokerConnection
```
public void startBrokerConnection(String name)
                           throws Exception
```
Specified by:

startBrokerConnection in interface ActiveMQServerControl

Throws:

Exception

stopBrokerConnection
```
public void stopBrokerConnection(String name)
                          throws Exception
```
Specified by:

stopBrokerConnection in interface ActiveMQServerControl

Throws:

Exception

destroyBridge
```
public void destroyBridge(String name)
                   throws Exception
```
Specified by:

destroyBridge in interface ActiveMQServerControl

Throws:

Exception

createConnectorService

public void createConnectorService(String name,
                                   String factoryClass,
                                   Map<String,Object> parameters)
                            throws Exception

Specified by:: createConnectorService in interface ActiveMQServerControl
Throws:: Exception

destroyConnectorService
```
public void destroyConnectorService(String name)
                             throws Exception
```
Specified by:

destroyConnectorService in interface ActiveMQServerControl

Throws:

Exception

getConnectorServices
```
public String[] getConnectorServices()
```
Specified by:

getConnectorServices in interface ActiveMQServerControl

forceFailover
```
public void forceFailover()
                   throws Exception
```
Specified by:

forceFailover in interface ActiveMQServerControl

Throws:

Exception

updateDuplicateIdCache

public void updateDuplicateIdCache(String address,
                                   Object[] ids)
                            throws Exception

Throws:: Exception

scaleDown

public void scaleDown(String connector)
               throws Exception

Specified by:: scaleDown in interface ActiveMQServerControl
Throws:: Exception

listNetworkTopology
```
public String listNetworkTopology()
                           throws Exception
```
Specified by:

listNetworkTopology in interface ActiveMQServerControl

Throws:

Exception

removeNotificationListener

public void removeNotificationListener(NotificationListener listener,
                                       NotificationFilter filter,
                                       Object handback)
                                throws ListenerNotFoundException

Specified by:: removeNotificationListener in interface NotificationEmitter
Throws:: ListenerNotFoundException

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

Specified by:: removeNotificationListener in interface NotificationBroadcaster
Throws:: ListenerNotFoundException

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                                    NotificationFilter filter,
                                    Object handback)
                             throws IllegalArgumentException

Specified by:: addNotificationListener in interface NotificationBroadcaster
Throws:: IllegalArgumentException

getNotificationInfo
```
public MBeanNotificationInfo[] getNotificationInfo()
```
Specified by:

getNotificationInfo in interface NotificationBroadcaster

getConnectionTTLOverride
```
public long getConnectionTTLOverride()
```
Description copied from interface: ActiveMQServerControl

Returns the connection time to live.
This value overrides the connection time to live sent by the client.

Specified by:

getConnectionTTLOverride in interface ActiveMQServerControl

getIDCacheSize
```
public int getIDCacheSize()
```
Description copied from interface: ActiveMQServerControl

Returns the size of the cache for pre-creating message IDs.

Specified by:

getIDCacheSize in interface ActiveMQServerControl

getLargeMessagesDirectory
```
public String getLargeMessagesDirectory()
```
Description copied from interface: ActiveMQServerControl

Returns the file system directory used to store large messages.

Specified by:

getLargeMessagesDirectory in interface ActiveMQServerControl

getManagementAddress
```
public String getManagementAddress()
```
Description copied from interface: ActiveMQServerControl

Returns the management address of this server.
Clients can send management messages to this address to manage this server.

Specified by:

getManagementAddress in interface ActiveMQServerControl

getNodeID
```
public String getNodeID()
```
Description copied from interface: ActiveMQServerControl

Returns the node ID of this server.
Clients can send management messages to this address to manage this server.

Specified by:

getNodeID in interface ActiveMQServerControl

getActivationSequence
```
public long getActivationSequence()
```
Description copied from interface: ActiveMQServerControl

Returns the current activation sequence number of this server.
When replicated, peers may coordinate activation with this monotonic sequence

Specified by:

getActivationSequence in interface ActiveMQServerControl

getManagementNotificationAddress
```
public String getManagementNotificationAddress()
```
Description copied from interface: ActiveMQServerControl

Returns the management notification address of this server.
Clients can bind queues to this address to receive management notifications emitted by this server.

Specified by:

getManagementNotificationAddress in interface ActiveMQServerControl

getMessageExpiryScanPeriod
```
public long getMessageExpiryScanPeriod()
```
Description copied from interface: ActiveMQServerControl

Returns the frequency (in milliseconds) to scan messages to detect which messages have expired.

Specified by:

getMessageExpiryScanPeriod in interface ActiveMQServerControl

getMessageExpiryThreadPriority
```
@Deprecated
public long getMessageExpiryThreadPriority()
```
Deprecated.

Description copied from interface: ActiveMQServerControl

Returns the priority of the thread used to scan message expiration.

Specified by:

getMessageExpiryThreadPriority in interface ActiveMQServerControl

getTransactionTimeout
```
public long getTransactionTimeout()
```
Description copied from interface: ActiveMQServerControl

Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.

Specified by:

getTransactionTimeout in interface ActiveMQServerControl

getTransactionTimeoutScanPeriod
```
public long getTransactionTimeoutScanPeriod()
```
Description copied from interface: ActiveMQServerControl

Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.

Specified by:

getTransactionTimeoutScanPeriod in interface ActiveMQServerControl

isPersistDeliveryCountBeforeDelivery
```
public boolean isPersistDeliveryCountBeforeDelivery()
```
Description copied from interface: ActiveMQServerControl

Returns whether delivery count is persisted before messages are delivered to the consumers.

Specified by:

isPersistDeliveryCountBeforeDelivery in interface ActiveMQServerControl

isPersistIDCache
```
public boolean isPersistIDCache()
```
Description copied from interface: ActiveMQServerControl

Returns whether message ID cache is persisted.

Specified by:

isPersistIDCache in interface ActiveMQServerControl

isWildcardRoutingEnabled
```
public boolean isWildcardRoutingEnabled()
```
Description copied from interface: ActiveMQServerControl

Returns whether wildcard routing is supported by this server.

Specified by:

isWildcardRoutingEnabled in interface ActiveMQServerControl

fillMBeanOperationInfo
```
protected MBeanOperationInfo[] fillMBeanOperationInfo()
```
Specified by:

fillMBeanOperationInfo in class AbstractControl

fillMBeanAttributeInfo
```
protected MBeanAttributeInfo[] fillMBeanAttributeInfo()
```
Specified by:

fillMBeanAttributeInfo in class AbstractControl

listTargetAddresses

public String[] listTargetAddresses(String sessionID)

onNotification
```
public void onNotification(Notification notification)
```
Specified by:

onNotification in interface NotificationListener

addUser

public void addUser(String username,
                    String password,
                    String roles,
                    boolean plaintext)
             throws Exception

Description copied from interface: ActiveMQServerControl

Add a user (only applicable when using the JAAS PropertiesLoginModule)

Specified by:: addUser in interface ActiveMQServerControl
Throws:: Exception

listUser
```
public String listUser(String username)
                throws Exception
```
Description copied from interface: ActiveMQServerControl

List the information about a user or all users if no username is supplied (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).

Specified by:

listUser in interface ActiveMQServerControl

Returns:

JSON array of user and role information

Throws:

Exception

removeUser
```
public void removeUser(String username)
                throws Exception
```
Description copied from interface: ActiveMQServerControl

Remove a user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).

Specified by:

removeUser in interface ActiveMQServerControl

Throws:

Exception

resetUser
```
public void resetUser(String username,
                      String password,
                      String roles,
                      boolean plaintext)
               throws Exception
```
Description copied from interface: ActiveMQServerControl

Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).

Specified by:

resetUser in interface ActiveMQServerControl

Throws:

Exception

resetUser
```
public void resetUser(String username,
                      String password,
                      String roles)
               throws Exception
```
Description copied from interface: ActiveMQServerControl

Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).

Specified by:

resetUser in interface ActiveMQServerControl

Throws:

Exception

reloadConfigurationFile
```
public void reloadConfigurationFile()
                             throws Exception
```
Specified by:

reloadConfigurationFile in interface ActiveMQServerControl

Throws:

Exception

replay

public void replay(String address,
                   String target,
                   String filter)
            throws Exception

Specified by:: replay in interface ActiveMQServerControl
Throws:: Exception

replay

public void replay(String startScan,
                   String endScan,
                   String address,
                   String target,
                   String filter)
            throws Exception

Specified by:: replay in interface ActiveMQServerControl
Throws:: Exception

Class ActiveMQServerControlImpl

Nested Class Summary

Field Summary

Fields inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl

Fields inherited from interface org.apache.activemq.artemis.api.core.management.ActiveMQServerControl

Constructor Summary

Method Summary

Methods inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl

Methods inherited from class javax.management.StandardMBean

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.activemq.artemis.api.core.management.ActiveMQServerControl

Constructor Detail

ActiveMQServerControlImpl

Method Detail

isStarted

getVersion

isActive

isBackup

isSharedStore

getBindingsDirectory

getInterceptorClassNames

getIncomingInterceptorClassNames

getOutgoingInterceptorClassNames

getJournalPoolFiles

getJournalBufferSize

getJournalBufferTimeout

setFailoverOnServerShutdown

isFailoverOnServerShutdown

getJournalMaxIO

getJournalDirectory

getJournalFileSize

getJournalMinFiles

getJournalCompactMinFiles

getJournalCompactPercentage

isPersistenceEnabled

getJournalType

getPagingDirectory

getScheduledThreadPoolMaxSize

getThreadPoolMaxSize

getSecurityInvalidationInterval

isClustered

isCreateBindingsDir

isCreateJournalDir

isJournalSyncNonTransactional

isJournalSyncTransactional

isSecurityEnabled

isAsyncConnectionExecutionEnabled

getDiskScanPeriod

getMaxDiskUsage

getGlobalMaxSize

getAddressMemoryUsage

getDiskStoreUsage

getAddressMemoryUsagePercentage

getHAPolicy

getAuthenticationCacheSize

getAuthorizationCacheSize

freezeReplication

createAddress

updateAddress

deleteAddress

deleteAddress

deployQueue

deployQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

updateQueue

updateQueue

updateQueue

updateQueue