Package org.forgerock.openig.tools.notifications.ws

Class SubscriptionService

java.lang.Object

org.forgerock.openig.tools.notifications.ws.SubscriptionService

All Implemented Interfaces:

NotificationService

public class SubscriptionService
extends Object
implements NotificationService

Web-socket client endpoint that bridges AM notifications protocol to our own API.

This class manages subscriptions requests and acknowledgments asynchronously.

This class is web-socket implementation-free (no dependency on any web-socket container specific API or behaviour).

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openig.tools.notifications.NotificationService

NotificationService.Registration

Constructor Summary

Constructors

Constructor	Description
SubscriptionService(TopicManager manager)	SubscriptionService constructor taking a TopicManager.

Method Summary

Modifier and Type	Method	Description
Promise<NotificationService.Registration,NeverThrowsException>	addConnectionEventListener(Consumer<ConnectionEvent> listener)	Registers asynchronously a listener that will be notified on connection/disconnection events.
Promise<Void,NeverThrowsException>	close()	Close the SubscriptionService and unsubscribe from all topics.
void	onClose()	Means of notifying the SubscriptionService that a notification provider has closed.
void	onMessage(JsonValue message)	Means of supplying the SubscriptionService with subscription and notification messages.
void	onOpen(WebSocketAdapter webSocket)	Means of notifying the SubscriptionService that a notification provider available.
Promise<Subscription,SubscriptionException>	subscribe(String topicName, NotificationListener listener)	Subscribes (asynchronously) to a given topic, providing a listener that will be invoked at notification reception time.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionService

public SubscriptionService(TopicManager manager)

SubscriptionService constructor taking a TopicManager.

Parameters:

manager - TopicManager to handle topic subscription

Method Detail

onOpen

public void onOpen(WebSocketAdapter webSocket)

Means of notifying the SubscriptionService that a notification provider available.

Parameters:

webSocket - the WebSocket to use to handle notification registration

onClose

public void onClose()

Means of notifying the SubscriptionService that a notification provider has closed.

onMessage

public void onMessage(JsonValue message)

Means of supplying the SubscriptionService with subscription and notification messages.

Parameters:

message - the subscription or notification message

subscribe

public Promise<Subscription,SubscriptionException> subscribe(String topicName,
                                                                   NotificationListener listener)

Description copied from interface: NotificationService

Subscribes (asynchronously) to a given topic, providing a listener that will be invoked at notification reception time.

Specified by:

subscribe in interface NotificationService

Parameters:

topicName - topic name to subscribe to

listener - notification listener

Returns:

a promise of a subscription that will be completed after AM sends back the acknowledgement.

addConnectionEventListener

public Promise<NotificationService.Registration,NeverThrowsException> addConnectionEventListener(Consumer<ConnectionEvent> listener)

Description copied from interface: NotificationService

Registers asynchronously a listener that will be notified on connection/disconnection events. The returned Promise will be completed once the NotificationService is connected.

Specified by:

addConnectionEventListener in interface NotificationService

Parameters:

listener - consumer of connection events

Returns:

a promise of a registration object that has to be used for un-registration

close

public Promise<Void,NeverThrowsException> close()

Close the SubscriptionService and unsubscribe from all topics.

Returns:

a Promise