org.xmlBlaster.engine.admin
Interface I_AdminSubscription

All Superinterfaces:

I_AdminUsage

All Known Subinterfaces:

SubscriptionInfoMBean

All Known Implementing Classes:

SubscriptionInfo

public interface I_AdminSubscription
extends I_AdminUsage

Declares available methods of a SubscriptionInfo object for administration.

SNMP or telnet tools can access only the here declared properties.
This interface is implemented by SubscriptionInfo.java, delivering the meat.

Since:

0.844

Author:

xmlBlaster@marcelruff.info

Method Summary

java.lang.String[]	getAccessFilters() Access the filter QoS of this subscription.
java.lang.String	getCreationTimestamp() Get the human readable timestamp when this subscription was established.
java.lang.String[]	getDependingSubscriptions() Get my depending subscriptions (childrens), usually caused by an XPATH subscription.
java.lang.String	getId() Access the unique identifier of this subscription.
java.lang.String	getParentSubscription() Get the parent subscription ID.
long	getPersistenceId() Gets the uniqueId for the persistence of this session.
java.lang.String	getSessionName() Get the session name of the subscriber.
java.lang.String	getSubscribeKeyStr() Get the subscription key.
java.lang.String	getSubscribeQosStr() Get the configuration for this subscription.
java.lang.String	getTopicId() Get the subscribed topic.

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

getId

java.lang.String getId()

Access the unique identifier of this subscription.

Returns:

For example "__subId:heron-12334550000"

getSessionName

java.lang.String getSessionName()

Get the session name of the subscriber.

Returns:

The session name

getTopicId

java.lang.String getTopicId()

Get the subscribed topic.

Returns:

The topic identifier

getParentSubscription

java.lang.String getParentSubscription()

Get the parent subscription ID. For example if this subscription is a result of a XPath subscription

Returns:

Can be null

getDependingSubscriptions

java.lang.String[] getDependingSubscriptions()

Get my depending subscriptions (childrens), usually caused by an XPATH subscription.

Returns:

Array of subscriptionIds

getCreationTimestamp

java.lang.String getCreationTimestamp()

Get the human readable timestamp when this subscription was established.

Returns:

The date and time of creation

getSubscribeKeyStr

java.lang.String getSubscribeKeyStr()

Get the subscription key.

Returns:

The XML dump of the Key

getSubscribeQosStr

java.lang.String getSubscribeQosStr()

Get the configuration for this subscription.

Returns:

The XML dump of the QoS

getAccessFilters

java.lang.String[] getAccessFilters()

Access the filter QoS of this subscription.

getPersistenceId

long getPersistenceId()

Gets the uniqueId for the persistence of this session.

Returns:

the uniqueId used to identify this session as an entry in the queue where it is stored (for persistent subscriptions). If the session is not persistent it returns -1L.