com.sonicsw.mq.common.runtime
Interface ISubscriberData

public interface ISubscriberData

This interface provides data about a subscriber registered with the SonicMQ broker.

The broker exposes an operation "getSubscribers" through its JMX interface. This operation returns an array list of ISubscriberData elements.

See Also:

IBrokerProxy.getSubscribers(java.lang.String, java.lang.String)

Method Summary

java.lang.String	getClientID() Gets the JMS clientID associated with this subscription.
java.lang.Long	getConnectionMemberRef() Provides a connection member reference id that identifies the connection member associated with this (connected) subscription on the broker.
long	getMessageCount() Returns the number of messages currently stored by the broker for the subscription.
long	getMessageSize() Returns the number of bytes currently stored by the broker for the subscription.
java.lang.String	getSubscriptionName() Gets the JMS subscription name associated with a durable subscription.
java.lang.String	getTopicName() Gets the topic to which the subscription is subscribed.
boolean	isConnectionConsumer() Returns true if the subscription was created by a JMS connection consumer.
boolean	isDurable() Returns true if the subscription is durable.

Method Detail

getClientID

java.lang.String getClientID()

Gets the JMS clientID associated with this subscription.

getConnectionMemberRef

java.lang.Long getConnectionMemberRef()

Provides a connection member reference id that identifies the connection member associated with this (connected) subscription on the broker. This reference id can be used to retrieve additional information about the subscriber.

Returns:

This subscriber's connection member reference id, or null if the broker does not support the additional connection member API's.

See Also:

IBrokerProxy.getConnectionMemberDetails(java.util.ArrayList), com.sonicsw.mq.mgmtapi.runtime.IBrokerProxy#getConnectionTree(java.util.ArrayList, int)

getMessageCount

long getMessageCount()

Returns the number of messages currently stored by the broker for the subscription.

getMessageSize

long getMessageSize()

Returns the number of bytes currently stored by the broker for the subscription.

getSubscriptionName

java.lang.String getSubscriptionName()

Gets the JMS subscription name associated with a durable subscription. Returns null if the subscription is not durable

getTopicName

java.lang.String getTopicName()

Gets the topic to which the subscription is subscribed.

isConnectionConsumer

boolean isConnectionConsumer()

Returns true if the subscription was created by a JMS connection consumer.

isDurable

boolean isDurable()

Returns true if the subscription is durable.