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

Class NotificationServiceImpl

java.lang.Object

org.forgerock.openig.tools.notifications.ws.NotificationServiceImpl

All Implemented Interfaces:

LifeCycle, NotificationService

public class NotificationServiceImpl
extends Object
implements NotificationService, LifeCycle

NotificationService implementation.

Nested Class Summary

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

NotificationService.Registration

Constructor Summary

Constructors

Constructor	Description
NotificationServiceImpl(HttpWebSocketClient client, URI uri, String ssoTokenHeader, AsyncRefreshableSupplier<SsoToken,AuthenticationException> tokenProvider, Duration reconnectDelay, int initialConnectionAttempts, Duration heartbeatInterval, ScheduledExecutorService heartbeatExecutor, Duration renewalDelay, org.forgerock.openig.tracing.TracingProvider tracingProvider)	Constructs a NotificationService implementation.

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,Exception>	start()	Starts this object.
Promise<Void,NeverThrowsException>	stop()	Stops this object.
Promise<Subscription,SubscriptionException>	subscribe(String topic, 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 Details

NotificationServiceImpl

public NotificationServiceImpl(HttpWebSocketClient client,
 URI uri,
 String ssoTokenHeader,
 AsyncRefreshableSupplier<SsoToken,AuthenticationException> tokenProvider,
 Duration reconnectDelay,
 int initialConnectionAttempts,
 Duration heartbeatInterval,
 ScheduledExecutorService heartbeatExecutor,
 Duration renewalDelay,
 org.forgerock.openig.tracing.TracingProvider tracingProvider)

Constructs a NotificationService implementation.

Parameters:

client - websocket client

uri - URI to connect to

ssoTokenHeader - SSO token header

tokenProvider - SSO token value provider

reconnectDelay - reconnection delay between attempts

initialConnectionAttempts - number of retries allowed for the first connection

heartbeatInterval - delay between heartbeats. Set to Duration.UNLIMITED or Duration.ZERO to disable.

heartbeatExecutor - ScheduledExecutorService used to schedule heartbeat tasks

renewalDelay - delay between connection renewals. Set to Duration.UNLIMITED or Duration.ZERO to disable.

tracingProvider - The TracingProvider to use when working with AM.

Method Details

start

public Promise<Void,Exception> start()

Description copied from interface: LifeCycle

Starts this object.

Specified by:

start in interface LifeCycle

Returns:

The promise of a started object or an exception if it has failed.

stop

public Promise<Void,NeverThrowsException> stop()

Description copied from interface: LifeCycle

Stops this object.

Specified by:

stop in interface LifeCycle

Returns:

The promise of a stopped object.

subscribe

public Promise<Subscription,SubscriptionException> subscribe(String topic,
 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:

topic - 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