org.apache.savan.subscribers
Interface Subscriber

All Known Subinterfaces:

EventingSubscriber

All Known Implementing Classes:

AbstractSubscriber, EventingLeafSubscriber, EventingTopicSubscriber

public interface Subscriber

Defines methods common to all subscribers.

Method Summary

void	addProperty(java.lang.String key, java.lang.Object value) To add a property to the subscriber.
boolean	doesMessageBelongToTheFilter(SavanMessageContext smc) To check weather a certain message complies with the filter.
Filter	getFilter() To get the Filter object
java.lang.String	getId() To get the subscriber Id.
java.lang.Object	getProperty(java.lang.String key) To get a property from the Subscriber.
void	processPublication(SavanMessageContext publication, PublicationReport report)
void	renewSubscription(ExpirationBean bean) To renew a subscription.
void	setFilter(Filter filter) To set the Filter object
void	setId(java.lang.String id) To set the subscriber Id
void	setSubscriptionEndingTime(java.util.Date subscriptionEndingTime) To set the Subscription expiration time.

Method Detail

getFilter

public Filter getFilter()

To get the Filter object

Returns:

setFilter

public void setFilter(Filter filter)

To set the Filter object

Parameters:

filter -

getId

public java.lang.String getId()

To get the subscriber Id.

Returns:

setId

public void setId(java.lang.String id)

To set the subscriber Id

Parameters:

id -

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

To add a property to the subscriber.

Parameters:

key -

value -

getProperty

public java.lang.Object getProperty(java.lang.String key)

To get a property from the Subscriber.

Parameters:

key -

Returns:

doesMessageBelongToTheFilter

public boolean doesMessageBelongToTheFilter(SavanMessageContext smc)
                                     throws SavanException

To check weather a certain message complies with the filter.

Parameters:

smc -

Returns:

Throws:

SavanException

processPublication

public void processPublication(SavanMessageContext publication,
                               PublicationReport report)
                        throws SavanException

Throws:

SavanException

setSubscriptionEndingTime

public void setSubscriptionEndingTime(java.util.Date subscriptionEndingTime)

To set the Subscription expiration time.

Parameters:

subscriptionEndingTime -

renewSubscription

public void renewSubscription(ExpirationBean bean)

To renew a subscription.

Parameters:

bean -