Interface ActiveMQServerControl

public interface ActiveMQServerControl
An ActiveMQServerControl is used to manage Apache Artemis servers.

  • Field Details

  • Method Details

    • getName

      String getName()
      Returns this server's name..
      Returns:
      this server's name.

    • getCurrentTimeMillis

      long getCurrentTimeMillis()

    • getVersion

      String getVersion()
      Returns this server's version..
      Returns:
      this server's version.

    • isActive

      boolean isActive()

    • getConnectionCount

      int getConnectionCount()
      Returns the number of clients connected to this server..
      Returns:
      the number of clients connected to this server.

    • getTotalConnectionCount

      long getTotalConnectionCount()
      Returns the total number of clients which have connected to this server since it was started..
      Returns:
      the total number of clients which have connected to this server since it was started.

    • getSessionCount

      int getSessionCount()
      Returns the number of sessions on this server.

    • getTotalSessionCount

      long getTotalSessionCount()
      Returns the total number of sessions created on this server since it was started.

    • getTotalMessageCount

      long getTotalMessageCount()
      Returns the number of messages in all queues currently on the server..
      Returns:
      the number of messages in all queues currently on the server.

    • getTotalMessagesAdded

      long getTotalMessagesAdded()
      Returns the number of messages sent to all queues currently on the server since they were created..
      Returns:
      the number of messages sent to all queues currently on the server since they were created.

    • getTotalMessagesAcknowledged

      long getTotalMessagesAcknowledged()
      Returns the number of messages acknowledged from all the queues currently on this server since they were created..
      Returns:
      the number of messages acknowledged from all the queues currently on this server since they were created.

    • getTotalConsumerCount

      long getTotalConsumerCount()
      Returns the number of consumers on all the queues currently on this server..
      Returns:
      the number of consumers on all the queues currently on this server.

    • isStarted

      boolean isStarted()
      Return whether this server is started.

    • getIncomingInterceptorClassNames

      String[] getIncomingInterceptorClassNames()
      Returns the list of interceptors used by this server for incoming messages..
      Returns:
      the list of interceptors used by this server for incoming messages.
      See Also:

    • getOutgoingInterceptorClassNames

      String[] getOutgoingInterceptorClassNames()
      Returns the list of interceptors used by this server for outgoing messages..
      Returns:
      the list of interceptors used by this server for outgoing messages.
      See Also:

    • getBrokerPluginClassNames

      String[] getBrokerPluginClassNames()

    • isClustered

      boolean isClustered()
      Returns whether this server is clustered..
      Returns:
      whether this server is clustered.

    • getScheduledThreadPoolMaxSize

      int getScheduledThreadPoolMaxSize()
      Returns the maximum number of threads in the scheduled thread pool..
      Returns:
      the maximum number of threads in the scheduled thread pool.

    • getThreadPoolMaxSize

      int getThreadPoolMaxSize()
      Returns the maximum number of threads in the thread pool..
      Returns:
      the maximum number of threads in the thread pool.

    • getSecurityInvalidationInterval

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

    • isSecurityEnabled

      boolean isSecurityEnabled()
      Returns whether security is enabled for this server..
      Returns:
      whether security is enabled for this server.

    • getBindingsDirectory

      String getBindingsDirectory()
      Returns the file system directory used to store bindings..
      Returns:
      the file system directory used to store bindings.

    • getJournalDirectory

      String getJournalDirectory()
      Returns the file system directory used to store journal log..
      Returns:
      the file system directory used to store journal log.

    • getJournalType

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

    • isJournalSyncTransactional

      boolean isJournalSyncTransactional()
      Returns whether the journal is synchronized when receiving transactional data..
      Returns:
      whether the journal is synchronized when receiving transactional data.

    • isJournalSyncNonTransactional

      boolean isJournalSyncNonTransactional()
      Returns whether the journal is synchronized when receiving non-transactional data..
      Returns:
      whether the journal is synchronized when receiving non-transactional data.

    • getJournalFileSize

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

    • getJournalMinFiles

      int getJournalMinFiles()
      Returns the number of journal files to pre-create..
      Returns:
      the number of journal files to pre-create.

    • getJournalMaxIO

      int getJournalMaxIO()
      Returns the maximum number of write requests that can be in the AIO queue at any given time..
      Returns:
      the maximum number of write requests that can be in the AIO queue at any given time.

    • getJournalBufferSize

      int getJournalBufferSize()
      Returns the size of the internal buffer on the journal..
      Returns:
      the size of the internal buffer on the journal.

    • getJournalPoolFiles

      int getJournalPoolFiles()
      Number of files that would be acceptable to keep on a pool

    • getJournalBufferTimeout

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

    • setFailoverOnServerShutdown

      void setFailoverOnServerShutdown(boolean failoverOnServerShutdown) throws Exception
      do any clients failover on a server shutdown
      Throws:
      Exception

    • isFailoverOnServerShutdown

      boolean isFailoverOnServerShutdown()
      Returns if clients failover on a server shutdown.
      Returns:
      if clients failover on a server shutdown

    • getJournalCompactMinFiles

      int getJournalCompactMinFiles()
      Returns the minimal number of journal files before compacting..
      Returns:
      the minimal number of journal files before compacting.

    • getJournalCompactPercentage

      int getJournalCompactPercentage()
      Return the percentage of live data before compacting the journal.

    • isPersistenceEnabled

      boolean isPersistenceEnabled()
      Returns whether this server is using persistence and store data..
      Returns:
      whether this server is using persistence and store data.

    • isCreateBindingsDir

      boolean isCreateBindingsDir()
      Returns whether the bindings directory is created on this server startup..
      Returns:
      whether the bindings directory is created on this server startup.

    • isCreateJournalDir

      boolean isCreateJournalDir()
      Returns whether the journal directory is created on this server startup..
      Returns:
      whether the journal directory is created on this server startup.

    • isMessageCounterEnabled

      boolean isMessageCounterEnabled()
      Returns whether message counter is enabled for this server..
      Returns:
      whether message counter is enabled for this server.

    • getMessageCounterMaxDayCount

      int getMessageCounterMaxDayCount()
      Returns the maximum number of days kept in memory for message counter..
      Returns:
      the maximum number of days kept in memory for message counter.

    • setMessageCounterMaxDayCount

      void setMessageCounterMaxDayCount(int count) throws Exception
      Sets the maximum number of days kept in memory for message counter.
      Parameters:
      count - value must be greater than 0
      Throws:
      Exception

    • getMessageCounterSamplePeriod

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

    • setMessageCounterSamplePeriod

      void setMessageCounterSamplePeriod(long newPeriod) throws Exception
      Sets the sample period to take message counter snapshot.
      Parameters:
      newPeriod - value must be greater than 1000ms
      Throws:
      Exception

    • isBackup

      boolean isBackup()
      Returns true if this server is a backup, false if it is a primary server or if it is a backup server and has been activated.
      Returns:
      true if this server is a backup, false if it is a primary server or if it is a backup server and has been activated

    • isSharedStore

      boolean isSharedStore()
      Returns whether this server shares its data store with a corresponding primary or backup server..
      Returns:
      whether this server shares its data store with a corresponding primary or backup server.

    • getPagingDirectory

      String getPagingDirectory()
      Returns the file system directory used to store paging files..
      Returns:
      the file system directory used to store paging files.

    • isPersistDeliveryCountBeforeDelivery

      boolean isPersistDeliveryCountBeforeDelivery()
      Returns whether delivery count is persisted before messages are delivered to the consumers..
      Returns:
      whether delivery count is persisted before messages are delivered to the consumers.

    • getConnectionTTLOverride

      long getConnectionTTLOverride()
      Returns the connection time to live; this value overrides the connection time to live sent by the client.
      Returns:
      the connection time to live; this value overrides the connection time to live sent by the client

    • getManagementAddress

      String getManagementAddress()
      Returns the management address of this server; clients can send management messages to this address to manage this server.
      Returns:
      the management address of this server; clients can send management messages to this address to manage this server

    • getNodeID

      String getNodeID()
      Returns the node ID of this server..
      Returns:
      the node ID of this server.

    • getActivationSequence

      long getActivationSequence()
      Returns the current activation sequence number of this server; when replicated, peers may coordinate activation with this monotonic sequence.
      Returns:
      the current activation sequence number of this server; when replicated, peers may coordinate activation with this monotonic sequence

    • getManagementNotificationAddress

      String getManagementNotificationAddress()
      Returns the management notification address of this server; clients can bind queues to this address to receive management notifications emitted by this server.
      Returns:
      the management notification address of this server; clients can bind queues to this address to receive management notifications emitted by this server

    • getIDCacheSize

      int getIDCacheSize()
      Returns the size of the cache for pre-creating message IDs..
      Returns:
      the size of the cache for pre-creating message IDs.

    • isPersistIDCache

      boolean isPersistIDCache()
      Returns whether message ID cache is persisted..
      Returns:
      whether message ID cache is persisted.

    • getLargeMessagesDirectory

      String getLargeMessagesDirectory()
      Returns the file system directory used to store large messages..
      Returns:
      the file system directory used to store large messages.

    • isWildcardRoutingEnabled

      boolean isWildcardRoutingEnabled()
      Returns whether wildcard routing is supported by this server..
      Returns:
      whether wildcard routing is supported by this server.

    • getTransactionTimeout

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

    • getTransactionTimeoutScanPeriod

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

    • getMessageExpiryScanPeriod

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

    • getMessageExpiryThreadPriority

      @Deprecated(forRemoval=true) long getMessageExpiryThreadPriority()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This config parameter is no longer valid. The code uses a ScheduledExecutorService and a thread pool rather than dedicating a thread 100% to the expiry scanner. The pool's size can be controlled via scheduled-thread-pool-max-size.
      Returns the priority of the thread used to scan message expiration..
      Returns:
      the priority of the thread used to scan message expiration.

    • isAsyncConnectionExecutionEnabled

      boolean isAsyncConnectionExecutionEnabled()
      Returns whether code coming from connection is executed asynchronously or not..
      Returns:
      whether code coming from connection is executed asynchronously or not.

    • getConnectors

      Object[] getConnectors() throws Exception
      Returns the connectors configured for this server..
      Returns:
      the connectors configured for this server.
      Throws:
      Exception

    • getConnectorsAsJSON

      String getConnectorsAsJSON() throws Exception
      Get the connectors configured for this server as JSON. The JSON consists of an array of objects containing the attributes of the connector, e.g.: 
      [
  {
    "name": "invm",
    "factoryClassName": "org.apache.activemq.artemis.core.remoting.impl.invm.InVMConnectorFactory",
    "params": {
      "serverId": 0
    },
    "extraProps": {}
  },
  {
    "name": "artemis",
    "factoryClassName": "org.apache.activemq.artemis.core.remoting.impl.netty.NettyConnectorFactory",
    "params": {
      "port": "61616",
      "host": "localhost"
    },
    "extraProps": {}
  }
]
      Returns:
      the connectors configured for this server as JSON
      Throws:
      Exception

    • getAcceptors

      Object[] getAcceptors() throws Exception
      Returns the acceptors configured for this server..
      Returns:
      the acceptors configured for this server.
      Throws:
      Exception

    • getAcceptorsAsJSON

      String getAcceptorsAsJSON() throws Exception
      Get the acceptors configured for this server as JSON. The JSON consists of an array of objects containing the attributes of the acceptor, e.g.: 
      [
  {
    "name": "artemis",
    "factoryClassName": "org.apache.activemq.artemis.core.remoting.impl.netty.NettyAcceptorFactory",
    "params": {
      "scheme": "tcp",
      "port": "61616",
      "host": "0.0.0.0",
      "protocols": "CORE,AMQP"
    },
    "extraProps": {}
  }
  {
    "name": "invm",
    "factoryClassName": "org.apache.activemq.artemis.core.remoting.impl.invm.InVMAcceptorFactory",
    "params": {
      "serverId": 0
    },
    "extraProps": {}
  }
]
      Returns:
      the acceptors configured for this server as JSON
      Throws:
      Exception

    • getAddressCount

      int getAddressCount()
      Returns the number of addresses created on this server..
      Returns:
      the number of addresses created on this server.

    • getAddressNames

      String[] getAddressNames()
      Returns the names of the addresses created on this server..
      Returns:
      the names of the addresses created on this server.

    • getQueueCount

      int getQueueCount()
      Returns the number of queues created on this server..
      Returns:
      the number of queues created on this server.

    • getQueueNames

      String[] getQueueNames()
      Returns the names of the queues created on this server..
      Returns:
      the names of the queues created on this server.

    • getUptime

      String getUptime()
      Returns the uptime of this server..
      Returns:
      the uptime of this server.

    • getUptimeMillis

      long getUptimeMillis()
      Returns the uptime of this server..
      Returns:
      the uptime of this server.

    • isReplicaSync

      boolean isReplicaSync()
      Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the primary or backup server.
      Returns:
      whether the initial replication synchronization process with the backup server is complete; applicable for either the primary or backup server

    • getDiskScanPeriod

      int getDiskScanPeriod()
      Returns how often the server checks for disk space usage..
      Returns:
      how often the server checks for disk space usage.

    • getMaxDiskUsage

      int getMaxDiskUsage()
      Returns the disk use max limit..
      Returns:
      the disk use max limit.

    • getGlobalMaxSize

      long getGlobalMaxSize()
      Returns the global max bytes limit for in-memory messages..
      Returns:
      the global max bytes limit for in-memory messages.

    • getAddressMemoryUsage

      long getAddressMemoryUsage()
      Returns the memory used by all the addresses on broker for in-memory messages.
      Returns:
      the memory used by all the addresses on broker for in-memory messages

    • getDiskStoreUsage

      double getDiskStoreUsage()
      Returns the percentage of total disk store use.
      Returns:
      the percentage of total disk store use

    • getAddressMemoryUsagePercentage

      int getAddressMemoryUsagePercentage()
      Returns the memory used by all the addresses on broker as a percentage of the global-max-size.
      Returns:
      the memory used by all the addresses on broker as a percentage of the global-max-size

    • getHAPolicy

      String getHAPolicy()

    • getAuthenticationCacheSize

      long getAuthenticationCacheSize()
      Returns the runtime size of the authentication cache.
      Returns:
      the runtime size of the authentication cache

    • getAuthorizationCacheSize

      long getAuthorizationCacheSize()
      Returns the runtime size of the authorization cache.
      Returns:
      the runtime size of the authorization cache

    • getStatus

      String getStatus()

    • freezeReplication

      boolean freezeReplication() throws Exception
      Throws:
      Exception

    • createAddress

      String createAddress(String name, String routingTypes) throws Exception
      Throws:
      Exception

    • updateAddress

      String updateAddress(String name, String routingTypes) throws Exception
      Throws:
      Exception

    • deleteAddress

      void deleteAddress(String name) throws Exception
      Throws:
      Exception

    • deleteAddress

      void deleteAddress(String name, boolean force) throws Exception
      Throws:
      Exception

    • createQueue

      @Deprecated(forRemoval=true) void createQueue(String address, String name) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      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.

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      Throws:
      Exception

    • createQueue

      @Deprecated(forRemoval=true) void createQueue(String address, String name, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      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.

      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

      @Deprecated(forRemoval=true) void createQueue(String address, String name, boolean durable) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      Create a queue.

      If address is null it will be defaulted to name.

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

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      durable - whether the queue is durable
      Throws:
      Exception

    • createQueue

      @Deprecated(forRemoval=true) void createQueue(String address, String name, boolean durable, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      @Deprecated(forRemoval=true) void createQueue(String address, String name, String filter, boolean durable) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      Create a queue.

      If address is null it will be defaulted to name.

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

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      filter - of the queue
      durable - whether the queue is durable
      Throws:
      Exception

    • createQueue

      @Deprecated(forRemoval=true) void createQueue(String address, String name, String filter, boolean durable, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      Create a queue.

      If address is null it will be defaulted to name.

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

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      filter - of the queue
      durable - whether the queue is durable
      routingType - The routing type used for this address, MULTICAST or ANYCAST
      Throws:
      Exception

    • createQueue

      @Deprecated(forRemoval=true) 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createQueue(String) instead.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      @Deprecated 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
      Deprecated.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      @Deprecated 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
      Deprecated.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      @Deprecated 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
      Deprecated.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      @Deprecated String createQueue(String address, String routingType, String name, String filterStr, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreateAddress) throws Exception
      Deprecated.
      Create a queue.

      If address is null it will be defaulted to name.

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

      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

      String createQueue(String queueConfiguration) throws Exception
      Create a queue.

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

      Parameters:
      queueConfiguration - the configuration of the queue in JSON format
      Returns:
      the configuration of the created queue in JSON format
      Throws:
      Exception

    • createQueue

      String createQueue(String queueConfiguration, boolean ignoreIfExists) throws Exception
      Create a queue.

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

      Parameters:
      queueConfiguration - the configuration of the queue in JSON format
      ignoreIfExists - whether to simply return without an exception if the queue exists
      Returns:
      the configuration of the created queue in JSON format
      Throws:
      Exception

    • updateQueue

      String updateQueue(String queueConfiguration) throws Exception
      Update a queue.
      Parameters:
      queueConfiguration - the configuration of the queue in JSON format
      Returns:
      the configuration of the created queue in JSON format
      Throws:
      Exception

    • updateQueue

      @Deprecated String updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers) throws Exception
      Deprecated.
      Update a queue.
      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 String updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive) throws Exception
      Deprecated.
      Update a queue.
      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

      @Deprecated String updateQueue(String name, String routingType, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, String user) throws Exception
      Deprecated.
      Update a queue
      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
      Throws:
      Exception

    • updateQueue

      @Deprecated 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
      Deprecated.
      Update a queue
      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
      Throws:
      Exception

    • updateQueue

      @Deprecated 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
      Deprecated.
      Update a queue
      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
      Throws:
      Exception

    • updateQueue

      @Deprecated 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
      Deprecated.
      Update a queue
      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
      Throws:
      Exception

    • deployQueue

      @Deprecated void deployQueue(String address, String name, String filter) throws Exception
      Deprecated.
      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.

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      filter - of the queue
      Throws:
      Exception

    • deployQueue

      @Deprecated void deployQueue(String address, String name, String filter, boolean durable) throws Exception
      Deprecated.
      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.

      Parameters:
      address - address to bind the queue to
      name - name of the queue
      filter - of the queue
      durable - whether the queue is durable
      Throws:
      Exception

    • destroyQueue

      void destroyQueue(String name) throws Exception
      Destroys the queue corresponding to the specified name.
      Throws:
      Exception

    • destroyQueue

      void destroyQueue(String name, boolean removeConsumers) throws Exception
      Destroys the queue corresponding to the specified name.
      Throws:
      Exception

    • destroyQueue

      void destroyQueue(String name, boolean removeConsumers, boolean autoDeleteAddress) throws Exception
      Destroys the queue corresponding to the specified name and delete it's address if there are no other queues
      Throws:
      Exception

    • enableMessageCounters

      void enableMessageCounters() throws Exception
      Enables message counters for this server.
      Throws:
      Exception

    • disableMessageCounters

      void disableMessageCounters() throws Exception
      Disables message counters for this server.
      Throws:
      Exception

    • resetAllMessageCounters

      void resetAllMessageCounters() throws Exception
      Reset all message counters.
      Throws:
      Exception

    • resetAllMessageCounterHistories

      void resetAllMessageCounterHistories() throws Exception
      Reset histories for all message counters.
      Throws:
      Exception

    • listPreparedTransactions

      String[] listPreparedTransactions() throws Exception
      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.

      Throws:
      Exception
      See Also:

    • listPreparedTransactionDetailsAsJSON

      String listPreparedTransactionDetailsAsJSON() throws Exception
      List all the prepared transaction as JSON. The JSON consists of an array of objects containing the details of each transaction, including transaction branch details, and an array listing the messages involved, e.g.: 
      [
  {
    "creation_time": "5/22/79, 12:00:00 AM",
    "xid_as_base64": "eGExODAyZDNlOGItZDlmYy0xMWYwLTliOWUtM2NlMWExZDEyOTM5AQAAAA==",
    "xid_format_id": 1,
    "xid_global_txid": "802d3e8b-d9fc-11f0-9b9e-3ce1a1d12939",
    "xid_branch_qual": "xa1",
    "tx_related_messages": [
      {
        "message_operation_type": "(+) send",
        "message_type": "TextMessage",
        "message_properties": {
          "durable": true,
          "address": "AddressA",
          "myPropertyKey": "myPropertyValue",
          "messageID": 123,
          "expiration": 0,
          "type": 3,
          "priority": 4,
          "timestamp": 296197200
        }
      },
      {
        "message_operation_type": "(+) send",
        "message_type": "TextMessage",
        "message_properties": {
          "durable": true,
          "address": "AddressB",
          "messageID": 456,
          "expiration": 0,
          "type": 3,
          "priority": 4,
          "timestamp": 296197200
        },
      },
      {
        "message_operation_type": "(-) receive",
        "message_type": "TextMessage",
        "message_properties": {
          "durable": true,
          "address": "AddressC",
          "messageID": 789,
          "expiration": 0,
          "type": 3,
          "priority": 4,
          "timestamp": 296197200
        }
      }
    ]
  }
]
      Transactions are sorted by date, oldest first.
      Throws:
      Exception

    • listPreparedTransactionDetailsAsHTML

      @Deprecated(forRemoval=true) String listPreparedTransactionDetailsAsHTML() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use listPreparedTransactionDetailsAsJSON() instead.
      List all the prepared transaction, sorted by date, oldest first, with details, in HTML format
      Throws:
      Exception

    • listHeuristicCommittedTransactions

      String[] listHeuristicCommittedTransactions() throws Exception
      List transactions which have been heuristically committed.
      Throws:
      Exception

    • listHeuristicRolledBackTransactions

      String[] listHeuristicRolledBackTransactions() throws Exception
      List transactions which have been heuristically rolled back.
      Throws:
      Exception

    • commitPreparedTransaction

      boolean commitPreparedTransaction(String transactionAsBase64) throws Exception
      Heuristically commits a prepared transaction.
      Parameters:
      transactionAsBase64 - base 64 representation of a prepare transaction
      Returns:
      true if the transaction was successfully committed, false else
      Throws:
      Exception
      See Also:

    • rollbackPreparedTransaction

      boolean rollbackPreparedTransaction(String transactionAsBase64) throws Exception
      Heuristically rolls back a prepared transaction.
      Parameters:
      transactionAsBase64 - base 64 representation of a prepare transaction
      Returns:
      true if the transaction was successfully rolled back, false else
      Throws:
      Exception
      See Also:

    • listRemoteAddresses

      String[] listRemoteAddresses() throws Exception
      Lists the addresses of all the clients connected to this address.
      Throws:
      Exception

    • listRemoteAddresses

      String[] listRemoteAddresses(String ipAddress) throws Exception
      Lists the addresses of the clients connected to this address which matches the specified IP address.
      Throws:
      Exception

    • closeConnectionsForAddress

      boolean closeConnectionsForAddress(String ipAddress) throws Exception
      Closes all the connections of clients connected to this server which matches the specified IP address.
      Throws:
      Exception

    • closeConsumerConnectionsForAddress

      boolean closeConsumerConnectionsForAddress(String address) throws Exception
      Closes all the connections of clients connected to this server which matches the specified IP address.
      Throws:
      Exception

    • closeConnectionsForUser

      boolean closeConnectionsForUser(String address) throws Exception
      Closes all the connections of sessions with a matching user name.
      Throws:
      Exception

    • closeConnectionWithID

      boolean closeConnectionWithID(String ID) throws Exception
      Closes the connection with the given id.
      Throws:
      Exception

    • closeSessionWithID

      boolean closeSessionWithID(String connectionID, String ID) throws Exception
      Closes the session with the given id.
      Throws:
      Exception

    • closeSessionWithID

      boolean closeSessionWithID(String connectionID, String ID, boolean force) throws Exception
      Closes the session with the given id.
      Throws:
      Exception

    • closeConsumerWithID

      boolean closeConsumerWithID(String sessionID, String ID) throws Exception
      Closes the consumer with the given id.
      Throws:
      Exception

    • listConnectionIDs

      String[] listConnectionIDs() throws Exception
      Lists all the IDs of the connections connected to this server.
      Throws:
      Exception

    • listProducersInfoAsJSON

      String listProducersInfoAsJSON() throws Exception
      List details as JSON about the producers sending messages to this broker. The JSON consists of an array of objects containing details about each producer, e.g.: 
      [
  {
    "id": "1",
    "name": "artemis:sender:ID:338502e5-da02-11f0-900f-3ce1a1d12939",
    "connectionID": "33848db2-da02-11f0-900f-3ce1a1d12939",
    "sessionID": "3384b4c4-da02-11f0-900f-3ce1a1d12939",
    "creationTime": "1765836343763",
    "destination": "AddressA",
    "lastProducedMessageID": null,
    "msgSent": 8,
    "msgSizeSent": 607
  }
]
      Throws:
      Exception

    • listConnectionsAsJSON

      String listConnectionsAsJSON() throws Exception
      Lists all the connections to this server as JSON. The JSON consists of an array of objects containing details about each connection, e.g.: 
      [
  {
    "creationTime": 1469240429671,
    "sessionCount": 1,
    "implementation": "RemotingConnectionImpl",
    "connectionID": "1648309901",
    "clientAddress": "127.0.0.1:57649"
  }
]
      Throws:
      Exception

    • listConsumersAsJSON

      String listConsumersAsJSON(String connectionID) throws Exception
      Lists all the consumers that belong to the connection specified by the connectionID. The returned String is JSON 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"
  }
]
      Throws:
      Exception

    • listAllConsumersAsJSON

      String listAllConsumersAsJSON() throws Exception
      Lists all the consumers connected to this server. The returned String is JSON 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"
  }
]
      Throws:
      Exception

    • listSessionsAsJSON

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

    • listAllSessionsAsJSON

      String listAllSessionsAsJSON() throws Exception
      Lists details about all sessions. The returned String is JSON containing details about 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"
  }
]
      Throws:
      Exception

    • listSessions

      String[] listSessions(String connectionID) throws Exception
      Lists all the sessions IDs for the specified connection ID.
      Throws:
      Exception

    • addSecuritySettings

      @Deprecated(forRemoval=true) void addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addSecuritySettings(String, String)
      Throws:
      Exception

    • addSecuritySettings

      @Deprecated(forRemoval=true) void addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles, String browseRoles) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addSecuritySettings(String, String)
      Throws:
      Exception

    • addSecuritySettings

      @Deprecated(forRemoval=true) 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addSecuritySettings(String, String)
      Throws:
      Exception

    • addSecuritySettings

      @Deprecated(forRemoval=true) void addSecuritySettings(String addressMatch, String sendRoles, String consumeRoles, String createDurableQueueRoles, String deleteDurableQueueRoles, String createNonDurableQueueRoles, String deleteNonDurableQueueRoles, String manageRoles, String browseRoles, String createAddressRoles, String deleteAddressRoles, String viewRoles, String editRoles) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addSecuritySettings(String, String)
      Throws:
      Exception

    • addSecuritySettings

      void addSecuritySettings(String addressMatch, String securitySettingsAsJson) throws Exception
      Add security-settings for matching addresses.
      Parameters:
      addressMatch - The address match pattern to which the security-settings will be applied.
      securitySettingsAsJson - The security-settings in JSON format. The JSON consists of key/value pairs where the key is a string representing the permission type, and the value is an array of strings containing the names of the roles which will be granted the corresponding permission, e.g.: 
                                    {
                                "send": ["role1", "role2"],
                                "consume": ["role3", "role4"],
                                "createDurableQueue": ["role5", "role6"]
                              }
      These permission types are supported:
      • send
      • consume
      • createDurableQueue
      • deleteDurableQueue
      • createNonDurableQueue
      • deleteNonDurableQueue
      • manage
      • browse
      • createAddress
      • deleteAddress
      • view
      • edit
      This JSON can be constructed using methods from SecurityFormatter.
      Throws:
      Exception - If an error occurs while adding the security-settings.

    • removeSecuritySettings

      void removeSecuritySettings(String addressMatch) throws Exception
      Throws:
      Exception

    • getRoles

      Object[] getRoles(String addressMatch) throws Exception
      Throws:
      Exception

    • getRolesAsJSON

      String getRolesAsJSON(String addressMatch) throws Exception
      Retrieves roles associated with a specific address match as JSON. The JSON consists of an array of objects containing the name of the role and a boolean for every permission type indicating whether that role has that permission, e.g.: 
      [
  {
    "name": "myRole",
    "send": true,
    "consume": true,
    "createDurableQueue": false,
    "deleteDurableQueue": false,
    "createNonDurableQueue": true,
    "deleteNonDurableQueue": false,
    "manage": false,
    "browse": false,
    "createAddress": true,
    "deleteAddress": true,
    "view": false,
    "edit": false
  },
  {
    "name": "myOtherRole",
    "send": false,
    "consume": true,
    "createDurableQueue": false,
    "deleteDurableQueue": true,
    "createNonDurableQueue": true,
    "deleteNonDurableQueue": false,
    "manage": false,
    "browse": true,
    "createAddress": false,
    "deleteAddress": false,
    "view": false,
    "edit": false
  }
]
      This JSON can be converted into an array of RoleInfo objects using RoleInfo.from(String).
      Parameters:
      addressMatch - the address match for which roles are to be retrieved
      Returns:
      JSON representing the roles associated with the specified address match
      Throws:
      Exception - if an error occurs during the retrieval process

    • addAddressSettings

      @Deprecated(forRemoval=true) void addAddressSettings(String addressMatch, 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addAddressSettings(String, String) instead.
      adds a new address setting for a specific address
      Throws:
      Exception

    • addAddressSettings

      @Deprecated(forRemoval=true) void addAddressSettings(String addressMatch, 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, boolean autoCreateQueues, boolean autoDeleteQueues, boolean autoCreateAddresses, boolean autoDeleteAddresses) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addAddressSettings(String, String) instead.
      adds a new address setting for a specific address
      Throws:
      Exception

    • addAddressSettings

      @Deprecated(forRemoval=true) void addAddressSettings(String addressMatch, 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, 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addAddressSettings(String, String) instead.
      adds a new address setting for a specific address
      Throws:
      Exception

    • addAddressSettings

      @Deprecated(forRemoval=true) void addAddressSettings(String addressMatch, 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, 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addAddressSettings(String, String) instead.
      adds a new address setting for a specific address
      Throws:
      Exception

    • addAddressSettings

      @Deprecated(forRemoval=true) void addAddressSettings(String addressMatch, String DLA, String expiryAddress, long expiryDelay, boolean lastValueQueue, int maxDeliveryAttempts, long maxSizeBytes, int pageSizeBytes, int pageCacheMaxSize, 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use addAddressSettings(String, String) instead.
      adds a new address setting for a specific address
      Throws:
      Exception

    • addAddressSettings

      String addAddressSettings(String address, String addressSettingsAsJson) throws Exception
      Adds address-settings for matching addresses. The address-settings must be JSON consisting of a simple object of key/value pairs, e.g.: 
      {
  "addressFullMessagePolicy": "DROP",
  "maxSizeBytes": 1024,
  "prefetchPageMessages": 256,
  "redeliveryDelay": 60000,
  "redeliveryMultiplier": 1.0,
  "deadLetterAddress": "myDeadLetterAddress",
  "expiryAddress": "myExpiryAddress"
}
      Parameters:
      address - the address match pattern for the addresses to apply settings to
      addressSettingsAsJson - the configuration of the address settings as JSON
      Returns:
      the effective settings for the input address once the input settings are merged with any existing matches
      Throws:
      Exception - if there is an error adding the address settings

    • removeAddressSettings

      void removeAddressSettings(String addressMatch) throws Exception
      Throws:
      Exception

    • getAddressSettingsAsJSON

      String getAddressSettingsAsJSON(String addressMatch) throws Exception
      Get address-settings for matching address, e.g.: 
      {
  "addressFullMessagePolicy": "DROP",
  "maxSizeBytes": 1024,
  "prefetchPageMessages": 256,
  "redeliveryDelay": 60000,
  "redeliveryMultiplier": 1.0,
  "deadLetterAddress": "myDeadLetterAddress",
  "expiryAddress": "myExpiryAddress"
}
      Returns:
      the address-settings as JSON
      Throws:
      Exception

    • getDivertNames

      String[] getDivertNames()

    • listDivertNames

      default String[] listDivertNames()
      Jon plugin doesn't recognize an Operation whose name is in form getXXXX(), so add this one.

    • createDivert

      @Deprecated(forRemoval=true) void createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favor of createDivert(String)
      Throws:
      Exception

    • createDivert

      @Deprecated(forRemoval=true) void createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favor of createDivert(String)
      Throws:
      Exception

    • createDivert

      @Deprecated(forRemoval=true) void createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, Map<String,String> transformerProperties, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favor of createDivert(String)
      Throws:
      Exception

    • createDivert

      @Deprecated(forRemoval=true) void createDivert(String name, String routingName, String address, String forwardingAddress, boolean exclusive, String filterString, String transformerClassName, String transformerPropertiesAsJSON, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favor of createDivert(String)
      Throws:
      Exception

    • createDivert

      void createDivert(String divertConfiguration) throws Exception
      Adds a divert. The divert configuration must be JSON consisting of a simple object of key/value pairs, e.g.: 
      {
  "name": "myDivert",
  "address": "myAddress",
  "forwarding-address": "myForwardingAddress",
  "exclusive": false,
  "routing-type": "STRIP"
}
      Parameters:
      divertConfiguration - the configuration of the divert in JSON format
      Throws:
      Exception

    • updateDivert

      @Deprecated(forRemoval=true) void updateDivert(String name, String forwardingAddress, String filterString, String transformerClassName, Map<String,String> transformerProperties, String routingType) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use createDivert(String) instead.
      update a divert
      Throws:
      Exception

    • updateDivert

      void updateDivert(String divertConfiguration) throws Exception
      Updates a divert. The divert configuration must be JSON consisting of a simple object of key/value pairs. For an example, see createDivert(String).
      Throws:
      Exception

    • destroyDivert

      void destroyDivert(String name) throws Exception
      Throws:
      Exception

    • getBridgeNames

      String[] getBridgeNames()

    • createBridge

      @Deprecated(forRemoval=true) 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 connectorNames, boolean useDiscoveryGroup, boolean ha, String user, String password) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favour of createBridge(String)
      Throws:
      Exception

    • createBridge

      @Deprecated(forRemoval=true) 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 connectorNames, boolean useDiscoveryGroup, boolean ha, String user, String password) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favour of createBridge(String)
      Throws:
      Exception

    • createBridge

      @Deprecated(forRemoval=true) 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 connectorNames, boolean useDiscoveryGroup, boolean ha, String user, String password) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favour of createBridge(String)
      Throws:
      Exception

    • createBridge

      @Deprecated(forRemoval=true) 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 connectorNames, boolean useDiscoveryGroup, boolean ha, String user, String password) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deprecated in favour of createBridge(String)
      Throws:
      Exception

    • createBridge

      void createBridge(String bridgeConfiguration) throws Exception
      Create a bridge. The bridge configuration must be JSON consisting of a simple object of key/value pairs, e.g.: 
      {
  "name": "myBridge",
  "queue-name": "myQueue",
  "forwarding-address": "myForwardingAddress",
  "retry-interval": 2000,
  "retry-interval-multiplier": 1.0,
  "reconnect-attempts": -1,
  "use-duplicate-detection": false,
  "producer-window-size": -1,
  "routing-type": "PASS",
  "static-connectors": [
    "myConnector"
  ]
}
      Parameters:
      bridgeConfiguration - the configuration of the queue in JSON format
      Throws:
      Exception

    • destroyBridge

      void destroyBridge(String name) throws Exception
      Throws:
      Exception

    • addConnector

      void addConnector(String name, String url) throws Exception
      Throws:
      Exception

    • removeConnector

      void removeConnector(String name) throws Exception
      Throws:
      Exception

    • listBrokerConnections

      String listBrokerConnections()

    • startBrokerConnection

      void startBrokerConnection(String name) throws Exception
      Throws:
      Exception

    • stopBrokerConnection

      void stopBrokerConnection(String name) throws Exception
      Throws:
      Exception

    • createConnectorService

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

    • destroyConnectorService

      void destroyConnectorService(String name) throws Exception
      Throws:
      Exception

    • getConnectorServices

      String[] getConnectorServices()

    • forceFailover

      void forceFailover() throws Exception
      Throws:
      Exception

    • scaleDown

      void scaleDown(String connector) throws Exception
      Throws:
      Exception

    • listNetworkTopology

      String listNetworkTopology() throws Exception
      Throws:
      Exception

    • getAddressInfo

      String getAddressInfo(String address) throws ActiveMQAddressDoesNotExistException
      Throws:
      ActiveMQAddressDoesNotExistException

    • listBindingsForAddress

      String listBindingsForAddress(String address) throws Exception
      Throws:
      Exception

    • listAddresses

      String listAddresses(String separator) throws Exception
      Throws:
      Exception

    • listConnections

      String listConnections(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • listSessions

      String listSessions(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • listConsumers

      String listConsumers(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • listProducers

      String listProducers(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • listAddresses

      String listAddresses(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • listQueues

      String listQueues(String options, int page, int pageSize) throws Exception
      Throws:
      Exception

    • getQueueNames

      String[] getQueueNames(String routingType) throws Exception
      Returns the names of the queues created on this server with the given routing-type..
      Returns:
      the names of the queues created on this server with the given routing-type.
      Throws:
      Exception

    • getClusterConnectionNames

      String[] getClusterConnectionNames()
      Returns the names of the cluster-connections deployed on this server..
      Returns:
      the names of the cluster-connections deployed on this server.

    • addUser

      void addUser(String username, String password, String roles, boolean plaintext) throws Exception
      Add a user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager)
      Throws:
      Exception

    • listUser

      String listUser(String username) throws Exception
      List the information about a user or all users if no username is supplied (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
      Returns:
      JSON array of user and role information
      Throws:
      Exception

    • removeUser

      void removeUser(String username) throws Exception
      Remove a user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
      Throws:
      Exception

    • resetUser

      void resetUser(String username, String password, String roles) throws Exception
      Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
      Throws:
      Exception

    • resetUser

      void resetUser(String username, String password, String roles, boolean plaintext) throws Exception
      Set new properties on an existing user (only applicable when using the JAAS PropertiesLoginModule or the ActiveMQBasicSecurityManager).
      Throws:
      Exception

    • reloadConfigurationFile

      void reloadConfigurationFile() throws Exception
      Throws:
      Exception

    • replay

      void replay(String address, String target, String filter) throws Exception
      Replays messages from all files in the retention folder that match an address and filter.
      Throws:
      Exception

    • replay

      void replay(String startScan, String endScan, String address, String target, String filter) throws Exception
      Replays messages from a configurable subset of the files in the retention folder that match an address and filter.
      Throws:
      Exception

    • stopEmbeddedWebServer

      void stopEmbeddedWebServer() throws Exception
      Throws:
      Exception

    • startEmbeddedWebServer

      void startEmbeddedWebServer() throws Exception
      Throws:
      Exception

    • restartEmbeddedWebServer

      void restartEmbeddedWebServer() throws Exception
      Throws:
      Exception

    • restartEmbeddedWebServer

      void restartEmbeddedWebServer(long timeout) throws Exception
      Throws:
      Exception

    • isEmbeddedWebServerStarted

      boolean isEmbeddedWebServerStarted()

    • rebuildPageCounters

      void rebuildPageCounters() throws Exception
      Throws:
      Exception

    • clearAuthenticationCache

      void clearAuthenticationCache() throws Exception
      Throws:
      Exception

    • clearAuthorizationCache

      void clearAuthorizationCache() throws Exception
      Throws:
      Exception

    • getAuthenticationSuccessCount

      long getAuthenticationSuccessCount()

    • getAuthenticationFailureCount

      long getAuthenticationFailureCount()

    • getAuthorizationSuccessCount

      long getAuthorizationSuccessCount()

    • getAuthorizationFailureCount

      long getAuthorizationFailureCount()

    • getPendingMirrorAcks

      int getPendingMirrorAcks()

    • exportConfigAsProperties

      void exportConfigAsProperties() throws Exception
      Throws:
      Exception