JMSDestinationRuntimeMBean (Java API Reference for Oracle WebLogic Server)

All Superinterfaces:

CursorRuntimeMBean, javax.management.DynamicMBean, JMSMessageCursorRuntimeMBean, JMSMessageManagementRuntimeMBean, javax.management.MBeanRegistration, MessageCursorRuntimeMBean, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean
```
public interface JMSDestinationRuntimeMBean
extends JMSMessageManagementRuntimeMBean
```
This class is used for monitoring a WebLogic JMS destination (topic or queue).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`createDurableSubscriber(java.lang.String ClientID, java.lang.String subscriptionName, java.lang.String selector, boolean noLocal)`	Creates a durable subscriber on the destination with the specified client ID and subscription name.
`long`	`getBytesCurrentCount()`	The current number of bytes stored in the destination.
`long`	`getBytesHighCount()`	The peak number of bytes stored in the destination since the last reset.
`long`	`getBytesPendingCount()`	The number of pending bytes stored in the destination.
`long`	`getBytesReceivedCount()`	The number of bytes received in this destination since the last reset.
`long`	`getBytesThresholdTime()`	The amount of time in the threshold condition since the last reset.
`long`	`getConsumersCurrentCount()`	The current number of consumers accessing this destination.
`long`	`getConsumersHighCount()`	The peak number of consumers accessing this destination since the last reset.
`long`	`getConsumersTotalCount()`	The total number of consumers accessing this destination since the last reset.
`java.lang.String`	`getConsumptionPausedState()`	The current consumption pause state of the destination.
`javax.management.openmbean.CompositeData`	`getDestinationInfo()`	Returns information about this destination in JMX open data representation.
`java.lang.String`	`getDestinationType()`	The destination type, either `weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE` or `weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC` depending upon whether the destination is a queue or topic.
`JMSDurableSubscriberRuntimeMBean[]`	`getDurableSubscribers()`	An array of durable subscriber run-time MBeans for this destination.
`java.lang.String`	`getInsertionPausedState()`	The current insertion pause state of the destination.
`long`	`getMessagesCurrentCount()`	The current number of messages in the destination.
`long`	`getMessagesHighCount()`	The peak number of messages in the destination since the last reset.
`long`	`getMessagesPendingCount()`	The number of pending messages in the destination.
`long`	`getMessagesReceivedCount()`	The number of messages received in this destination since the last reset.
`long`	`getMessagesThresholdTime()`	The amount of time in the threshold condition since the last reset.
`java.lang.String`	`getProductionPausedState()`	The current production pause state of the destination.
`java.lang.String`	`getState()`	The operational state of the destination as a String.
`long`	`getSubscriptionMessagesLimit()`	The effective messages limit on topic subscriptions (not applicable to queues).
`boolean`	`isConsumptionPaused()`	Indicates the consumption Pause state of the destination.
`boolean`	`isInsertionPaused()`	Indicates the InsertionPause state of the destination.
`boolean`	`isPaused()`	Deprecated. 9.0.0.0 Replaced by `isProductionPaused()`
`boolean`	`isProductionPaused()`	Indicates the ProductionPause state of the destination.
`void`	`pause()`	Deprecated. 9.0.0.0 Replaced by `pauseProduction()`
`void`	`pauseConsumption()`	Pauses the consumption on the destination.
`void`	`pauseInsertion()`	Pauses the insertion on the destination.
`void`	`pauseProduction()`	Pauses the production on the destination.
`void`	`resume()`	Deprecated. 9.0.0.0 Replaced by `resumeProduction()`
`void`	`resumeConsumption()`	Resumes the consumption operations on the destination.
`void`	`resumeInsertion()`	Resumes the insertion operations on the destination.
`void`	`resumeProduction()`	Resumes the production operations on the destination.

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean
closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface weblogic.management.runtime.JMSMessageCursorRuntimeMBean
sort

Methods inherited from interface weblogic.management.runtime.JMSMessageManagementRuntimeMBean
deleteMessages, getMessage, getMessages, getMessages, getMessagesDeletedCurrentCount, getMessagesMovedCurrentCount, importMessages, importMessages, moveMessages, moveMessages

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preRegister

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean
getMessage, getMessage

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean
addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

