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

Class InitializedAmLink

java.lang.Object

org.forgerock.openig.tools.notifications.ws.link.InitializedAmLink

All Implemented Interfaces:

AmLink, AmLinkListener

public class InitializedAmLink
extends Object
implements AmLink, AmLinkListener

Subscribe to a set of initial topics while starting.

The following issues may occur while starting, and so fail the start promise:

1. The previous AmLink fails to start
2. At least one element of managedTopics can't be sent to AM
3. At least one AM Acknowledgment is not successful
4. A disconnection happens before/during the initial subscription phase: see #2 and #3

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openig.tools.notifications.ws.link.AmLink

AmLink.AmLinkSupplier, AmLink.ResilientAmLinkSupplier

Nested classes/interfaces inherited from interface org.forgerock.openig.tools.notifications.ws.link.AmLinkListener

AmLinkListener.ResilientAmLinkListener

Method Summary

Modifier and Type	Method	Description
Promise<Void,Exception>	close()	Close the AmLink and its associated resources.
static AmLink.AmLinkSupplier	initializedAmLinkSupplier(AmLink.AmLinkSupplier delegateSupplier, Set<String> initTopics)	Builds a supplier of InitializedAmLink.
void	onDisconnection()	The handler to call in case of a disconnection.
void	onNotification(Notification notification)	The notification handler, will receive all notifications sent by AM.
Promise<Void,Exception>	start()	Start the AmLink.
Promise<Void,Exception>	subscribe(String topic)	Subscribe to an AM topic.
Promise<Void,Exception>	unsubscribe(String topic)	Unsubscribe from an AM topic.

Methods inherited from class java.lang.Object

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

Method Detail

start

public Promise<Void,Exception> start()

Description copied from interface: AmLink

Start the AmLink. The AmLink is considered ready for use only when the resulting promise has successfully completed. In case of a failed promise, the instance is considered as already closed.

Note that notifications are guaranteed to be received AT LEAST once. Duplicate notification may occur.

Specified by:

start in interface AmLink

Returns:

A promise of this AmLink's start completion.

close

public Promise<Void,Exception> close()

Description copied from interface: AmLink

Close the AmLink and its associated resources. The instance can't be reused afterward.

Specified by:

close in interface AmLink

Returns:

A promise indicating the AmLink has been closed

onDisconnection

public void onDisconnection()

Description copied from interface: AmLinkListener

The handler to call in case of a disconnection. When this handler is called, the instance is considered as closed. Can only be called after the start promise successful completion, and before every ongoing (un)subscribe promise failure.

Specified by:

onDisconnection in interface AmLinkListener

onNotification

public void onNotification(Notification notification)

Description copied from interface: AmLinkListener

The notification handler, will receive all notifications sent by AM. Duplicate notifications may occur.

Specified by:

onNotification in interface AmLinkListener

Parameters:

notification - the received notification

subscribe

public Promise<Void,Exception> subscribe(String topic)

Description copied from interface: AmLink

Subscribe to an AM topic. After successful subscription, the notification consumer (supplied in will begin receiving notifications on this topic.

Specified by:

subscribe in interface AmLink

Parameters:

topic - The AM topic to subscribe to.

Returns:

A promise of a successful subscription to the AM topic.

unsubscribe

public Promise<Void,Exception> unsubscribe(String topic)

Description copied from interface: AmLink

Unsubscribe from an AM topic. After successful unsubscribe request, the notification consumer will stop receiving notifications on this topic.

Specified by:

unsubscribe in interface AmLink

Parameters:

topic - The AM topic to un-subscribe from.

Returns:

A promise of a successful un-subscription to the AM topic.

initializedAmLinkSupplier

public static AmLink.AmLinkSupplier initializedAmLinkSupplier(AmLink.AmLinkSupplier delegateSupplier,
                                                              Set<String> initTopics)

Builds a supplier of InitializedAmLink.

Parameters:

delegateSupplier - the delegated AM link supplier

initTopics - the topics which have to be subscribed to before being started.

Returns:

a supplier of InitializedAmLink.