Uses of Class org.apache.activemq.artemis.api.core.management.Attribute (ActiveMQ Artemis Web 1.5.3.jbossorg-002 API)
Date: 2017-02-15

## Uses of Class
org.apache.activemq.artemis.api.core.management.Attribute

- Packages that use Attribute
  Package | Description
  --- | ---
  org.apache.activemq.artemis.api.core.management |
  org.apache.activemq.artemis.api.jms.management |

- - ### Uses of Attribute in org.apache.activemq.artemis.api.core.management

    Methods in org.apache.activemq.artemis.api.core.management with annotations of type Attribute
    Modifier and Type | Method and Description
    --- | ---
    `String` | QueueControl.`getAddress()` Returns the address this queue is bound to.
    `String` | DivertControl.`getAddress()` Returns the origin address used by this divert.
    `String` | ClusterConnectionControl.`getAddress()` Returns the address used by this cluster connection.
    `String` | AddressControl.`getAddress()` Returns the managed address.
    `String[]` | ActiveMQServerControl.`getAddressNames()` Returns the addresses created on this server.
    `long` | AddressControl.`getAddressSize()` Returns the number of estimated bytes being used by the queue(s), used to control paging and blocking.
    `String[]` | AddressControl.`getBindingNames()` Returns the names of all bindings (both queues and diverts) bound to this address
    `String` | ActiveMQServerControl.`getBindingsDirectory()` Returns the file system directory used to store bindings.
    `String[]` | ActiveMQServerControl.`getBridgeNames()`
    `long` | BroadcastGroupControl.`getBroadcastPeriod()` Returns the period used by this broadcast group.
    `int` | ActiveMQServerControl.`getConnectionCount()` Returns the number of clients connected to this server.
    `long` | ActiveMQServerControl.`getConnectionTTLOverride()` Returns the connection time to live.
    `Object[]` | BroadcastGroupControl.`getConnectorPairs()` Returns the pairs of live-backup connectors that are broadcasted by this broadcast group.
    `String` | BroadcastGroupControl.`getConnectorPairsAsJSON()` Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.
    `Object[]` | ActiveMQServerControl.`getConnectors()` Returns the connectors configured for this server.
    `String` | ActiveMQServerControl.`getConnectorsAsJSON()` Returns the connectors configured for this server using JSON serialization.
    `String[]` | ActiveMQServerControl.`getConnectorServices()`
    `int` | QueueControl.`getConsumerCount()` Returns the number of consumers consuming messages from this queue.
    `String` | QueueControl.`getDeadLetterAddress()` Returns the dead-letter address associated with this queue.
    `int` | QueueControl.`getDeliveringCount()` Returns the number of messages that this queue is currently delivering to its consumers.
    `String` | ClusterConnectionControl.`getDiscoveryGroupName()` Returns the name of the discovery group used by this cluster connection.
    `String` | BridgeControl.`getDiscoveryGroupName()` Returns the name of the discovery group used by this bridge.
    `int` | ActiveMQServerControl.`getDiskScanPeriod()` Returns how often the server checks for disk space usage.
    `String[]` | ActiveMQServerControl.`getDivertNames()`
    `String` | QueueControl.`getExpiryAddress()` Returns the expiry address associated with this queue.
    `String` | AcceptorControl.`getFactoryClassName()` Returns the class name of the AcceptorFactory implementation used by this acceptor.
    `String` | QueueControl.`getFilter()` Returns the filter associated with this queue.
    `String` | DivertControl.`getFilter()` Returns the filter used by this divert.
    `String` | BridgeControl.`getFilterString()` Returns the filter string associated with this bridge.
    `Long` | QueueControl.`getFirstMessageAge()` Returns the age of the first message in milliseconds.
    `String` | QueueControl.`getFirstMessageAsJSON()` Returns the first message on the queue as JSON
    `Long` | QueueControl.`getFirstMessageTimestamp()` Returns the timestamp of the first message in milliseconds.
    `String` | DivertControl.`getForwardingAddress()` Returns the forwarding address used by this divert.
    `String` | BridgeControl.`getForwardingAddress()` Returns the address this bridge will forward messages to.
    `long` | ActiveMQServerControl.`getGlobalMaxSize()` Returns the global max bytes limit for in-memory messages.
    `String` | BroadcastGroupControl.`getGroupAddress()` Returns the address this broadcast group is broadcasting to.
    `int` | BroadcastGroupControl.`getGroupPort()` Returns the port this broadcast group is broadcasting to.
    `long` | QueueControl.`getID()` Returns this queue ID.
    `int` | ActiveMQServerControl.`getIDCacheSize()` Returns the size of the cache for pre-creating message IDs.
    `String[]` | ActiveMQServerControl.`getIncomingInterceptorClassNames()` Returns the list of interceptors used by this server for incoming messages.
    `int` | ActiveMQServerControl.`getJournalBufferSize()` Returns the size of the internal buffer on the journal.
    `int` | ActiveMQServerControl.`getJournalBufferTimeout()` Returns the timeout (in nanoseconds) used to flush internal buffers on the journal.
    `int` | ActiveMQServerControl.`getJournalCompactMinFiles()` Returns the minimal number of journal files before compacting.
    `int` | ActiveMQServerControl.`getJournalCompactPercentage()` Return the percentage of live data before compacting the journal.
    `String` | ActiveMQServerControl.`getJournalDirectory()` Returns the file system directory used to store journal log.
    `int` | ActiveMQServerControl.`getJournalFileSize()` Returns the size (in bytes) of each journal files.
    `int` | ActiveMQServerControl.`getJournalMaxIO()` Returns the maximum number of write requests that can be in the AIO queue at any given time.
    `int` | ActiveMQServerControl.`getJournalMinFiles()` Returns the number of journal files to pre-create.
    `String` | ActiveMQServerControl.`getJournalType()` Returns the type of journal used by this server (either `NIO` or `ASYNCIO`).
    `String` | ActiveMQServerControl.`getLargeMessagesDirectory()` Returns the file system directory used to store large messages.
    `int` | BroadcastGroupControl.`getLocalBindPort()` Returns the local port this broadcast group is bound to.
    `String` | ActiveMQServerControl.`getManagementAddress()` Returns the management address of this server.
    `String` | ActiveMQServerControl.`getManagementNotificationAddress()` Returns the management notification address of this server.
    `int` | ActiveMQServerControl.`getMaxDiskUsage()` Returns the disk use max limit.
    `int` | ClusterConnectionControl.`getMaxHops()` Returns the maximum number of hops used by this cluster connection.
    `long` | QueueControl.`getMessageCount()` Returns the number of messages currently in this queue.
    `int` | ActiveMQServerControl.`getMessageCounterMaxDayCount()` Returns the maximum number of days kept in memory for message counter.
    `long` | ActiveMQServerControl.`getMessageCounterSamplePeriod()` Returns the sample period (in milliseconds) to take message counter snapshot.
    `long` | ActiveMQServerControl.`getMessageExpiryScanPeriod()` Returns the frequency (in milliseconds) to scan messages to detect which messages have expired.
    `long` | ActiveMQServerControl.`getMessageExpiryThreadPriority()` Returns the priority of the thread used to scan message expiration.
    `String` | ClusterConnectionControl.`getMessageLoadBalancingType()` Return the type of message load balancing strategy this bridge will use.
    `long` | QueueControl.`getMessagesAcknowledged()` Returns the number of messages added to this queue since it was created.
    `long` | QueueControl.`getMessagesAdded()` Returns the number of messages added to this queue since it was created.
    `long` | QueueControl.`getMessagesExpired()` Returns the number of messages expired from this queue since it was created.
    `long` | QueueControl.`getMessagesKilled()` Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.
    `String` | QueueControl.`getName()` Returns the name of this queue.
    `String` | ClusterConnectionControl.`getName()` Returns the configuration name of this cluster connection.
    `String` | BroadcastGroupControl.`getName()` Returns the configuration name of this broadcast group.
    `String` | BridgeControl.`getName()` Returns the name of this bridge
    `String` | AcceptorControl.`getName()` Returns the name of the acceptor
    `String` | ClusterConnectionControl.`getNodeID()` Returns the node ID used by this cluster connection.
    `Map<String,String>` | ClusterConnectionControl.`getNodes()` Returns a map of the nodes connected to this cluster connection.
    `long` | AddressControl.`getNumberOfBytesPerPage()` Returns the number of bytes used by each page for this address.
    `long` | AddressControl.`getNumberOfMessages()` Returns the sum of messages on queue(s), including messages in delivery.
    `int` | AddressControl.`getNumberOfPages()` Returns the number of pages used by this address.
    `String[]` | ActiveMQServerControl.`getOutgoingInterceptorClassNames()` Returns the list of interceptors used by this server for outgoing messages.
    `String` | ActiveMQServerControl.`getPagingDirectory()` Returns the file system directory used to store paging files.
    `Map<String,Object>` | AcceptorControl.`getParameters()` Returns the parameters used to configure this acceptor
    `String` | BridgeControl.`getQueueName()` Returns the name of the queue this bridge is consuming messages from.
    `String[]` | AddressControl.`getQueueNames()` Returns the names of the queues bound to this address.
    `String[]` | ActiveMQServerControl.`getQueueNames()` Returns the names of the queues created on this server.
    `int` | BridgeControl.`getReconnectAttempts()` Returns the number of reconnection attempts used by this bridge.
    `long` | ClusterConnectionControl.`getRetryInterval()` Returns the connection retry interval used by this cluster connection.
    `long` | BridgeControl.`getRetryInterval()` Returns the retry interval used by this bridge.
    `double` | BridgeControl.`getRetryIntervalMultiplier()` Returns the retry interval multiplier used by this bridge.
    `Object[]` | AddressControl.`getRoles()` Returns the roles (name and permissions) associated with this address.
    `String` | AddressControl.`getRolesAsJSON()` Returns the roles (name and permissions) associated with this address using JSON serialization.
    `String` | DivertControl.`getRoutingName()` Returns the routing name of this divert.
    `long` | QueueControl.`getScheduledCount()` Returns the number of scheduled messages in this queue.
    `int` | ActiveMQServerControl.`getScheduledThreadPoolMaxSize()` Returns the maximum number of threads in the scheduled thread pool.
    `long` | ActiveMQServerControl.`getSecurityInvalidationInterval()` Returns the interval time (in milliseconds) to invalidate security credentials.
    `Object[]` | ClusterConnectionControl.`getStaticConnectors()` Returns the list of static connectors
    `String[]` | BridgeControl.`getStaticConnectors()` Returns any list of static connectors used by this bridge
    `String` | ClusterConnectionControl.`getStaticConnectorsAsJSON()` Returns the list of static connectors as JSON
    `int` | ActiveMQServerControl.`getThreadPoolMaxSize()` Returns the maximum number of threads in the thread pool.
    `String` | ClusterConnectionControl.`getTopology()` Return the Topology that this Cluster Connection knows about
    `long` | ActiveMQServerControl.`getTotalConnectionCount()` Returns the number of clients which have connected to this server since it was started.
    `long` | ActiveMQServerControl.`getTotalConsumerCount()` Returns the number of messages sent to this server since it was started.
    `long` | ActiveMQServerControl.`getTotalMessageCount()` Returns the number of messages in all queues on the server.
    `long` | ActiveMQServerControl.`getTotalMessagesAcknowledged()` Returns the number of messages sent to this server since it was started.
    `long` | ActiveMQServerControl.`getTotalMessagesAdded()` Returns the number of messages sent to this server since it was started.
    `long` | ActiveMQServerControl.`getTransactionTimeout()` Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.
    `long` | ActiveMQServerControl.`getTransactionTimeoutScanPeriod()` Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.
    `String` | DivertControl.`getTransformerClassName()` Return the name of the org.apache.activemq.artemis.core.server.cluster.Transformer implementation associated with this divert.
    `String` | BridgeControl.`getTransformerClassName()` Return the name of the org.apache.activemq.artemis.core.server.cluster.Transformer implementation associated with this bridge.
    `String` | DivertControl.`getUniqueName()` Returns the cluster-wide unique name of this divert.
    `String` | ActiveMQServerControl.`getUptime()` Returns the uptime of this server.
    `long` | ActiveMQServerControl.`getUptimeMillis()` Returns the uptime of this server.
    `String` | ActiveMQServerControl.`getVersion()` Returns this server's version.
    `boolean` | ActiveMQServerControl.`isAsyncConnectionExecutionEnabled()` Returns whether code coming from connection is executed asynchronously or not.
    `boolean` | ActiveMQServerControl.`isBackup()` Returns `true` if this server is a backup, `false` if it is a live server.
    `boolean` | ActiveMQServerControl.`isClustered()` Returns whether this server is clustered.
    `boolean` | ActiveMQServerControl.`isCreateBindingsDir()` Returns whether the bindings directory is created on this server startup.
    `boolean` | ActiveMQServerControl.`isCreateJournalDir()` Returns whether the journal directory is created on this server startup.
    `boolean` | ClusterConnectionControl.`isDuplicateDetection()` Return whether this cluster connection use duplicate detection.
    `boolean` | QueueControl.`isDurable()` Returns whether this queue is durable.
    `boolean` | DivertControl.`isExclusive()` Returns whether this divert is exclusive.
    `boolean` | ActiveMQServerControl.`isFailoverOnServerShutdown()` returns if clients failover on a server shutdown
    `boolean` | BridgeControl.`isHA()` Returns whether this bridge is using high availability
    `boolean` | ActiveMQServerControl.`isJournalSyncNonTransactional()` Returns whether the journal is synchronized when receiving non-transactional data.
    `boolean` | ActiveMQServerControl.`isJournalSyncTransactional()` Returns whether the journal is synchronized when receiving transactional data.
    `boolean` | ActiveMQServerControl.`isMessageCounterEnabled()` Returns whether message counter is enabled for this server.
    `boolean` | AddressControl.`isPaging()` Returns whether this address is paging.
    `boolean` | QueueControl.`isPaused()` Returns whether the queue is paused.
    `boolean` | ActiveMQServerControl.`isPersistDeliveryCountBeforeDelivery()` Returns whether delivery count is persisted before messages are delivered to the consumers.
    `boolean` | ActiveMQServerControl.`isPersistenceEnabled()` Returns whether this server is using persistence and store data.
    `boolean` | ActiveMQServerControl.`isPersistIDCache()` Returns whether message ID cache is persisted.
    `boolean` | ActiveMQServerControl.`isReplicaSync()` Returns whether the initial replication synchronization process with the backup server is complete; applicable for either the live or backup server.
    `boolean` | ActiveMQServerControl.`isSecurityEnabled()` Returns whether security is enabled for this server.
    `boolean` | ActiveMQServerControl.`isSharedStore()` Returns whether this server shares its data store with a corresponding live or backup server.
    `boolean` | ActiveMQServerControl.`isStarted()` Return whether this server is started.
    `boolean` | ActiveMQComponentControl.`isStarted()` Returns `true` if this component is started, `false` else.
    `boolean` | QueueControl.`isTemporary()` Returns whether this queue is temporary.
    `boolean` | BridgeControl.`isUseDuplicateDetection()` Returns whether this bridge is using duplicate detection.
    `boolean` | ActiveMQServerControl.`isWildcardRoutingEnabled()` Returns whether wildcard routing is supported by this server.
    `void` | ActiveMQServerControl.`setFailoverOnServerShutdown(boolean failoverOnServerShutdown)` do any clients failover on a server shutdown
    `void` | ActiveMQServerControl.`setMessageCounterMaxDayCount(int count)` Sets the maximum number of days kept in memory for message counter.
    `void` | ActiveMQServerControl.`setMessageCounterSamplePeriod(long newPeriod)` Sets the sample period to take message counter snapshot.

  - ### Uses of Attribute in org.apache.activemq.artemis.api.jms.management

    Methods in org.apache.activemq.artemis.api.jms.management with annotations of type Attribute
    Modifier and Type | Method and Description
    --- | ---
    `String` | DestinationControl.`getAddress()` Returns the address corresponding to this destination.
    `String[]` | JMSServerControl.`getConnectionFactoryNames()` Returns the names of the JMS connection factories available on this server.
    `int` | JMSQueueControl.`getConsumerCount()` Returns the number of consumers consuming messages from this queue.
    `String` | JMSQueueControl.`getDeadLetterAddress()` Returns the dead-letter address associated with this queue.
    `int` | DestinationControl.`getDeliveringCount()` Returns the number of messages that this queue is currently delivering to its consumers.
    `int` | TopicControl.`getDurableMessageCount()` Returns the number of messages for all durable subscribers for this topic.
    `int` | TopicControl.`getDurableSubscriptionCount()` Returns the number of durable subscribers for this topic.
    `String` | JMSQueueControl.`getExpiryAddress()` Returns the expiry address associated with this queue.
    `Long` | JMSQueueControl.`getFirstMessageAge()` Returns the age of the first message in milliseconds.
    `String` | JMSQueueControl.`getFirstMessageAsJSON()` Returns the first message on the queue as JSON
    `Long` | JMSQueueControl.`getFirstMessageTimestamp()` Returns the timestamp of the first message in milliseconds.
    `long` | DestinationControl.`getMessageCount()` Returns the number of messages currently in this destination.
    `long` | DestinationControl.`getMessagesAdded()` Returns the number of messages added to this queue since it was created.
    `long` | JMSQueueControl.`getMessagesExpired()` Returns the number of messages expired from this queue since it was created.
    `long` | JMSQueueControl.`getMessagesKilled()` Returns the number of messages removed from this queue since it was created due to exceeding the max delivery attempts.
    `String` | DestinationControl.`getName()` Returns the name of this destination.
    `String` | JMSServerControl.`getNodeID()` Returns the server's nodeId
    `int` | TopicControl.`getNonDurableMessageCount()` Returns the number of messages for all non-durable subscribers for this topic.
    `int` | TopicControl.`getNonDurableSubscriptionCount()` Returns the number of non-durable subscribers for this topic.
    `String[]` | JMSServerControl.`getQueueNames()` Returns the names of the JMS queues available on this server.
    `String[]` | TopicControl.`getRegistryBindings()` Returns the Registry bindings associated with this topic.
    `String[]` | JMSQueueControl.`getRegistryBindings()` Returns the Registry bindings associated with this queue.
    `long` | JMSQueueControl.`getScheduledCount()` Returns the number of scheduled messages in this queue.
    `String` | JMSQueueControl.`getSelector()` returns the selector for the queue
    `int` | TopicControl.`getSubscriptionCount()` Returns the number of (durable and non-durable) subscribers for this topic.
    `String[]` | JMSServerControl.`getTopicNames()` Returns the names of the JMS topics available on this server.
    `String` | JMSServerControl.`getVersion()` Returns this server's version
    `boolean` | JMSQueueControl.`isPaused()` Returns whether the queue is paused.
    `boolean` | JMSServerControl.`isStarted()` Returns whether this server is started.
    `boolean` | DestinationControl.`isTemporary()` Returns whether this destination is temporary.

Copyright © 2017 The Apache Software Foundation. All rights reserved.