Type-Safe Access to BEA WebLogic Server 9.2 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.runtime
Interface JMSDestinationRuntimeMBean

All Superinterfaces:

weblogic.management.runtime.CursorRuntimeMBean, DynamicMBean, weblogic.management.runtime.JMSMessageCursorRuntimeMBean, weblogic.management.runtime.JMSMessageManagementRuntimeMBean, MBeanRegistration, weblogic.management.runtime.MessageCursorRuntimeMBean, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, weblogic.management.WebLogicMBean

public interface JMSDestinationRuntimeMBean

extends weblogic.management.runtime.JMSMessageManagementRuntimeMBean

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/documentation/index.html.

Method Summary

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.
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.
String	getConsumptionPausedState() The current consumption pause state of the destination.
CompositeData	getDestinationInfo() Returns information about this destination in JMX open data representation.
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.
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 that reset.
long	getMessagesThresholdTime() The amount of time in the threshold condition since the last reset.
String	getProductionPausedState() The current production pause state of the destination.
String	getState() The operational state of the destination as a String.
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.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.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

createDurableSubscriber

public 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.

getBytesCurrentCount

public long getBytesCurrentCount()

The current number of bytes stored in the destination. This does not include the pending bytes.

Returns:

The bytesCurrentCount value

getBytesHighCount

public long getBytesHighCount()

The peak number of bytes stored in the destination since the last reset.

Returns:

The bytesHighCount value

getBytesPendingCount

public 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

getBytesReceivedCount

public long getBytesReceivedCount()

The number of bytes received in this destination since the last reset.

Returns:

The bytesReceivedCount value

getBytesThresholdTime

public long getBytesThresholdTime()

The amount of time in the threshold condition since the last reset.

Returns:

The bytesThresholdTime value

getConsumersCurrentCount

public long getConsumersCurrentCount()

The current number of consumers accessing this destination.

Returns:

The consumersCurrentCount value

getConsumersHighCount

public long getConsumersHighCount()

The peak number of consumers accessing this destination since the last reset.

Returns:

The consumersHighCount value

getConsumersTotalCount

public long getConsumersTotalCount()

The total number of consumers accessing this destination since the last reset.

Returns:

The consumersTotalCount value

getConsumptionPausedState

public String getConsumptionPausedState()

The current consumption pause state of the destination.

getDestinationInfo

public CompositeData getDestinationInfo()

Returns information about this destination in JMX open data representation.

See Also:

weblogic.jms.extensions.DestinationInfo

getDestinationType

public 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

getDurableSubscribers

public JMSDurableSubscriberRuntimeMBean[] getDurableSubscribers()

An array of durable subscriber run-time MBeans for this destination.

Returns:

The durableSubscribers value

getInsertionPausedState

public String getInsertionPausedState()

The current insertion pause state of the destination.

getMessagesCurrentCount

public long getMessagesCurrentCount()

The current number of messages in the destination. This does not include the pending messages.

Returns:

The messagesCurrentCount value

getMessagesHighCount

public long getMessagesHighCount()

The peak number of messages in the destination since the last reset.

Returns:

The messagesHighCount value

getMessagesPendingCount

public 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

getMessagesReceivedCount

public long getMessagesReceivedCount()

The number of messages received in this destination since that reset.

Returns:

The messagesReceivedCount value

getMessagesThresholdTime

public long getMessagesThresholdTime()

The amount of time in the threshold condition since the last reset.

Returns:

The messagesThresholdTime value

getProductionPausedState

public String getProductionPausedState()

The current production pause state of the destination.

getState

public String getState()

The operational state of the destination as a String.

isConsumptionPaused

public boolean isConsumptionPaused()

Indicates the consumption Pause state of the destination.

isInsertionPaused

public boolean isInsertionPaused()

Indicates the InsertionPause state of the destination.

isPaused

public boolean isPaused()
                 throws JMSException

Deprecated. 9.0.0.0 Replaced by isProductionPaused()

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

Throws:

JMSException

isProductionPaused

public boolean isProductionPaused()

Indicates the ProductionPause state of the destination.

pause

public void pause()

Deprecated. 9.0.0.0 Replaced by pauseProduction()

Pauses the destination so that new messages are not accepted.

pauseConsumption

public void pauseConsumption()
                      throws JMSException

Pauses the consumption on the destination.

Throws:

JMSException

pauseInsertion

public void pauseInsertion()
                    throws JMSException

Pauses the insertion on the destination.

Throws:

JMSException

pauseProduction

public void pauseProduction()
                     throws JMSException

Pauses the production on the destination.

Throws:

JMSException

resume

public void resume()

Deprecated. 9.0.0.0 Replaced by resumeProduction()

Resumes the destination so that new messages are accepted.

resumeConsumption

public void resumeConsumption()
                       throws JMSException

Resumes the consumption operations on the destination.

Throws:

JMSException

resumeInsertion

public void resumeInsertion()
                     throws JMSException

Resumes the insertion operations on the destination.

Throws:

JMSException

resumeProduction

public void resumeProduction()
                      throws JMSException

Resumes the production operations on the destination.

Throws:

JMSException