Package org.wildfly.security.cache

Class LRURealmIdentityCache

java.lang.Object

org.wildfly.security.cache.LRURealmIdentityCache

All Implemented Interfaces:

RealmIdentityCache

public final class LRURealmIdentityCache
extends Object
implements RealmIdentityCache

A RealmIdentityCache implementation providing a LRU cache.

Author:

Pedro Igor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	LRURealmIdentityCache.CacheEntry

Field Summary

Fields

Modifier and Type	Field	Description
private static float	DEFAULT_LOAD_FACTOR	The load factor.
private Map<Principal,Set<Principal>>	domainPrincipalMap	Holds a mapping between a realm principal and domain principals
private Map<Principal,LRURealmIdentityCache.CacheEntry>	identityCache	Holds the cached identitys where the key is the domain principal, the one used to lookup the identity
private long	maxAge
private AtomicBoolean	writing

Constructor Summary

Constructors

Constructor	Description
LRURealmIdentityCache(int maxEntries)	Creates a new instance.
LRURealmIdentityCache(int maxEntries, long maxAge)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all cached identities from this cache.
RealmIdentity	get(Principal key)	Obtains a previously cached RealmIdentity or null if no entry could be found with the specified Principal.
private boolean	parkForReadAndCheckInterrupt()
private boolean	parkForWriteAndCheckInterrupt()
void	put(Principal key, RealmIdentity newValue)	Puts a new RealmIdentity into the cache and referenced by the specified Principal.
void	remove(Principal key)	Removes a specific cached identity from the cache and referenced by the specified Principal.
private RealmIdentity	removeIfExpired(LRURealmIdentityCache.CacheEntry cached)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.wildfly.security.cache.RealmIdentityCache

computeIfAbsent

Field Detail

DEFAULT_LOAD_FACTOR

private static final float DEFAULT_LOAD_FACTOR

The load factor.

See Also:

Constant Field Values

identityCache

private final Map<Principal,LRURealmIdentityCache.CacheEntry> identityCache

Holds the cached identitys where the key is the domain principal, the one used to lookup the identity

domainPrincipalMap

private final Map<Principal,Set<Principal>> domainPrincipalMap

Holds a mapping between a realm principal and domain principals

writing

private final AtomicBoolean writing

maxAge

private final long maxAge

Constructor Detail

LRURealmIdentityCache

public LRURealmIdentityCache(int maxEntries)

Creates a new instance.

Parameters:

maxEntries - the maximum number of entries to keep in the cache

LRURealmIdentityCache

public LRURealmIdentityCache(int maxEntries,
                             long maxAge)

Creates a new instance.

Parameters:

maxEntries - the maximum number of entries to keep in the cache

maxAge - the time in milliseconds that an entry can stay in the cache. If -1, entries never expire

Method Detail

put

public void put(Principal key,
                RealmIdentity newValue)

Description copied from interface: RealmIdentityCache

Puts a new RealmIdentity into the cache and referenced by the specified Principal.

Specified by:

put in interface RealmIdentityCache

Parameters:

key - the Principal that references the realm identity being cached

newValue - the RealmIdentity instance

get

public RealmIdentity get(Principal key)

Description copied from interface: RealmIdentityCache

Obtains a previously cached RealmIdentity or null if no entry could be found with the specified Principal.

Specified by:

get in interface RealmIdentityCache

Parameters:

key - the Principal that references a previously cached realm identity

Returns:

a cached RealmIdentity instance or null if no entry could be found with the specified principal.

remove

public void remove(Principal key)

Description copied from interface: RealmIdentityCache

Removes a specific cached identity from the cache and referenced by the specified Principal.

Specified by:

remove in interface RealmIdentityCache

Parameters:

key - the Principal that references a previously cached realm identity

clear

public void clear()

Description copied from interface: RealmIdentityCache

Removes all cached identities from this cache.

Specified by:

clear in interface RealmIdentityCache

removeIfExpired

private RealmIdentity removeIfExpired(LRURealmIdentityCache.CacheEntry cached)

parkForWriteAndCheckInterrupt

private boolean parkForWriteAndCheckInterrupt()

parkForReadAndCheckInterrupt

private boolean parkForReadAndCheckInterrupt()