com.atlassian.crowd.openid.server.provider.association

Interface AssociationCache

All Known Implementing Classes:

InMemoryAssociationCache, RedisAssociationCache

public interface AssociationCache

Association-specific cache which also supports generating unique identifiers which have not been used before in the lifetime of the cache (via nextId()). Implementations should employ some sort of strategy to remove associations for which Association.hasExpired() returns true. Implementations must be thread-safe. Implementations must ensure that ids generated will be unique even across different instances of the cache. This is because openid4java relies on private and shared associations not only being stored in separate caches, but (if the checkPrivateSharedAssociations option is turned on) unfortunately also on each association ever created having a unique handle because it (currently) never manually removes associations from its public associations store. (Note that the requirement imposed by this interface is actually a bit stricter than openid4java's requirements, which would only require that all instances eventually used by ServerManager generate completely unique ids.) If this imposes limitations on clients' use of an implementation, implementation must clearly document it.

Method Summary

Modifier and Type	Method and Description
org.openid4java.association.Association	get(String key)
String	nextId()
void	put(String key, org.openid4java.association.Association association)
void	remove(String key)

Method Detail

nextId

String nextId()

Returns:

an identifier which is unique over the lifetime of all instances of the cache available at runtime (see note regarding uniqueness of ids generated at class-level javadoc).

put

void put(String key,
         org.openid4java.association.Association association)

Parameters:

key - key to store the association under

association - association to store

get

@Nullable
org.openid4java.association.Association get(String key)

Parameters:

key - the key of the association to fetch

Returns:

the association previously stored under the given key, or null if the association never existed, has expired or is unparseable

remove

void remove(String key)

Parameters:

key - the key that the association to delete is stored under