org.yestech.lib.ibatis.EhCacheController.java Source code

Introduction

Here is the source code for org.yestech.lib.ibatis.EhCacheController.java

Source

/*
 * Copyright LGPL3
 * YES Technology Association
 * http://yestech.org
 *
 * http://www.opensource.org/licenses/lgpl-3.0.html
 */

/*
 *
 * Author:  Artie Copeland
 * Last Modified Date: $DateTime: $
 */
package org.yestech.lib.ibatis;

import com.ibatis.sqlmap.engine.cache.CacheModel;
import com.ibatis.sqlmap.engine.cache.CacheController;

import java.io.File;
import java.net.URL;
import java.util.Properties;

import net.sf.ehcache.Element;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Cache;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.Assert;

/**
 * This is from: http://opensource.atlassian.com/confluence/oss/display/IBATIS/3rd+Party+Contributions
 * <br/>
 * EhCache Implementation of the {@link com.ibatis.sqlmap.engine.cache.CacheController} interface to be able to use
 * EhCache as a cache implementation in iBatis. You can configure your cache model as follows, by example, in your
 * sqlMapping files:
 * &lt;cacheModel id="myCache" type="nl.rabobank.springproject.ibatis.EhCacheController" readOnly="true" serialize="false"&gt;
 *   &lt;property name="configFile" value="/path-to-ehcache.xml"/&gt;
 * &lt;/cacheModel&gt;
 * Alternatively, you can use a type alias in your type attribute and defining the class with a
 * &lt;TypeAlias&gt; declaration, see iBatis documentation on how to do this.
 */
public class EhCacheController implements CacheController {
    final private static Logger logger = LoggerFactory.getLogger(EhCacheController.class);

    /** The EhCache CacheManager. */
    private CacheManager cacheManager;

    /**
     * Flush a cache model.
     * @param cacheModel - the model to flush.
     */
    public void flush(CacheModel cacheModel) {
        getCache(cacheModel).removeAll();
    }

    /**
     * Get an object from a cache model.
     * @param cacheModel - the model.
     * @param key        - the key to the object.
     * @return the object if in the cache, or null(?).
     */
    public Object getObject(CacheModel cacheModel, Object key) {
        Object result = null;
        try {
            Element element = getCache(cacheModel).get(key.toString());
            if (element != null) {
                result = element.getObjectValue();
            }
        } catch (Exception e) {
            logger.debug("cache miss, gonna hit ibatis");
        }
        return result;

    }

    /**
     * Put an object into a cache model.
     * @param cacheModel - the model to add the object to.
     * @param key        - the key to the object.
     * @param object     - the object to add.
     */
    public void putObject(CacheModel cacheModel, Object key, Object object) {
        getCache(cacheModel).put(new Element(key.toString(), object));
    }

    /**
     * Remove an object from a cache model.
     * @param cacheModel - the model to remove the object from.
     * @param key        - the key to the object.
     * @return the removed object(?).
     */
    public Object removeObject(CacheModel cacheModel, Object key) {
        Object result = this.getObject(cacheModel, key.toString());
        getCache(cacheModel).remove(key.toString());
        return result;
    }

    /**
     * Configure a cache controller. Initialize the EH Cache Manager as a singleton.
     * This method will first check the file system for your ehcache config file. If not found,
     * it will then check on the classpath based on your configFile property.
     * <p>
     * Example of configFile property:
     * /cache/ehcache.xml - If found on file system, it will load, if not the classpath will check.
     * </p>
     *
     * @param props - the properties object continaing configuration information.
     */
    public void setProperties(Properties props) {
        Assert.notNull(props, "props must be set for this to work!");
        Assert.notNull(props.getProperty("configFile"), "configFile must not be null in your properties!");
        Assert.hasLength(props.getProperty("configFile"), "configFile property can not be empty!");

        String configFile = props.getProperty("configFile");
        File file = new File(configFile);
        if (file.exists()) {
            cacheManager = CacheManager.create(file.getAbsolutePath());
        } else {
            URL url = getClass().getResource(configFile);
            cacheManager = CacheManager.create(url);
        }
    }

    /**
     * Gets an EH Cache based on an iBatis cache Model.
     * @param cacheModel - the cache model.
     * @return the EH Cache.
     */
    private Cache getCache(CacheModel cacheModel) {
        String cacheName = cacheModel.getId();
        return cacheManager.getCache(cacheName);
    }

    /**
     * Shut down the EH Cache CacheManager.
     */
    public void finalize() {
        if (cacheManager != null) {
            cacheManager.shutdown();
        }
    }
}