Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.runtime
Interface JMSDestinationRuntimeMBean

All Superinterfaces:
CursorRuntimeMBean, DynamicMBean, JMSMessageCursorRuntimeMBean, JMSMessageManagementRuntimeMBean, MBeanRegistration, MessageCursorRuntimeMBean, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface JMSDestinationRuntimeMBean
extends JMSMessageManagementRuntimeMBean

This class is used for monitoring a WebLogic JMS destination (topic or queue).


Method Summary
abstract  void createDurableSubscriber(String ClientID, String subscriptionName, String selector, boolean noLocal)
          Creates a durable subscriber on the destination with the specified client ID and subscription name.
abstract  long getBytesCurrentCount()
          The current number of bytes stored in the destination.
abstract  long getBytesHighCount()
          The peak number of bytes stored in the destination since the last reset.
abstract  long getBytesPendingCount()
          The number of pending bytes stored in the destination.
abstract  long getBytesReceivedCount()
          The number of bytes received in this destination since the last reset.
abstract  long getBytesThresholdTime()
          The amount of time in the threshold condition since the last reset.
abstract  long getConsumersCurrentCount()
          The current number of consumers accessing this destination.
abstract  long getConsumersHighCount()
          The peak number of consumers accessing this destination since the last reset.
abstract  long getConsumersTotalCount()
          The total number of consumers accessing this destination since the last reset.
abstract  String getConsumptionPausedState()
          The current consumption pause state of the destination.
abstract  CompositeData getDestinationInfo()
           Returns information about this destination in JMX open data representation.
abstract  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.
abstract  JMSDurableSubscriberRuntimeMBean[] getDurableSubscribers()
          An array of durable subscriber run-time MBeans for this destination.
abstract  String getInsertionPausedState()
          The current insertion pause state of the destination.
abstract  long getMessagesCurrentCount()
          The current number of messages in the destination.
abstract  long getMessagesHighCount()
          The peak number of messages in the destination since the last reset.
abstract  long getMessagesPendingCount()
          The number of pending messages in the destination.
abstract  long getMessagesReceivedCount()
          The number of messages received in this destination since the last reset.
abstract  long getMessagesThresholdTime()
          The amount of time in the threshold condition since the last reset.
abstract  String getProductionPausedState()
          The current production pause state of the destination.
abstract  String getState()
          The operational state of the destination as a String.
abstract  boolean isConsumptionPaused()
          Indicates the consumption Pause state of the destination.
abstract  boolean isInsertionPaused()
          Indicates the InsertionPause state of the destination.
abstract  boolean isPaused()
          Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.isProductionPaused()
abstract  boolean isProductionPaused()
          Indicates the ProductionPause state of the destination.
abstract  void pause()
          Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.pauseProduction()
abstract  void pauseConsumption()
          Pauses the consumption on the destination.
abstract  void pauseInsertion()
          Pauses the insertion on the destination.
abstract  void pauseProduction()
          Pauses the production on the destination.
abstract  void resume()
          Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.resumeProduction()
abstract  void resumeConsumption()
          Resumes the consumption operations on the destination.
abstract  void resumeInsertion()
          Resumes the insertion operations on the destination.
abstract  void resumeProduction()
          Resumes the production operations on the destination.

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

Method Detail

getDestinationInfo

CompositeData getDestinationInfo()

Returns information about this destination in JMX open data representation.

See Also:
DestinationInfo

createDurableSubscriber

void createDurableSubscriber(String ClientID,
                             String subscriptionName,
                             String selector,
                             boolean noLocal)
                             throws InvalidSelectorException,
                                    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:
InvalidSelectorException - The specified JMS selector is invalid.
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

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

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

void pause()
Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.pauseProduction()

Pauses the destination so that new messages are not accepted.


resume

void resume()
Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.resumeProduction()

Resumes the destination so that new messages are accepted.


getState

String getState()

The operational state of the destination as a String.


isPaused

boolean isPaused()
                 throws JMSException
Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean.isProductionPaused()

Indicates whether or not the destination is paused at the current time.

Throws:
JMSException

pauseProduction

void pauseProduction()
                     throws JMSException

Pauses the production on the destination.

Throws:
JMSException

isProductionPaused

boolean isProductionPaused()

Indicates the ProductionPause state of the destination.


getProductionPausedState

String getProductionPausedState()

The current production pause state of the destination.


resumeProduction

void resumeProduction()
                      throws JMSException

Resumes the production operations on the destination.

Throws:
JMSException

pauseInsertion

void pauseInsertion()
                    throws JMSException

Pauses the insertion on the destination.

Throws:
JMSException

isInsertionPaused

boolean isInsertionPaused()

Indicates the InsertionPause state of the destination.


getInsertionPausedState

String getInsertionPausedState()

The current insertion pause state of the destination.


resumeInsertion

void resumeInsertion()
                     throws JMSException

Resumes the insertion operations on the destination.

Throws:
JMSException

pauseConsumption

void pauseConsumption()
                      throws JMSException

Pauses the consumption on the destination.

Throws:
JMSException

isConsumptionPaused

boolean isConsumptionPaused()

Indicates the consumption Pause state of the destination.


getConsumptionPausedState

String getConsumptionPausedState()

The current consumption pause state of the destination.


resumeConsumption

void resumeConsumption()
                       throws JMSException

Resumes the consumption operations on the destination.

Throws:
JMSException

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09