/* 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.cache;

 import net.sf.ehcache.CacheException;

 import net.sf.ehcache.Element;

 import net.sf.ehcache.Ehcache;

 import org.acegisecurity.providers.dao.UserCache;

 import org.acegisecurity.userdetails.UserDetails;

 import org.apache.commons.logging.Log;

 import org.apache.commons.logging.LogFactory;

 import org.springframework.beans.factory.InitializingBean;

 import org.springframework.dao.DataRetrievalFailureException;

 import org.springframework.util.Assert;

 /**

  * Caches <code>User</code> objects using a Spring IoC defined <A

  * HREF="http://ehcache.sourceforge.net">EHCACHE</a>.

  *

  * @author Ben Alex

  * @version $Id: EhCacheBasedUserCache.java 1965 2007-08-27 23:41:59Z luke_t $

  */

 public class EhCacheBasedUserCache implements UserCache, InitializingBean {

     //~ Static fields/initializers =====================================================================================

     private static final Log logger = LogFactory.getLog(EhCacheBasedUserCache.class);

     //~ Instance fields ================================================================================================

     private Ehcache cache;

     //~ Methods ========================================================================================================

     public void afterPropertiesSet() throws Exception {

         Assert.notNull(cache, "cache mandatory");

     }

     public Ehcache getCache() {

         return cache;

     }

     public UserDetails getUserFromCache(String username) {

         Element element = null;

         try {

             element = cache.get(username);

         } catch (CacheException cacheException) {

             throw new DataRetrievalFailureException("Cache failure: " + cacheException.getMessage());

         }

         if (logger.isDebugEnabled()) {

             logger.debug("Cache hit: " + (element != null) + "; username: " + username);

         }

         if (element == null) {

             return null;

         } else {

             return (UserDetails) element.getValue();

         }

     }

     public void putUserInCache(UserDetails user) {

         Element element = new Element(user.getUsername(), user);

         if (logger.isDebugEnabled()) {

             logger.debug("Cache put: " + element.getKey());

         }

         cache.put(element);

     }

     public void removeUserFromCache(UserDetails user) {

         if (logger.isDebugEnabled()) {

             logger.debug("Cache remove: " + user.getUsername());

         }

         this.removeUserFromCache(user.getUsername());

     }

     public void removeUserFromCache(String username) {

         cache.remove(username);

     }

     public void setCache(Ehcache cache) {

         this.cache = cache;

     }

 }