cern.cmw.mom.pubsub.impl

Class SubscriptionHandle

java.lang.Object

cern.cmw.mom.pubsub.impl.SubscriptionHandle

public class SubscriptionHandle
extends java.lang.Object

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

Author:

Controls Middleware Project

Constructor Summary

Constructors

Constructor and Description
SubscriptionHandle() Default constructor for the SubscriptionHandle class.
SubscriptionHandle(TopicSubscriber subscriber, java.lang.String topic, java.lang.String selector, MessageListener listener) Constructor for the SubscriptionHandle class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Method equals
TopicSession	getSession() Return the TopicSession object.
TopicSubscriber	getSubscriber() Return the TopicSubscriber object.
MessageListener	getSubscriptionListener() Return MessageListener associated with the subscription.
java.lang.String	getSubscriptionSelector() Return the String defining the filter associated with the subscription.
long	getSubscriptionToken() Return the key identifying the subscription.
java.lang.String	getSubscriptionTopic() Return the String that identifies the subscribed topic.
void	setSession(TopicSession session) Set the TopicSession Object
void	setSubscriber(TopicSubscriber subscriber) Set the TopicSubscriber Object
void	setSubscriptionListener(MessageListener listener) Set the subscription listener
void	setSubscriptionSelector(java.lang.String selector) Set the subscription selector
void	setSubscriptionTopic(java.lang.String topic) Set the topic name

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionHandle

public SubscriptionHandle(TopicSubscriber subscriber,
                          java.lang.String topic,
                          java.lang.String selector,
                          MessageListener listener)

Constructor for the SubscriptionHandle class.

Parameters:

subscriber - the TopicSubscriber instance.

topic -

selector -

listener -

SubscriptionHandle

public SubscriptionHandle()

Default constructor for the SubscriptionHandle class.

Method Detail

setSession

public void setSession(TopicSession session)

Set the TopicSession Object

Parameters:

session - the TopicSession instance

getSession

public TopicSession getSession()

Return the TopicSession object.

Returns:

TopicSession the topic session.

setSubscriber

public void setSubscriber(TopicSubscriber subscriber)

Set the TopicSubscriber Object

Parameters:

subscriber - the TopicSubscriber instance

getSubscriber

public TopicSubscriber getSubscriber()

Return the TopicSubscriber object.

Returns:

TopicSubscriber

setSubscriptionListener

public void setSubscriptionListener(MessageListener listener)

Set the subscription listener

Parameters:

listener - the subscription listener

getSubscriptionListener

public MessageListener getSubscriptionListener()

Return MessageListener associated with the subscription.

Returns:

MessageListener the listener.

setSubscriptionSelector

public void setSubscriptionSelector(java.lang.String selector)

Set the subscription selector

Parameters:

selector - the subscription selector

getSubscriptionSelector

public java.lang.String getSubscriptionSelector()

Return the String defining the filter associated with the subscription.

Returns:

String the defined filter.

getSubscriptionToken

public long getSubscriptionToken()

Return the key identifying the subscription.

Returns:

long the subscription token.

setSubscriptionTopic

public void setSubscriptionTopic(java.lang.String topic)

Set the topic name

Parameters:

topic - the topic name

getSubscriptionTopic

public java.lang.String getSubscriptionTopic()

Return the String that identifies the subscribed topic.

Returns:

String the topic name.

equals

public boolean equals(java.lang.Object object)

Method equals

Overrides:

equals in class java.lang.Object

Parameters:

object -

Returns:

boolean