org.forgerock.openam.blacklist

Interface Blacklist<T extends Blacklistable>

Type Parameters:

T - The blacklist type.

All Known Implementing Classes:

BloomFilterBlacklist, CachingBlacklist, ConfigurableSessionBlacklist, CTSBlacklist, NoOpBlacklist

public interface Blacklist<T extends Blacklistable>

Records a blacklist of entries that have been destroyed/logged out to ensure that they cannot be reused.

Since:

13.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Blacklist.Listener

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.

Method Detail

blacklist

void blacklist(T entry)
        throws BlacklistException

Blacklists the given entry until its expiry time.

Parameters:

entry - The blacklist entry.

Throws:

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

isBlacklisted

boolean isBlacklisted(T entry)
               throws BlacklistException

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.

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

void subscribe(Blacklist.Listener listener)

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.

Parameters:

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