01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * Unless required by applicable law or agreed to in writing, software
10: * distributed under the License is distributed on an "AS IS" BASIS,
11: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: * See the License for the specific language governing permissions and
13: * limitations under the License.
14: */
15:
16: package org.acegisecurity.providers.dao;
17:
18: import org.acegisecurity.userdetails.User;
19: import org.acegisecurity.userdetails.UserDetails;
20:
21: /**
22: * Provides a cache of {@link User} objects.
23: *
24: * <P>
25: * Implementations should provide appropriate methods to set their cache
26: * parameters (eg time-to-live) and/or force removal of entities before their
27: * normal expiration. These are not part of the <code>UserCache</code>
28: * interface contract because they vary depending on the type of caching
29: * system used (eg in-memory vs disk vs cluster vs hybrid).
30: * </p>
31: *
32: * @author Ben Alex
33: * @version $Id: UserCache.java 1784 2007-02-24 21:00:24Z luke_t $
34: */
35: public interface UserCache {
36: //~ Methods ========================================================================================================
37:
38: /**
39: * Obtains a {@link UserDetails} from the cache.
40: *
41: * @param username the {@link User#getUsername()} used to place the user in the cache
42: *
43: * @return the populated <code>UserDetails</code> or <code>null</code> if the user could not be found or if the
44: * cache entry has expired
45: */
46: UserDetails getUserFromCache(String username);
47:
48: /**
49: * Places a {@link UserDetails} in the cache. The <code>username</code> is the key used to subsequently
50: * retrieve the <code>UserDetails</code>.
51: *
52: * @param user the fully populated <code>UserDetails</code> to place in the cache
53: */
54: void putUserInCache(UserDetails user);
55:
56: /**
57: * Removes the specified user from the cache. The <code>username</code> is the key used to remove the user.
58: * If the user is not found, the method should simply return (not thrown an exception).<P>Some cache
59: * implementations may not support eviction from the cache, in which case they should provide appropriate
60: * behaviour to alter the user in either its documentation, via an exception, or through a log message.</p>
61: *
62: * @param username to be evicted from the cache
63: */
64: void removeUserFromCache(String username);
65: }
|