com.avaya.collaboration.eventing

Interface EventingService

public interface EventingService

Object used to perform various Eventing Framework operations, such as subscribing for events.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
Set	querySubscriptions(SubscriptionSelectionFilter filter) Retrieve a list of subscriptions according to the given filter criteria.
void	renewSubscription(String subscriptionId) Renew a subscription.
String	subscribe(EventSubscriptionAttributes attributes) Subscribe for an event.
void	unsubscribe(String subscriptionId) Unsubscribe a subscription.
void	unsubscribeAll() Unsubscribe from all existing subscriptions that have been made by the specific version of the snap-in invoking this method.

Method Detail

subscribe

String subscribe(EventSubscriptionAttributes attributes)

Subscribe for an event.

Parameters:

attributes - The EventSubscriptionAttributes object specifying the various properties of a subscription. The attributes will typically specify an event family, one or more events types, and a set of filter criteria to limit the event notifications to events of interest.

Returns:

the subscription Id

querySubscriptions

Set querySubscriptions(SubscriptionSelectionFilter filter)

Retrieve a list of subscriptions according to the given filter criteria. The list of subscriptions returned is restricted to those created by the calling snap-in, as determined by actual consumer name and version; no preferred version functionality is available for this method.

Parameters:

filter - A filter specifying which subscriptions to return.

Returns:

the set of subscriptions as Set<EventSubscription>

Since:

3.1

renewSubscription

void renewSubscription(String subscriptionId)

Renew a subscription. Subscriptions have an expiration time of around 8 - 9 hours. This method is called by a consumer to renew a subscription.

A special event called EventingFramework:SUBSCRIPTION_EXPIRATION is sent to a consumer shortly before subscription expiration. This event makes it easy for a consumer to renew a subscription. The body of this event consists simply of a String, which is the subscription ID. A consumer receiving the event can renew the subscription by calling this method using the value contained in the Event body.

Please note that use of the SUBSCRIPTION_EXPIRING event has some important caveats. See the package level Javadoc of the Eventing Framework ( com.avaya.collaboration.eventing) for more information.

Parameters:

subscriptionId - The ID of the subscription to be renewed.

unsubscribe

void unsubscribe(String subscriptionId)

Unsubscribe a subscription.

Parameters:

subscriptionId - The ID of the subscription to unsubscribe. Note that if a single subscription is made for multiple event types, it is not possible to unsubscribe for only a subset of those event types. To achieve finer granularity with unsubscribe one must subscribe with finer granularity.

unsubscribeAll

void unsubscribeAll()

Unsubscribe from all existing subscriptions that have been made by the specific version of the snap-in invoking this method.