Package org.apache.activemq.artemis.cli.commands.queue

Class StatQueue

java.lang.Object

org.apache.activemq.artemis.cli.commands.ActionAbstract

org.apache.activemq.artemis.cli.commands.InputAbstract

org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract

org.apache.activemq.artemis.cli.commands.AbstractAction

org.apache.activemq.artemis.cli.commands.queue.StatQueue

All Implemented Interfaces:

Action

@Command(name="stat",
         description="prints out basic stats associated with queues. Output includes CONSUMER_COUNT (number of consumers), MESSAGE_COUNT (current message count on the queue, including scheduled, paged and in-delivery messages), MESSAGES_ADDED (messages added to the queue), DELIVERING_COUNT (messages broker is currently delivering to consumer(s)), MESSAGES_ACKED (messages acknowledged from the consumer(s)). Queues can be filtered using EITHER \'--queueName X\' where X is contained in the queue name OR using a full filter \'--field NAME --operation EQUALS --value X\'.")
public class StatQueue
extends AbstractAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatQueue.FIELD
static class	StatQueue.OPERATION

Nested classes/interfaces inherited from class org.apache.activemq.artemis.cli.commands.AbstractAction

AbstractAction.ManagementCallback<T>

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_COLUMN_SIZE
static int	DEFAULT_MAX_ROWS

Fields inherited from class org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract

acceptor, brokerURL, clientID, password, protocol, user

Fields inherited from class org.apache.activemq.artemis.cli.commands.ActionAbstract

context, DEFAULT_BROKER_ACCEPTOR, DEFAULT_BROKER_URL, verbose

Constructor Summary

Constructors

Constructor	Description
StatQueue()

Method Summary

Modifier and Type	Method	Description
Object	execute(ActionContext context)
StatQueue	setFieldName(String fieldName)
StatQueue	setMaxColumnSize(int maxColumnSize)
StatQueue	setMaxRows(int maxRows)
StatQueue	setOperationName(String operationName)
StatQueue	setQueueName(String queueName)
StatQueue	setValue(String value)
StatQueue	setverbose(boolean verbose)

Methods inherited from class org.apache.activemq.artemis.cli.commands.AbstractAction

performCoreManagement

Methods inherited from class org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract

createConnectionFactory, createConnectionFactory, createCoreConnectionFactory, createCoreConnectionFactory, getAcceptor, getBrokerURL, getClientID, getPassword, getProtocol, getUser, setAcceptor, setBrokerURL, setClientID, setPassword, setProtocol, setUser

Methods inherited from class org.apache.activemq.artemis.cli.commands.InputAbstract

enableInput, input, input, inputBoolean, inputInteger, inputPassword, isSilentInput, setSilentInput

Methods inherited from class org.apache.activemq.artemis.cli.commands.ActionAbstract

checkOptions, getBrokerConfiguration, getBrokerEtc, getBrokerHome, getBrokerInstance, getBrokerURIInstance, getBrokerURLInstance, isVerbose, setHomeValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_ROWS

public static final int DEFAULT_MAX_ROWS

See Also:

Constant Field Values

DEFAULT_MAX_COLUMN_SIZE

public static final int DEFAULT_MAX_COLUMN_SIZE

See Also:

Constant Field Values

Constructor Detail

StatQueue

public StatQueue()

Method Detail

setQueueName

public StatQueue setQueueName(String queueName)

setOperationName

public StatQueue setOperationName(String operationName)

setFieldName

public StatQueue setFieldName(String fieldName)

setValue

public StatQueue setValue(String value)

setMaxRows

public StatQueue setMaxRows(int maxRows)

setMaxColumnSize

public StatQueue setMaxColumnSize(int maxColumnSize)

setverbose

public StatQueue setverbose(boolean verbose)

execute

public Object execute(ActionContext context)
               throws Exception

Specified by:

execute in interface Action

Overrides:

execute in class ConnectionAbstract

Throws:

Exception