weblogic.management.runtime
Interface JMSDurableSubscriberRuntimeMBean

public interface JMSDurableSubscriberRuntimeMBean

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

getClientID

String getClientID()

A unique client identifier for this durable subscriber.

Note: The client ID is not necessarily equivalent to the WebLogic Server username; that is, a name used to authenticate a user in the WebLogic security realm. You can set the client ID to the WebLogic Server username if it is appropriate for your JMS application.

Returns:

The clientID value

getClientIDPolicy

String getClientIDPolicy()

The policy for the client identifier for this durable subscriber.

Note: The client ID policy is either Restricted or Unrestricted.

Returns:

The clientIDPolicy value weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED : Only one connection that uses this policy exists in a cluster at any given time for a particular ClientID. weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED : Connections created using this policy can specify any ClientID, even when other restricted or unrestricted connections already use the same ClientID.

getSubscriptionName

String getSubscriptionName()

The subscription name for this durable subscriber. This name must be unique for each client ID.

Valid durable subscription names cannot include the following characters: comma ",", equals "=", colon ":", asterisk "*", percent "%", or question mark"?".

Returns:

The subscriptionName value

isNoLocal

boolean isNoLocal()

Specifies whether this durable subscriber receives local messages that it has published.

To prevent this, set the noLocal parameter to true.

Returns:

The noLocal value

isActive

boolean isActive()
                 throws RemoteException

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

Returns:

The active value

Throws:

RemoteException

getSelector

String getSelector()

The message selector defined for this durable subscriber.

Returns:

The selector value

getMessagesPendingCount

long getMessagesPendingCount()

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

Returns:

The messagesPendingCount value

getMessagesCurrentCount

long getMessagesCurrentCount()

The number of messages still available by this durable subscriber.

Returns:

The messagesCurrentCount value

getMessagesHighCount

long getMessagesHighCount()

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

Returns:

The messagesHighCount value

getMessagesReceivedCount

long getMessagesReceivedCount()

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

Returns:

The messagesReceivedCount value

getBytesPendingCount

long getBytesPendingCount()

The number of bytes pending by this durable subscriber.

Returns:

The bytesPendingCount value

getBytesCurrentCount

long getBytesCurrentCount()

The number of bytes received by this durable subscriber.

Returns:

The bytesCurrentCount value

getLastMessagesReceivedTime

long getLastMessagesReceivedTime()

The time when the last time a subscriber received a message from the subscription. The returned value is a standard java absolute time, which is measured in milliseconds since midnight, January 1, 1970 UTC

This returns the JMS durable subscription boot time if there were no messages that were successfully delivered to any subscriber on this subscription since the subscription was booted. We define the boot time of a durable subscription to be the time the subscription is originally created or recovered during a server reboot or jms migration, which ever is latest.

Returns:

the time in milliseconds

purge

void purge()

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

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

getDestinationRuntime

JMSDestinationRuntimeMBean getDestinationRuntime()

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

Returns:

The runtime MBean of the subscriber's Topic.

getCurrentConsumerInfo

CompositeData getCurrentConsumerInfo()
                                     throws OpenDataException

Specifies 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

destroy

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 is no longer be valid.

Throws:

JMSException

getDestinationInfo

CompositeData getDestinationInfo()
                                 throws OpenDataException

Specifies 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)

getSubscriptionSharingPolicy

String getSubscriptionSharingPolicy()

The SubscriptionSharingPolicy on this subscriber.

Returns:

the SubscriptionSharingPolicy weblogic.management.configuration.JMSConstants.SUBSCRIPTION_EXCLUSIVE : This subscriber exclusively uses one subscription. weblogic.management.configuration.JMSConstants.SUBSCRIPTION_SHARABLE : This subscriber may share a subscription with others.

Default Value:

weblogic.management.configuration.JMSConstants.SUBSCRIPTION_EXCLUSIVE

getSubscribersTotalCount

int getSubscribersTotalCount()

The total number of subscribers that have accessed this subscription since the creation or the last reboot of the subscription, whichever is later.

Returns:

the total number of subscribers

Default Value:

0

getSubscribersHighCount

int getSubscribersHighCount()

The highest number of subscribers that have shared this subscription at the same time since the creation or the last reboot of the subscription, which ever is later.

Returns:

the number of subscribers

Default Value:

0

getSubscribersCurrentCount

int getSubscribersCurrentCount()

The number of subscribers that currently share this subscription.

Returns:

the number of subscribers

Default Value:

0