All Known Subinterfaces:

QueueViewMBean, TopicViewMBean

All Known Implementing Classes:

DestinationView, QueueView, TopicView
```
public interface DestinationViewMBean
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CompositeData[]`	`browse()`
`CompositeData[]`	`browse(String selector)`
`TabularData`	`browseAsTable()`
`TabularData`	`browseAsTable(String selector)`
`List<?>`	`browseMessages()`	Browses the current destination returning a list of messages
`List<?>`	`browseMessages(String selector)`	Browses the current destination with the given selector returning a list of messages
`double`	`getAverageBlockedTime()`
`double`	`getAverageEnqueueTime()`
`long`	`getAverageMessageSize()`
`long`	`getBlockedProducerWarningInterval()`
`long`	`getBlockedSends()`
`long`	`getConsumerCount()`	Returns the number of consumers subscribed this destination.
`long`	`getDequeueCount()`	Returns the number of messages that have been acknowledged from the destination.
`long`	`getDispatchCount()`	Returns the number of messages that have been delivered (potentially not acknowledged) to consumers.
`long`	`getDuplicateFromStoreCount()`	Returns the number of duplicate messages that have been paged-in from the store.
`long`	`getEnqueueCount()`	Returns the number of messages that have been sent to the destination.
`long`	`getExpiredCount()`	Returns the number of messages that have expired
`long`	`getForwardCount()`	Returns the number of messages that have been acknowledged by network subscriptions from the destination.
`long`	`getInFlightCount()`	Returns the number of messages that have been dispatched but not acknowledged
`int`	`getMaxAuditDepth()`
`long`	`getMaxEnqueueTime()`
`long`	`getMaxMessageSize()`
`int`	`getMaxPageSize()`
`int`	`getMaxProducersToAudit()`
`long`	`getMemoryLimit()`
`int`	`getMemoryPercentUsage()`
`long`	`getMemoryUsageByteCount()`
`float`	`getMemoryUsagePortion()`
`long`	`getMinEnqueueTime()`
`long`	`getMinMessageSize()`
`String`	`getName()`	Returns the name of this destination
`String`	`getOptions()`
`long`	`getProducerCount()`
`long`	`getQueueSize()`	Returns the number of messages in this destination which are yet to be consumed
`ObjectName`	`getSlowConsumerStrategy()`	Returns the slow consumer strategy MBean for this destination
`long`	`getStoreMessageSize()`	Returns the memory size of all messages in this destination's store
`ObjectName[]`	`getSubscriptions()`	Returns all the current subscription MBeans matching this destination
`long`	`getTempUsageLimit()`
`int`	`getTempUsagePercentUsage()`
`long`	`getTotalBlockedTime()`
`boolean`	`isAlwaysRetroactive()`
`boolean`	`isDLQ()`
`boolean`	`isPrioritizedMessages()`
`boolean`	`isProducerFlowControl()`
`boolean`	`isSendDuplicateFromStoreToDLQ()`	Returns the config setting to send a duplicate message from store to the dead letter queue.
`boolean`	`isUseCache()`
`void`	`resetStatistics()`	Resets the management counters.
`String`	`sendTextMessage(String body)`	Sends a TextMesage to the destination.
`String`	`sendTextMessage(String body, String user, String password)`	Sends a TextMesage to the destination.
`String`	`sendTextMessage(Map<?,?> headers, String body)`	Sends a TextMesage to the destination.
`String`	`sendTextMessage(Map<String,String> headers, String body, String user, String password)`
`String`	`sendTextMessageWithProperties(String properties)`	Sends a TextMessage to the destination.
`String`	`sendTextMessageWithProperties(String properties, String delimiter)`	Sends a TextMessage to the destination.
`void`	`setAlwaysRetroactive(boolean alwaysRetroactive)`
`void`	`setBlockedProducerWarningInterval(long blockedProducerWarningInterval)`	Set's the interval at which warnings about producers being blocked by resource usage will be triggered.
`void`	`setDLQ(boolean value)`
`void`	`setMaxAuditDepth(int maxAuditDepth)`
`void`	`setMaxPageSize(int pageSize)`
`void`	`setMaxProducersToAudit(int maxProducersToAudit)`
`void`	`setMemoryLimit(long limit)`	set the amount of memory allocated to this destination
`void`	`setMemoryUsagePortion(float value)`	set the portion of memory from the broker memory limit for this destination
`void`	`setProducerFlowControl(boolean producerFlowControl)`
`void`	`setTempUsageLimit(long limit)`	set the amount of temp usage allocated to this destination
`void`	`setUseCache(boolean value)`

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this destination
  - resetStatistics
