weblogic.management.runtime
Interface JMSDestinationRuntimeMBean

public interface JMSDestinationRuntimeMBean

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

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/products/weblogic/index.html.

getDestinationInfo

CompositeData getDestinationInfo()

Returns information about this destination in JMX open data representation.

See Also:

weblogic.jms.extensions.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 that 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