- Method Detail
  - getDestinationInfo
```
javax.management.openmbean.CompositeData getDestinationInfo()
```
    Returns information about this destination in JMX open data representation.
    
    See Also:
    
    DestinationInfo
  - createDurableSubscriber
```
void createDurableSubscriber(java.lang.String ClientID,
                             java.lang.String subscriptionName,
                             java.lang.String selector,
                             boolean noLocal)
                      throws javax.jms.InvalidSelectorException,
                             javax.jms.JMSException
```
    Creates a durable subscriber on the destination with the specified client ID and subscription name. A message selector and no-local flag may also be specified.
    
    Parameters:
    
    ClientID - An identifier that uniquely identifies a client connection.
    
    subscriptionName - The name used to identify this subscription.
    
    selector - Only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
    
    noLocal - If set, inhibits the delivery of messages published by its own connection.
    
    Throws:
    
    javax.jms.InvalidSelectorException - The specified JMS selector is invalid.
    
    javax.jms.JMSException - An error occurred while processing the request.
  - getDurableSubscribers
```
JMSDurableSubscriberRuntimeMBean[] getDurableSubscribers()
```
    An array of durable subscriber run-time MBeans for this destination.
    
    Returns:
    
    The durableSubscribers value
  - getConsumersCurrentCount
```
long getConsumersCurrentCount()
```
    The current number of consumers accessing this destination.
    
    Returns:
    
    The consumersCurrentCount value
  - getConsumersHighCount
```
long getConsumersHighCount()
```
    The peak number of consumers accessing this destination since the last reset.
    
    Returns:
    
    The consumersHighCount value
  - getConsumersTotalCount
```
long getConsumersTotalCount()
```
    The total number of consumers accessing this destination since the last reset.
    
    Returns:
    
    The consumersTotalCount value
  - getMessagesCurrentCount
```
long getMessagesCurrentCount()
```
    The current number of messages in the destination. This does not include the pending messages.
    
    Returns:
    
    The messagesCurrentCount value
  - getMessagesPendingCount
```
long getMessagesPendingCount()
```
    The number of pending messages in the destination.
    
    Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or that has been received and not committed or acknowledged.
    
    Returns:
    
    The messagesPendingCount value
  - getMessagesHighCount
```
long getMessagesHighCount()
```
    The peak number of messages in the destination since the last reset.
    
    Returns:
    
    The messagesHighCount value
  - getMessagesReceivedCount
```
long getMessagesReceivedCount()
```
    The number of messages received in this destination since the last reset.
    
    Returns:
    
    The messagesReceivedCount value
  - getMessagesThresholdTime
```
long getMessagesThresholdTime()
```
    The amount of time in the threshold condition since the last reset.
    
    Returns:
    
    The messagesThresholdTime value
  - getSubscriptionMessagesLimit
```
long getSubscriptionMessagesLimit()
```
    The effective messages limit on topic subscriptions (not applicable to queues). A '-1' indicates that no limit is configured or active.
    
    Returns:
    
    The subscriptions limit value
  - getBytesCurrentCount
```
long getBytesCurrentCount()
```
    The current number of bytes stored in the destination. This does not include the pending bytes.
    
    Returns:
    
    The bytesCurrentCount value
  - getBytesPendingCount
```
long getBytesPendingCount()
```
    The number of pending bytes stored in the destination.
    
    Pending bytes are over and above the current number of bytes.
    
    Returns:
    
    The bytesPendingCount value
  - getBytesHighCount
```
long getBytesHighCount()
```
    The peak number of bytes stored in the destination since the last reset.
    
    Returns:
    
    The bytesHighCount value
  - getBytesReceivedCount
```
long getBytesReceivedCount()
```
    The number of bytes received in this destination since the last reset.
    
    Returns:
    
    The bytesReceivedCount value
  - getBytesThresholdTime
```
long getBytesThresholdTime()
```
    The amount of time in the threshold condition since the last reset.
    
    Returns:
    
    The bytesThresholdTime value
  - getDestinationType
