org.apache.activemq.broker.jmx
Interface SubscriptionViewMBean

All Known Subinterfaces:
DurableSubscriptionViewMBean, TopicSubscriptionViewMBean
All Known Implementing Classes:
DurableSubscriptionView, InactiveDurableSubscriptionView, SubscriptionView, TopicSubscriptionView

public interface SubscriptionViewMBean


Method Summary
 String getClientId()
           
 ObjectName getConnection()
          Returns the ObjectName of the Connection that created this Subscription.
 String getConnectionId()
           
 long getDequeueCounter()
           
 String getDestinationName()
           
 long getDispatchedCounter()
           
 int getDispatchedQueueSize()
           
 long getEnqueueCounter()
           
 int getMaximumPendingMessageLimit()
           
 int getMessageCountAwaitingAcknowledge()
          The same as the number of messages dispatched - making it explicit
 int getPendingQueueSize()
           
 int getPrefetchSize()
           
 byte getPriority()
           
 String getSelector()
           
 long getSessionId()
           
 long getSubcriptionId()
           
 String getSubcriptionName()
           
 String getUserName()
          Returns the User Name used to authorize creation of this Subscription.
 boolean isActive()
           
 boolean isDestinationQueue()
           
 boolean isDestinationTemporary()
           
 boolean isDestinationTopic()
           
 boolean isDurable()
           
 boolean isExclusive()
           
 boolean isMatchingQueue(String queueName)
          Returns true if this subscription (which may be using wildcards) matches the given queue name
 boolean isMatchingTopic(String topicName)
          Returns true if this subscription (which may be using wildcards) matches the given topic name
 boolean isNetwork()
           
 boolean isNoLocal()
           
 boolean isRetroactive()
           
 boolean isSlowConsumer()
          Returns true if the subscription is slow
 void setSelector(String selector)
          Attempts to change the current active selector on the subscription.
 

Method Detail

getClientId

String getClientId()
Returns:
the clientId of the Connection the Subscription is on

getConnectionId

String getConnectionId()
Returns:
the id of the Connection the Subscription is on

getSessionId

long getSessionId()
Returns:
the id of the Session the subscription is on

getSubcriptionId

long getSubcriptionId()
Returns:
the id of the Subscription

getDestinationName

String getDestinationName()
Returns:
the destination name

getSelector

String getSelector()
Returns:
the JMS selector on the current subscription

setSelector

void setSelector(String selector)
                 throws InvalidSelectorException,
                        UnsupportedOperationException
Attempts to change the current active selector on the subscription. This operation is not supported for persistent topics.

Throws:
InvalidSelectorException
UnsupportedOperationException

isDestinationQueue

boolean isDestinationQueue()
Returns:
true if the destination is a Queue

isDestinationTopic

boolean isDestinationTopic()
Returns:
true of the destination is a Topic

isDestinationTemporary

boolean isDestinationTemporary()
Returns:
true if the destination is temporary

isActive

boolean isActive()
Returns:
true if the subscriber is active

isNetwork

boolean isNetwork()

getPendingQueueSize

int getPendingQueueSize()
Returns:
number of messages pending delivery

getDispatchedQueueSize

int getDispatchedQueueSize()
Returns:
number of messages dispatched

getMessageCountAwaitingAcknowledge

int getMessageCountAwaitingAcknowledge()
The same as the number of messages dispatched - making it explicit

Returns:

getDispatchedCounter

long getDispatchedCounter()
Returns:
number of messages that matched the subscription

getEnqueueCounter

long getEnqueueCounter()
Returns:
number of messages that matched the subscription

getDequeueCounter

long getDequeueCounter()
Returns:
number of messages queued by the client

getPrefetchSize

int getPrefetchSize()
Returns:
the prefetch that has been configured for this subscriber

isRetroactive

boolean isRetroactive()
Returns:
whether or not the subscriber is retroactive or not

isExclusive

boolean isExclusive()
Returns:
whether or not the subscriber is an exclusive consumer

isDurable

boolean isDurable()
Returns:
whether or not the subscriber is durable (persistent)

isNoLocal

boolean isNoLocal()
Returns:
whether or not the subscriber ignores local messages

getMaximumPendingMessageLimit

int getMaximumPendingMessageLimit()
Returns:
the maximum number of pending messages allowed in addition to the prefetch size. If enabled to a non-zero value then this will perform eviction of messages for slow consumers on non-durable topics.

getPriority

byte getPriority()
Returns:
the consumer priority

getSubcriptionName

String getSubcriptionName()
Returns:
the name of the consumer which is only used for durable consumers.

isMatchingQueue

boolean isMatchingQueue(String queueName)
Returns true if this subscription (which may be using wildcards) matches the given queue name

Parameters:
queueName - the JMS queue name to match against
Returns:
true if this subscription matches the given queue or false if not

isMatchingTopic

boolean isMatchingTopic(String topicName)
Returns true if this subscription (which may be using wildcards) matches the given topic name

Parameters:
topicName - the JMS topic name to match against
Returns:
true if this subscription matches the given topic or false if not

isSlowConsumer

boolean isSlowConsumer()
Returns true if the subscription is slow

Returns:
true if the subscription is slow

getUserName

String getUserName()
Returns the User Name used to authorize creation of this Subscription. This value can be null if display of user name information is disabled.

Returns:
the name of the user that created this Subscription

getConnection

ObjectName getConnection()
Returns the ObjectName of the Connection that created this Subscription. This value can be null if for instance this is an off-line durable subscription.

Returns:
the name of the Connection that created this Subscription.


Copyright © 2005–2013 The Apache Software Foundation. All rights reserved.