```
void resetStatistics()
```
    Resets the management counters.
  - getEnqueueCount
```
long getEnqueueCount()
```
    Returns the number of messages that have been sent to the destination.
    
    Returns:
    
    The number of messages that have been sent to the destination.
  - getDispatchCount
```
long getDispatchCount()
```
    Returns the number of messages that have been delivered (potentially not acknowledged) to consumers.
    
    Returns:
    
    The number of messages that have been delivered (potentially not acknowledged) to consumers.
  - getDequeueCount
```
long getDequeueCount()
```
    Returns the number of messages that have been acknowledged from the destination.
    
    Returns:
    
    The number of messages that have been acknowledged from the destination.
  - getDuplicateFromStoreCount
```
long getDuplicateFromStoreCount()
```
    Returns the number of duplicate messages that have been paged-in from the store.
    
    Returns:
    
    The number of duplicate messages that have been paged-in from the store.
  - isSendDuplicateFromStoreToDLQ
```
boolean isSendDuplicateFromStoreToDLQ()
```
    Returns the config setting to send a duplicate message from store to the dead letter queue.
    
    Returns:
    
    The config setting to send a duplicate message from store to the dead letter queue.
  - getForwardCount
```
long getForwardCount()
```
    Returns the number of messages that have been acknowledged by network subscriptions from the destination.
    
    Returns:
    
    The number of messages that have been acknowledged by network subscriptions from the destination.
  - getInFlightCount
```
long getInFlightCount()
```
    Returns the number of messages that have been dispatched but not acknowledged
    
    Returns:
    
    The number of messages that have been dispatched but not acknowledged
  - getExpiredCount
```
long getExpiredCount()
```
    Returns the number of messages that have expired
    
    Returns:
    
    The number of messages that have expired
  - getConsumerCount
```
long getConsumerCount()
```
    Returns the number of consumers subscribed this destination.
    
    Returns:
    
    The number of consumers subscribed this destination.
  - getProducerCount
```
long getProducerCount()
```
    Returns:
    
    the number of producers publishing to the destination
  - getQueueSize
```
long getQueueSize()
```
    Returns the number of messages in this destination which are yet to be consumed
    
    Returns:
    
    Returns the number of messages in this destination which are yet to be consumed
  - getStoreMessageSize
```
long getStoreMessageSize()
```
    Returns the memory size of all messages in this destination's store
    
    Returns:
    
    Returns the memory size of all messages in this destination's store
  - browse
```
CompositeData[] browse()
                throws OpenDataException
```
    Returns:
    
    An array of all the messages in the destination's queue.
    
    Throws:
    
    OpenDataException
  - browseAsTable
```
TabularData browseAsTable()
                   throws OpenDataException
```
    Returns:
    
    A list of all the messages in the destination's queue.
    
    Throws:
    
    OpenDataException
  - browse
```
CompositeData[] browse(String selector)
                throws OpenDataException,
                       InvalidSelectorException
```
    Returns:
    
    An array of all the messages in the destination's queue.
    
    Throws:
    
    InvalidSelectorException
    
    OpenDataException
  - browseAsTable
```
TabularData browseAsTable(String selector)
                   throws OpenDataException,
                          InvalidSelectorException
```
    Returns:
    
    A list of all the messages in the destination's queue.
    
    Throws:
    
    InvalidSelectorException
    
    OpenDataException
  - sendTextMessage
```
String sendTextMessage(String body)
                throws Exception
```
    Sends a TextMesage to the destination.
    
    Parameters:
    
    body - the text to send
    
    Returns:
    
    the message id of the message sent.
    
    Throws:
    
    Exception
  - sendTextMessageWithProperties
```
String sendTextMessageWithProperties(String properties)
                              throws Exception
```
    Sends a TextMessage to the destination.
    
    Parameters:
    
    properties - the message properties to set as name=value list separated by a comma. Can only contain Strings mapped to primitive types or JMS properties. eg: body=hi,JMSReplyTo=Queue2
    
    Returns:
    
    the message id of the message sent.
    
    Throws:
    
    Exception
  - sendTextMessageWithProperties
