cern.cmw.mom.pubsub.impl.SubscriptionHandle Class Reference

List of all members.

Public Member Functions
	SubscriptionHandle (TopicSubscriber subscriber, String topic, String selector, MessageListener listener)
	SubscriptionHandle ()
void	setSession (TopicSession session)
TopicSession	getSession ()
void	setSubscriber (TopicSubscriber subscriber)
TopicSubscriber	getSubscriber ()
void	setSubscriptionListener (MessageListener listener)
MessageListener	getSubscriptionListener ()
void	setSubscriptionSelector (String selector)
String	getSubscriptionSelector ()
long	getSubscriptionToken ()
void	setSubscriptionTopic (String topic)
String	getSubscriptionTopic ()
boolean	equals (Object object)

---

Detailed Description

Internal class. Incapsulate all the information related to a subscription.

Version:

1.0 23 Jan 2001

Author:

Controls Middleware Project

---

Constructor & Destructor Documentation

cern.cmw.mom.pubsub.impl.SubscriptionHandle.SubscriptionHandle	(	TopicSubscriber	subscriber,
		String	topic,
		String	selector,
		MessageListener	listener
	)

Constructor for the SubscriptionHandle class.

Parameters:

	subscriber	the TopicSubscriber instance.
	topic
	selector
	listener

cern.cmw.mom.pubsub.impl.SubscriptionHandle.SubscriptionHandle

(

)

Default constructor for the SubscriptionHandle class.

---

Member Function Documentation

boolean cern.cmw.mom.pubsub.impl.SubscriptionHandle.equals

(

Object

object

)

Method equals

Parameters:

object

Returns:

boolean

References cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriptionToken().

TopicSession cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSession

(

)

Return the TopicSession object.

Returns:

TopicSession the topic session.

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.close(), cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribe(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribeAll().

TopicSubscriber cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriber

(

)

Return the TopicSubscriber object.

Returns:

TopicSubscriber

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.close(), cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribe(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribeAll().

MessageListener cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriptionListener

(

)

Return MessageListener associated with the subscription.

Returns:

MessageListener the listener.

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.recoverSubscriptions().

String cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriptionSelector

(

)

Return the String defining the filter associated with the subscription.

Returns:

String the defined filter.

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.recoverSubscriptions().

long cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriptionToken

(

)

Return the key identifying the subscription.

Returns:

long the subscription token.

Referenced by cern.cmw.mom.pubsub.impl.SubscriptionHandle.equals(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

String cern.cmw.mom.pubsub.impl.SubscriptionHandle.getSubscriptionTopic

(

)

Return the String that identifies the subscribed topic.

Returns:

String the topic name.

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.close(), cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.recoverSubscriptions(), cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribe(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.unSubscribeAll().

void cern.cmw.mom.pubsub.impl.SubscriptionHandle.setSession

(

TopicSession

session

)

Set the TopicSession Object

Parameters:

session

the TopicSession instance

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.recoverSubscriptions(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

void cern.cmw.mom.pubsub.impl.SubscriptionHandle.setSubscriber

(

TopicSubscriber

subscriber

)

Set the TopicSubscriber Object

Parameters:

subscriber

the TopicSubscriber instance

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.recoverSubscriptions(), and cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

void cern.cmw.mom.pubsub.impl.SubscriptionHandle.setSubscriptionListener

(

MessageListener

listener

)

Set the subscription listener

Parameters:

listener

the subscription listener

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

void cern.cmw.mom.pubsub.impl.SubscriptionHandle.setSubscriptionSelector

(

String

selector

)

Set the subscription selector

Parameters:

selector

the subscription selector

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

void cern.cmw.mom.pubsub.impl.SubscriptionHandle.setSubscriptionTopic

(

String

topic

)

Set the topic name

Parameters:

topic

the topic name

Referenced by cern.cmw.mom.pubsub.impl.DefaultSubscriberImpl.subscribe().

---

The documentation for this class was generated from the following file:

• SubscriptionHandle.java