Package org.apache.activemq.broker.jmx

Interface DurableSubscriptionViewMBean

All Superinterfaces:

SubscriptionViewMBean

All Known Implementing Classes:

DurableSubscriptionView, InactiveDurableSubscriptionView

public interface DurableSubscriptionViewMBean
extends SubscriptionViewMBean

Method Summary

Modifier and Type	Method	Description
CompositeData[]	browse()	Browse messages for this durable subscriber
TabularData	browseAsTable()	Browse messages for this durable subscriber
int	cursorSize()
void	destroy()	Destroys the durable subscription so that messages will no longer be stored for this subscription
boolean	doesCursorHaveMessagesBuffered()
boolean	doesCursorHaveSpace()
long	getCursorMemoryUsage()
int	getCursorPercentUsage()
String	getSubscriptionName()
boolean	isCursorFull()
void	removeMessage(String messageId)	Removes a message from the durable subscription.

Methods inherited from interface org.apache.activemq.broker.jmx.SubscriptionViewMBean

getClientId, getConnection, getConnectionId, getConsumedCount, getDequeueCounter, getDestinationName, getDispatchedCounter, getDispatchedQueueSize, getEnqueueCounter, getMaximumPendingMessageLimit, getMessageCountAwaitingAcknowledge, getPendingQueueSize, getPrefetchSize, getPriority, getSelector, getSessionId, getSubscriptionId, getUserName, isActive, isDestinationQueue, isDestinationTemporary, isDestinationTopic, isDispatchAsync, isDurable, isExclusive, isMatchingQueue, isMatchingTopic, isNetwork, isNoLocal, isRetroactive, isSlowConsumer, resetStatistics, setSelector

Method Detail

getSubscriptionName

String getSubscriptionName()

Specified by:

getSubscriptionName in interface SubscriptionViewMBean

Returns:

name of the durable subscription name

browse

CompositeData[] browse()
                throws OpenDataException

Browse messages for this durable subscriber

Returns:

messages

Throws:

OpenDataException

browseAsTable

TabularData browseAsTable()
                   throws OpenDataException

Browse messages for this durable subscriber

Returns:

messages

Throws:

OpenDataException

destroy

void destroy()
      throws Exception

Destroys the durable subscription so that messages will no longer be stored for this subscription

Throws:

Exception

doesCursorHaveSpace

boolean doesCursorHaveSpace()

Returns:

true if the message cursor has memory space available to page in more messages

isCursorFull

boolean isCursorFull()

Returns:

true if the cursor has reached its memory limit for paged in messages

doesCursorHaveMessagesBuffered

boolean doesCursorHaveMessagesBuffered()

Returns:

true if the cursor has messages buffered to deliver

getCursorMemoryUsage

long getCursorMemoryUsage()

Returns:

the cursor memory usage in bytes

getCursorPercentUsage

int getCursorPercentUsage()

Returns:

the cursor memory usage as a percentage

cursorSize

int cursorSize()

Returns:

the number of messages available to be paged in by the cursor

removeMessage

void removeMessage(String messageId)
            throws Exception

Removes a message from the durable subscription.

Parameters:

messageId -

Throws:

Exception