Package org.springframework.security.core.userdetails.cache

Class SpringCacheBasedUserCache

java.lang.Object

org.springframework.security.core.userdetails.cache.SpringCacheBasedUserCache

All Implemented Interfaces:

UserCache

public class SpringCacheBasedUserCache
extends java.lang.Object
implements UserCache

Caches UserDetails instances in a Spring defined Cache.

Since:

3.2

Constructor Summary

Constructors

Constructor	Description
SpringCacheBasedUserCache(org.springframework.cache.Cache cache)

Method Summary

Modifier and Type	Method	Description
UserDetails	getUserFromCache(java.lang.String username)	Obtains a UserDetails from the cache.
void	putUserInCache(UserDetails user)	Places a UserDetails in the cache.
void	removeUserFromCache(java.lang.String username)	Removes the specified user from the cache.
void	removeUserFromCache(UserDetails user)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringCacheBasedUserCache

public SpringCacheBasedUserCache(org.springframework.cache.Cache cache)

Method Detail

getUserFromCache

public UserDetails getUserFromCache(java.lang.String username)

Description copied from interface: UserCache

Obtains a UserDetails from the cache.

Specified by:

getUserFromCache in interface UserCache

Parameters:

username - the User.getUsername() used to place the user in the cache

Returns:

the populated UserDetails or null if the user could not be found or if the cache entry has expired

putUserInCache

public void putUserInCache(UserDetails user)

Description copied from interface: UserCache

Places a UserDetails in the cache. The username is the key used to subsequently retrieve the UserDetails.

Specified by:

putUserInCache in interface UserCache

Parameters:

user - the fully populated UserDetails to place in the cache

removeUserFromCache

public void removeUserFromCache(UserDetails user)

removeUserFromCache

public void removeUserFromCache(java.lang.String username)

Description copied from interface: UserCache

Removes the specified user from the cache. The username is the key used to remove the user. If the user is not found, the method should simply return (not thrown an exception).

Some cache implementations may not support eviction from the cache, in which case they should provide appropriate behaviour to alter the user in either its documentation, via an exception, or through a log message.

Specified by:

removeUserFromCache in interface UserCache

Parameters:

username - to be evicted from the cache