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

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

weblogic.management.runtime
Interface JMSDurableSubscriberRuntimeMBean

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 JMSDurableSubscriberRuntimeMBean

extends weblogic.management.runtime.JMSMessageManagementRuntimeMBean

This class is used for monitoring a WebLogic JMS durable subscriber.

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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary

void	destroy() Completely removes this durable subscriber (and all messages associated with this durable subscription).
long	getBytesCurrentCount() The number of bytes received by this durable subscriber.
long	getBytesPendingCount() The number of bytes pending by this durable subscriber.
String	getClientID() The client ID for this durable subscriber.
CompositeData	getCurrentConsumerInfo() Returns information about the current consumer.
CompositeData	getDestinationInfo() Returns information about the durable subscriber's internal destination in JMX open data representation.
JMSDestinationRuntimeMBean	getDestinationRuntime() Returns the runtime MBean of the Topic to which this durable subscriber is associated.
long	getMessagesCurrentCount() The number of messages still available by this durable subscriber.
long	getMessagesHighCount() Returns the peak number of messages for the durable subscriber since the last reset.
long	getMessagesPendingCount() The number of messages pending (uncommitted and unacknowledged) by this durable subscriber.
long	getMessagesReceivedCount() Returns the number of messages received by the durable subscriber since that reset.
String	getSelector() The selector for this durable subscriber.
String	getSubscriptionName() The subscription name for this durable subscriber.
boolean	isActive() Indicates whether this subscription is being used by a durable subscriber.
boolean	isNoLocal() Indicates the value of the noLocal Boolean for this durable subscriber.
void	purge() Deprecated. As of WLS 9.0. Use JMSMessageManagementRuntimeMBean.deleteMessages(String)

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

destroy

public void destroy()
             throws JMSException

Completely removes this durable subscriber (and all messages associated with this durable subscription). After calling this method the durable subscription represented by this MBean will no longer be valid.

Throws:

JMSException

getBytesCurrentCount

public long getBytesCurrentCount()

The number of bytes received by this durable subscriber.

Returns:

The bytesCurrentCount value

getBytesPendingCount

public long getBytesPendingCount()

The number of bytes pending by this durable subscriber.

Returns:

The bytesPendingCount value

getClientID

public String getClientID()

The client ID for this durable subscriber.

Returns:

The clientID value

getCurrentConsumerInfo

public CompositeData getCurrentConsumerInfo()
                                     throws OpenDataException

Returns information about the current consumer. The information is returned in the form of an OpenMBean CompositeData object.

Returns:

A CompositeData object that contains information about the consumer, including information about the JMS session and connection.

Throws:

OpenDataException - Thrown when an error occurs while constructing the CompositeData return value.

See Also:

weblogic.jms.extensions.ConsumerInfo

getDestinationInfo

public CompositeData getDestinationInfo()
                                 throws OpenDataException

Returns information about the durable subscriber's internal destination in JMX open data representation. The resulting object is intended for use in the message management APIs for identifying a target destination.

Returns:

The subscriber's destination.

Throws:

OpenDataException - Thrown when an error occurs while constructing the CompositeData return value.

See Also:

JMSMessageManagementRuntimeMBean#moveMessages(String, CompositeData), JMSMessageManagementRuntimeMBean#moveMessages(String, CompositeData, Integer)

getDestinationRuntime

public JMSDestinationRuntimeMBean getDestinationRuntime()

Returns the runtime MBean of the Topic to which this durable subscriber is associated.

Returns:

The runtime MBean of the subscriber's Topic.

getMessagesCurrentCount

public long getMessagesCurrentCount()

The number of messages still available by this durable subscriber.

Returns:

The messagesCurrentCount value

getMessagesHighCount

public long getMessagesHighCount()

Returns the peak number of messages for the durable subscriber since the last reset.

Returns:

The messagesHighCount value

getMessagesPendingCount

public long getMessagesPendingCount()

The number of messages pending (uncommitted and unacknowledged) by this durable subscriber.

Returns:

The messagesPendingCount value

getMessagesReceivedCount

public long getMessagesReceivedCount()

Returns the number of messages received by the durable subscriber since that reset.

Returns:

The messagesReceivedCount value

getSelector

public String getSelector()

The selector for this durable subscriber.

Returns:

The selector value

getSubscriptionName

public String getSubscriptionName()

The subscription name for this durable subscriber.

Returns:

The subscriptionName value

isActive

public boolean isActive()
                 throws RemoteException

Indicates whether this subscription is being used by a durable subscriber.

Returns:

The active value

Throws:

RemoteException

isNoLocal

public boolean isNoLocal()

Indicates the value of the noLocal Boolean for this durable subscriber.

Returns:

The noLocal value

purge

public void purge()

Deprecated. As of WLS 9.0. Use JMSMessageManagementRuntimeMBean.deleteMessages(String)

Purges all the pending and current messages for this durable subscriber.