wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/cache/EhCache.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.cache;
  17
  18 import net.sf.ehcache.Cache;
  19 import net.sf.ehcache.CacheException;
  20 import net.sf.ehcache.CacheManager;
  21 import net.sf.ehcache.Element;
  22
  23 import org.wamblee.io.InputResource;
  24
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.io.Serializable;
  28 import java.util.logging.Logger;
  29
  30 /**
  31  * Cache implemented on top of EhCache.
  32  *
  33  * @author Erik Brakkee
  34  *
  35  */
  36 public class EhCache<KeyType extends Serializable, ValueType extends Serializable>
  37     implements org.wamblee.cache.Cache<KeyType, ValueType> {
  38     private static final Logger LOGGER = Logger.getLogger(EhCache.class
  39         .getName());
  40
  41     /**
  42      * EH Cache manager.
  43      */
  44     private CacheManager manager;
  45
  46     /**
  47      * EH cache.
  48      */
  49     private Cache cache;
  50
  51     /**
  52      * Constructs a cache based on EHCache.
  53      *
  54      * @param aResource
  55      *            Resource containing the configuration file for EHCache.
  56      * @param aCacheName
  57      *            Name of the cache to use. If a cache with this name does not
  58      *            exist, one is created based on default settings.
  59      * @throws IOException
  60      * @throws CacheException
  61      */
  62     public EhCache(InputResource aResource, String aCacheName)
  63         throws IOException, CacheException {
  64         InputStream is = aResource.getInputStream();
  65
  66         try {
  67             manager = new CacheManager(is);
  68             cache = manager.getCache(aCacheName);
  69
  70             if (cache == null) {
  71                 LOGGER.warning("Creating cache '" + aCacheName +
  72                     "' because it is not configured");
  73                 manager.addCache(aCacheName);
  74                 cache = manager.getCache(aCacheName);
  75             }
  76             assert cache != null;
  77         } finally {
  78             is.close();
  79         }
  80     }
  81
  82     /*
  83      * (non-Javadoc)
  84      *
  85      * @see org.wamblee.cache.Cache#put(KeyType, ValueType)
  86      */
  87     public void put(KeyType aKey, ValueType aValue) {
  88         cache.put(new Element(aKey, aValue));
  89     }
  90
  91     /*
  92      * (non-Javadoc)
  93      *
  94      * @see org.wamblee.cache.Cache#get(KeyType)
  95      */
  96     public ValueType get(KeyType aKey) {
  97         try {
  98             Element element = cache.get(aKey);
  99
 100             if (element == null) {
 101                 return null;
 102             }
 103
 104             return (ValueType) element.getValue();
 105         } catch (CacheException e) {
 106             throw new RuntimeException("Cache problem key = '" + aKey + "'", e);
 107         }
 108     }
 109
 110     /*
 111      * (non-Javadoc)
 112      *
 113      * @see org.wamblee.cache.Cache#remove(KeyType)
 114      */
 115     public void remove(KeyType aKey) {
 116         cache.remove(aKey);
 117     }
 118
 119     /*
 120      * (non-Javadoc)
 121      *
 122      * @see org.wamblee.cache.Cache#clear()
 123      */
 124     public void clear() {
 125         cache.removeAll();
 126     }
 127 }