org.forgerock.openam.blacklist

Class CachingBlacklist<T extends Blacklistable>

java.lang.Object

org.forgerock.openam.blacklist.CachingBlacklist<T>

Type Parameters:

T - The blacklist type.

All Implemented Interfaces:

Blacklist<T>

public final class CachingBlacklist<T extends Blacklistable>
extends Object
implements Blacklist<T>

Caches elements on a least-recently used (LRU) basis.

Nested Class Summary

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

Blacklist.Listener

Constructor Summary

Constructors

Constructor and Description
CachingBlacklist(Blacklist<T> delegate, int maxSize, long purgeDelayMs) Constructs the caching entry blacklist with the given delegate blacklist and maximum cache size.

Method Summary

Modifier and Type	Method and Description
void	blacklist(T entry) Blacklists the given entry until its expiry time.
boolean	isBlacklisted(T 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

Constructor Detail

CachingBlacklist

public CachingBlacklist(Blacklist<T> delegate,
                        int maxSize,
                        long purgeDelayMs)

Constructs the caching entry blacklist with the given delegate blacklist and maximum cache size.

Parameters:

delegate - the delegate to defer cache misses to.

maxSize - the maximum size of the LRU cache to maintain.

purgeDelayMs - the additional delay before purging elements from the cache.

Method Detail

blacklist

public void blacklist(T entry)
               throws BlacklistException

Description copied from interface: Blacklist

Blacklists the given entry until its expiry time.

Specified by:

blacklist in interface Blacklist<T extends Blacklistable>

Parameters:

entry - The blacklist entry.

Throws:

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

isBlacklisted

public boolean isBlacklisted(T 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<T extends Blacklistable>

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<T extends Blacklistable>

Parameters:

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