All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.acegisecurity.providers.dao.UserCache Maven / Gradle / Ivy

There is a newer version: 1.0.7
Show newest version
/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.providers.dao;

import org.acegisecurity.userdetails.User;
import org.acegisecurity.userdetails.UserDetails;


/**
 * Provides a cache of {@link User} objects.
 * 
 * 

* Implementations should provide appropriate methods to set their cache * parameters (eg 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 (eg in-memory vs disk vs cluster vs hybrid). *

* * @author Ben Alex * @version $Id: UserCache.java 1496 2006-05-23 13:38:33Z benalex $ */ public interface UserCache { //~ Methods ======================================================================================================== /** * Obtains a {@link UserDetails} from the cache. * * @param username the {@link User#getUsername()} used to place the user in the cache * * @return the populated UserDetails or null if the user could not be found or if the * cache entry has expired */ public UserDetails getUserFromCache(String username); /** * Places a {@link UserDetails} in the cache. The username is the key used to subsequently * retrieve the UserDetails. * * @param user the fully populated UserDetails to place in the cache */ public void putUserInCache(UserDetails user); /** * 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.

* * @param username to be evicted from the cache */ public void removeUserFromCache(String username); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy