Package com.tivoli.am.fim.trustserver.sts.utilities

Interface IDMappingExtCache

All Known Implementing Classes:

IDMappingExtCacheDMAPImpl

public interface IDMappingExtCache

Method Summary

Modifier and Type	Method	Description
boolean	exists(String lookupKey)	Returns true if the lookup key exists in the cache, otherwise returns false.
String	get(String lookupKey)	Returns an entry for the given lookup key that was previously stored in our cache.
String	getAndRemove(String lookupKey)	Returns an entry that was previously stored in our cache.
void	put(String lookupKey, String entry, int lifetime)	Stores an association for a given state id in a cache.

Method Details

put

void put(String lookupKey,
 String entry,
 int lifetime)

Stores an association for a given state id in a cache.

Parameters:

lookupKey - - The key that will be later used to lookup the entry. The max key length is 109 characters.

entry - - The entry to store in a cache. The maximum length of entry is specific to the database being used.

lifetime - - The length of time we should store the association in seconds

get

String get(String lookupKey)

Returns an entry for the given lookup key that was previously stored in our cache.

Parameters:

lookupKey -

Returns:

The stored entry, or null if there is no current valid entry for the given lookupKey.

exists

boolean exists(String lookupKey)

Returns true if the lookup key exists in the cache, otherwise returns false.

Parameters:

lookupKey -

Returns:

getAndRemove

String getAndRemove(String lookupKey)

Returns an entry that was previously stored in our cache. The given lookupKey is used to find the entry. The entry is removed from the cache. If the entry does not exist this will return null.

Parameters:

lookupKey -

Returns:

The stored entry, or null if there is no current valid entry for the given lookupKey.