public interface UserCache
Implementations should provide appropriate methods to set their cache parameters (e.g.
time-to-live) and/or force removal of entities before their normal expiration. These
are not part of the
UserCache interface contract because they vary
depending on the type of caching system used (in-memory, disk, cluster, hybrid etc.).
Caching is generally only required in applications which do not maintain server-side state, such as remote clients or web services. The authentication credentials are then presented on each invocation and the overhead of accessing a database or other persistent storage mechanism to validate would be excessive. In this case, you would configure a cache to store the UserDetails information rather than loading it each time.
|Modifier and Type||Method and Description|
Removes the specified user from the cache.
UserDetails getUserFromCache(java.lang.String username)
UserDetailsfrom the cache.
User.getUsername()used to place the user in the cache
nullif the user could not be found or if the cache entry has expired
void putUserInCache(UserDetails user)
UserDetailsin the cache. The
usernameis the key used to subsequently retrieve the
user- the fully populated
UserDetailsto place in the cache
void removeUserFromCache(java.lang.String username)
usernameis 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.
username- to be evicted from the cache