```
java.lang.String getDestinationType()
```
    The destination type, either weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE or weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC depending upon whether the destination is a queue or topic.
    
    Returns:
    
    The destinationType value
  - pause
```
@Deprecated
void pause()
```
    Deprecated.
    9.0.0.0 Replaced by pauseProduction()
    
    Pauses the destination so that new messages are not accepted.
  - resume
```
@Deprecated
void resume()
```
    Deprecated.
    9.0.0.0 Replaced by resumeProduction()
    
    Resumes the destination so that new messages are accepted.
  - getState
```
java.lang.String getState()
```
    The operational state of the destination as a String.
  - isPaused
```
@Deprecated
boolean isPaused()
          throws javax.jms.JMSException
```
    Deprecated.
    9.0.0.0 Replaced by isProductionPaused()
    
    Indicates whether or not the destination is paused at the current time.
    
    Throws:
    
    javax.jms.JMSException
  - pauseProduction
```
void pauseProduction()
              throws javax.jms.JMSException
```
    Pauses the production on the destination.
    
    Throws:
    
    javax.jms.JMSException
  - isProductionPaused
```
boolean isProductionPaused()
```
    Indicates the ProductionPause state of the destination.
  - getProductionPausedState
```
java.lang.String getProductionPausedState()
```
    The current production pause state of the destination.
  - resumeProduction
```
void resumeProduction()
               throws javax.jms.JMSException
```
    Resumes the production operations on the destination.
    
    Throws:
    
    javax.jms.JMSException
  - pauseInsertion
```
void pauseInsertion()
             throws javax.jms.JMSException
```
    Pauses the insertion on the destination.
    
    Throws:
    
    javax.jms.JMSException
  - isInsertionPaused
```
boolean isInsertionPaused()
```
    Indicates the InsertionPause state of the destination.
  - getInsertionPausedState
```
java.lang.String getInsertionPausedState()
```
    The current insertion pause state of the destination.
  - resumeInsertion
```
void resumeInsertion()
              throws javax.jms.JMSException
```
    Resumes the insertion operations on the destination.
    
    Throws:
    
    javax.jms.JMSException
  - pauseConsumption
```
void pauseConsumption()
               throws javax.jms.JMSException
```
    Pauses the consumption on the destination.
    
    Throws:
    
    javax.jms.JMSException
  - isConsumptionPaused
```
boolean isConsumptionPaused()
```
    Indicates the consumption Pause state of the destination.
  - getConsumptionPausedState
```
java.lang.String getConsumptionPausedState()
```
    The current consumption pause state of the destination.
  - resumeConsumption
```
void resumeConsumption()
                throws javax.jms.JMSException
```
    Resumes the consumption operations on the destination.
    
    Throws:
    
    javax.jms.JMSException

Interface JMSDestinationRuntimeMBean

Method Summary

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean

Methods inherited from interface javax.management.DynamicMBean

Methods inherited from interface weblogic.management.runtime.JMSMessageCursorRuntimeMBean

Methods inherited from interface weblogic.management.runtime.JMSMessageManagementRuntimeMBean

Methods inherited from interface javax.management.MBeanRegistration

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean

Methods inherited from interface javax.management.NotificationBroadcaster

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

Methods inherited from interface weblogic.management.WebLogicMBean

Method Detail

getDestinationInfo

createDurableSubscriber

getDurableSubscribers

getConsumersCurrentCount

getConsumersHighCount

getConsumersTotalCount

getMessagesCurrentCount

getMessagesPendingCount

getMessagesHighCount

getMessagesReceivedCount

getMessagesThresholdTime

getSubscriptionMessagesLimit

getBytesCurrentCount

getBytesPendingCount

getBytesHighCount

getBytesReceivedCount

getBytesThresholdTime

getDestinationType

pause

resume

getState

isPaused

pauseProduction

isProductionPaused

getProductionPausedState

resumeProduction

pauseInsertion

isInsertionPaused

getInsertionPausedState

resumeInsertion

pauseConsumption

isConsumptionPaused

getConsumptionPausedState

resumeConsumption