```
String sendTextMessageWithProperties(String properties,
                                     String delimiter)
                              throws Exception
```
    Sends a TextMessage to the destination.
    
    Parameters:
    
    properties - the message properties to set as name=value list separated by a custom delimiter. Can only contain Strings mapped to primitive types or JMS properties. eg: body=hi,JMSReplyTo=Queue2
    
    delimiter - The delimiter that separates each property. Defaults to comma if none is provided.
    
    Returns:
    
    the message id of the message sent.
    
    Throws:
    
    Exception
  - sendTextMessage
```
String sendTextMessage(Map<?,?> headers,
                       String body)
                throws Exception
```
    Sends a TextMesage to the destination.
    
    Parameters:
    
    headers - the message headers and properties to set. Can only container Strings maped to primitive types.
    
    body - the text to send
    
    Returns:
    
    the message id of the message sent.
    
    Throws:
    
    Exception
  - sendTextMessage
```
String sendTextMessage(String body,
                       String user,
                       String password)
                throws Exception
```
    Sends a TextMesage to the destination.
    
    Parameters:
    
    body - the text to send
    
    user -
    
    password -
    
    Returns:
    
    a string value
    
    Throws:
    
    Exception
  - sendTextMessage
```
String sendTextMessage(Map<String,String> headers,
                       String body,
                       String user,
                       String password)
                throws Exception
```
    Parameters:
    
    headers - the message headers and properties to set. Can only container Strings maped to primitive types.
    
    body - the text to send
    
    user -
    
    password -
    
    Returns:
    
    a string value
    
    Throws:
    
    Exception
  - getMemoryPercentUsage
```
int getMemoryPercentUsage()
```
    Returns:
    
    the percentage of amount of memory used
  - getMemoryUsageByteCount
```
long getMemoryUsageByteCount()
```
    Returns:
    
    the amount of memory currently used by this destination
  - getMemoryLimit
```
long getMemoryLimit()
```
    Returns:
    
    the amount of memory allocated to this destination
  - setMemoryLimit
```
void setMemoryLimit(long limit)
```
    set the amount of memory allocated to this destination
    
    Parameters:
    
    limit -
  - getTempUsagePercentUsage
```
int getTempUsagePercentUsage()
```
    Returns:
    
    the percentage of amount of temp usage used
  - getTempUsageLimit
```
long getTempUsageLimit()
```
    Returns:
    
    the amount of temp usage allocated to this destination
  - setTempUsageLimit
```
void setTempUsageLimit(long limit)
```
    set the amount of temp usage allocated to this destination
    
    Parameters:
    
    limit - the amount of temp usage allocated to this destination
  - getMemoryUsagePortion
```
float getMemoryUsagePortion()
```
    Returns:
    
    the portion of memory from the broker memory limit for this destination
  - setMemoryUsagePortion
```
void setMemoryUsagePortion(float value)
```
    set the portion of memory from the broker memory limit for this destination
    
    Parameters:
    
    value -
  - browseMessages
```
List<?> browseMessages()
                throws InvalidSelectorException
```
    Browses the current destination returning a list of messages
    
    Throws:
    
    InvalidSelectorException
  - browseMessages
```
List<?> browseMessages(String selector)
                throws InvalidSelectorException
```
    Browses the current destination with the given selector returning a list of messages
    
    Throws:
    
    InvalidSelectorException
  - getMaxEnqueueTime
```
long getMaxEnqueueTime()
```
    Returns:
    
    longest time a message is held by a destination
  - getMinEnqueueTime
```
long getMinEnqueueTime()
```
    Returns:
    
    shortest time a message is held by a destination
  - getAverageEnqueueTime
```
double getAverageEnqueueTime()
```
  - getAverageMessageSize
```
long getAverageMessageSize()
```
  - getMaxMessageSize
```
long getMaxMessageSize()
```
  - getMinMessageSize
```
long getMinMessageSize()
```
  - isProducerFlowControl
```
boolean isProducerFlowControl()
```
    Returns:
    
    the producerFlowControl
  - setProducerFlowControl
```
void setProducerFlowControl(boolean producerFlowControl)
```
    Parameters:
    
    producerFlowControl - the producerFlowControl to set
  - isAlwaysRetroactive
```
boolean isAlwaysRetroactive()
```
    Returns:
    
    if we treat consumers as alwaysRetroactive
  - setAlwaysRetroactive
```
void setAlwaysRetroactive(boolean alwaysRetroactive)
```
    Parameters:
    
    alwaysRetroactive - set as always retroActive
  - setBlockedProducerWarningInterval
