org.forgerock.openam.blacklist

Interface Blacklistable

public interface Blacklistable

An object which can be placed in a Blacklist.

Method Summary

Modifier and Type	Method and Description
long	getBlacklistExpiryTime() The expiry time of the object in the blacklist.
String	getStableStorageID() Returns a stable ID that can be used as a unique identifier when storing this entry.

Method Detail

getStableStorageID

String getStableStorageID()

Returns a stable ID that can be used as a unique identifier when storing this entry.

This will be used as a stable reference to this ID which all callers are expected to know and use.

Returns:

A unique stable storage id.

getBlacklistExpiryTime

long getBlacklistExpiryTime()
                     throws BlacklistException

The expiry time of the object in the blacklist. The blacklist will only store objects until their expiry time elapses. After which the blacklist will at some point purge the entry. It is recommended to set this value to the expiry time of the object, or a timestamp after which the object no longer matters. It is not recommend to set this to a large indefinite point in the future as this will remain stored in the blacklist for this period. Note: time stamp is in ms from epoch UTC.

Returns:

The time at which the entry expires (if it has not already) plus a purge delay.

Throws:

BlacklistException - If the entry has already expired or an error occurs.