Package org.forgerock.openig.tools.notifications

Enum DisconnectionStrategy

java.lang.Object

java.lang.Enum<DisconnectionStrategy>

org.forgerock.openig.tools.notifications.DisconnectionStrategy

All Implemented Interfaces:

Serializable, Comparable<DisconnectionStrategy>

public enum DisconnectionStrategy
extends Enum<DisconnectionStrategy>

The different behaviours that can be applied in case of notifications disconnections.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAR_ON_DISCONNECT	Clear the cache when the notification service is disconnected.
CLEAR_ON_RECONNECT	Clear the cache when the notification service gets reconnected.
NEVER_CLEAR	Do not touch the cache when the notification service gets disconnected or reconnected.

Method Summary

Modifier and Type	Method	Description
static Consumer<ConnectionEvent>	setup(DisconnectionStrategy disconnectionStrategy, Runnable invalidateCache)	For a given DisconnectionStrategy, setup a callback that is called based on the strategy.
static DisconnectionStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DisconnectionStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLEAR_ON_DISCONNECT

public static final DisconnectionStrategy CLEAR_ON_DISCONNECT

Clear the cache when the notification service is disconnected.

CLEAR_ON_RECONNECT

public static final DisconnectionStrategy CLEAR_ON_RECONNECT

Clear the cache when the notification service gets reconnected.

NEVER_CLEAR

public static final DisconnectionStrategy NEVER_CLEAR

Do not touch the cache when the notification service gets disconnected or reconnected.

Method Detail

values

public static DisconnectionStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DisconnectionStrategy c : DisconnectionStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DisconnectionStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setup

public static Consumer<ConnectionEvent> setup(DisconnectionStrategy disconnectionStrategy,
                                              Runnable invalidateCache)

For a given DisconnectionStrategy, setup a callback that is called based on the strategy.

Parameters:

disconnectionStrategy - the DisconnectionStrategy to apply.

invalidateCache - the Runnable to call when the appropriate DisconnectionStrategy has been triggered.

Returns:

a Consumer that can be passed to a listener for ConnectionEvent events.