org.apache.ws.pubsub
Interface Subscription

All Known Subinterfaces:

Subscription

All Known Implementing Classes:

org.apache.ws.notification.base.impl.AbstractSubscription

public interface Subscription

A specification-generic interface respresenting a subscription.

Method Summary

java.util.Calendar	getCreationTime() Returns the time at which this subscription was created.
Filter	getFilters() Returns a list of any notification filters that are associated with this subscription.
NotificationConsumer	getNotificationConsumer() Get the notification consumer associated with this subscription.
NotificationProducer	getNotificationProducer() Get the notification producer associated with this subscription.
SubscriptionEndConsumer	getSubscriptionEndConsumer() Get the subscriptionEnd consumer associated with this subscription.
java.util.Calendar	getTerminationTime() Gets the termination time for this subscription (i.e.
boolean	getUseNotify() Returns the delivery mode to be used for notifications sent for this subscription.
void	setTerminationTime(java.util.Calendar terminationTime) Sets the termination time for this subscription (i.e.
void	unsubscribe() Cancel this subscription.

Method Detail

getCreationTime

public java.util.Calendar getCreationTime()

Returns the time at which this subscription was created.

Returns:

the time at which this subscription was created

getFilters

public Filter getFilters()

Returns a list of any notification filters that are associated with this subscription. The filters are ordered in the order in which they will be applied to notifications.

Returns:

a list of any notification filters that are associated with this subscription

getNotificationConsumer

public NotificationConsumer getNotificationConsumer()

Get the notification consumer associated with this subscription.

Returns:

the notification consumer

getNotificationProducer

public NotificationProducer getNotificationProducer()

Get the notification producer associated with this subscription.

Returns:

the notification producer

getSubscriptionEndConsumer

public SubscriptionEndConsumer getSubscriptionEndConsumer()

Get the subscriptionEnd consumer associated with this subscription.

Returns:

the subscriptionEnd consumer

setTerminationTime

public void setTerminationTime(java.util.Calendar terminationTime)

Sets the termination time for this subscription (i.e. the time at which it expires).

Parameters:

terminationTime - the termination time

getTerminationTime

public java.util.Calendar getTerminationTime()

Gets the termination time for this subscription (i.e. the time at which it expires).

Returns:

the termination time

getUseNotify

public boolean getUseNotify()

Returns the delivery mode to be used for notifications sent for this subscription. If null, a delivery mode was not specified, and a default delivery mode will be used.

Returns:

the delivery mode to be used for notifications sent for this subscription

unsubscribe

public void unsubscribe()

Cancel this subscription.