```
void setBlockedProducerWarningInterval(long blockedProducerWarningInterval)
```
    Set's the interval at which warnings about producers being blocked by resource usage will be triggered. Values of 0 or less will disable warnings
    
    Parameters:
    
    blockedProducerWarningInterval - the interval at which warning about blocked producers will be triggered.
  - getBlockedProducerWarningInterval
```
long getBlockedProducerWarningInterval()
```
    Returns:
    
    the interval at which warning about blocked producers will be triggered.
  - getMaxProducersToAudit
```
int getMaxProducersToAudit()
```
    Returns:
    
    the maxProducersToAudit
  - setMaxProducersToAudit
```
void setMaxProducersToAudit(int maxProducersToAudit)
```
    Parameters:
    
    maxProducersToAudit - the maxProducersToAudit to set
  - getMaxAuditDepth
```
int getMaxAuditDepth()
```
    Returns:
    
    the maxAuditDepth
  - setMaxAuditDepth
```
void setMaxAuditDepth(int maxAuditDepth)
```
    Parameters:
    
    maxAuditDepth - the maxAuditDepth to set
  - getMaxPageSize
```
int getMaxPageSize()
```
    Returns:
    
    the maximum number of message to be paged into the destination
  - setMaxPageSize
```
void setMaxPageSize(int pageSize)
```
    Parameters:
    
    pageSize - Set the maximum number of messages to page into the destination
  - isUseCache
```
boolean isUseCache()
```
    Returns:
    
    true if caching is allowed of for the destination
  - isPrioritizedMessages
```
boolean isPrioritizedMessages()
```
    Returns:
    
    true if prioritized messages are enabled for the destination
  - setUseCache
```
void setUseCache(boolean value)
```
    Parameters:
    
    value - enable/disable caching on the destination
  - getSubscriptions
```
ObjectName[] getSubscriptions()
                       throws IOException,
                              MalformedObjectNameException
```
    Returns all the current subscription MBeans matching this destination
    
    Returns:
    
    the names of the subscriptions for this destination
    
    Throws:
    
    IOException
    
    MalformedObjectNameException
  - getSlowConsumerStrategy
```
ObjectName getSlowConsumerStrategy()
                            throws IOException,
                                   MalformedObjectNameException
```
    Returns the slow consumer strategy MBean for this destination
    
    Returns:
    
    the name of the slow consumer handler MBean for this destination
    
    Throws:
    
    IOException
    
    MalformedObjectNameException
  - getOptions
```
String getOptions()
```
    Returns:
    
    A string of destination options, name value pairs as URL queryString.
  - isDLQ
```
boolean isDLQ()
```
    Returns:
    
    true if this is dead letter queue
  - setDLQ
```
void setDLQ(boolean value)
```
    Parameters:
    
    value - enable/disable the DLQ flag
  - getBlockedSends
```
long getBlockedSends()
```
  - getAverageBlockedTime
```
double getAverageBlockedTime()
```
  - getTotalBlockedTime
```
long getTotalBlockedTime()
```

Interface DestinationViewMBean

Method Summary

Method Detail

getName

resetStatistics

getEnqueueCount

getDispatchCount

getDequeueCount

getDuplicateFromStoreCount

isSendDuplicateFromStoreToDLQ

getForwardCount

getInFlightCount

getExpiredCount

getConsumerCount

getProducerCount

getQueueSize

getStoreMessageSize

browse

browseAsTable

browse

browseAsTable

sendTextMessage

sendTextMessageWithProperties

sendTextMessageWithProperties

sendTextMessage

sendTextMessage

sendTextMessage

getMemoryPercentUsage

getMemoryUsageByteCount

getMemoryLimit

setMemoryLimit

getTempUsagePercentUsage

getTempUsageLimit

setTempUsageLimit

getMemoryUsagePortion

setMemoryUsagePortion

browseMessages

browseMessages

getMaxEnqueueTime

getMinEnqueueTime

getAverageEnqueueTime

getAverageMessageSize

getMaxMessageSize

getMinMessageSize

isProducerFlowControl

setProducerFlowControl

isAlwaysRetroactive

setAlwaysRetroactive

setBlockedProducerWarningInterval

getBlockedProducerWarningInterval

getMaxProducersToAudit

setMaxProducersToAudit

getMaxAuditDepth

setMaxAuditDepth

getMaxPageSize

setMaxPageSize

isUseCache

isPrioritizedMessages

setUseCache

getSubscriptions

getSlowConsumerStrategy

getOptions

isDLQ

setDLQ

getBlockedSends

getAverageBlockedTime

getTotalBlockedTime