org.forgerock.openam.blacklist

Class ConfigurableSessionBlacklist

java.lang.Object

org.forgerock.openam.blacklist.ConfigurableSessionBlacklist

All Implemented Interfaces:

Blacklist<Session>

public class ConfigurableSessionBlacklist
extends Object
implements Blacklist<Session>

Blacklist which determines the appropriate strategy to use for blacklisting based on current configuration. Strategies may include caching types, or disabling blacklisting entirely. Will be updated automatically when the session service configuration changes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openam.blacklist.Blacklist

Blacklist.Listener

Method Summary

Modifier and Type	Method and Description
void	blacklist(Session entry) Blacklists the given entry until its expiry time.
static ConfigurableSessionBlacklist	createConfigurableSessionBlacklist(CTSBlacklist<Session> ctsBlacklist, SessionServiceConfig sessionServiceConfig) Create a configurable session blacklist based on the session service config.
boolean	isBlacklisted(Session entry) Determines whether the entry has previously been blacklisted.
void	subscribe(Blacklist.Listener listener) Subscribe for notifications when entries are blacklisted.

Methods inherited from class java.lang.Object

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

Method Detail

createConfigurableSessionBlacklist

public static ConfigurableSessionBlacklist createConfigurableSessionBlacklist(CTSBlacklist<Session> ctsBlacklist,
                                                                              SessionServiceConfig sessionServiceConfig)

Create a configurable session blacklist based on the session service config.

Parameters:

ctsBlacklist - The underlying CTS blacklist.

sessionServiceConfig - The configuration of the session service.

Returns:

The created ConfigurableSessionBlacklist.

blacklist

public void blacklist(Session entry)
               throws BlacklistException

Description copied from interface: Blacklist

Blacklists the given entry until its expiry time.

Specified by:

blacklist in interface Blacklist<Session>

Parameters:

entry - The blacklist entry.

Throws:

BlacklistException - if the entry cannot be blacklisted for any reason.

isBlacklisted

public boolean isBlacklisted(Session entry)
                      throws BlacklistException

Description copied from interface: Blacklist

Determines whether the entry has previously been blacklisted. Note: entries are only blacklisted until they expire, so a false result does not mean the entry is valid. Further checks should be made to establish entry validity.

Specified by:

isBlacklisted in interface Blacklist<Session>

Parameters:

entry - The entry to check for blacklisting.

Returns:

true if the entry is currently blacklisted, or false if the entry is not blacklisted or has expired (and therefore been removed from the blacklist).

Throws:

BlacklistException - if an error occurs when checking the blacklist.

subscribe

public void subscribe(Blacklist.Listener listener)

Description copied from interface: Blacklist

Subscribe for notifications when entries are blacklisted. Depending on the implementation, this may include only entries blacklisted in the local machine, or also notifications for entries blacklisted on other nodes in the cluster.

Specified by:

subscribe in interface Blacklist<Session>

Parameters:

listener - the event listener to call when entries are blacklisted.