org.efaps.db.QueryCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

The newest version!

/*
 * Copyright 2003 - 2013 The eFaps Team
 *
 * 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.
 *
 * Revision:        $Rev$
 * Last Changed:    $Date$
 * Last Changed By: $Author$
 */

package org.efaps.db;

import java.util.List;

import org.efaps.admin.AppConfigHandler;
import org.efaps.util.cache.CacheLogListener;
import org.efaps.util.cache.InfinispanCache;
import org.efaps.util.cache.NoOpCache;
import org.infinispan.Cache;
import org.infinispan.context.Flag;
import org.infinispan.notifications.Listener;
import org.infinispan.notifications.cachelistener.annotation.CacheEntryCreated;
import org.infinispan.notifications.cachelistener.event.CacheEntryCreatedEvent;
import org.infinispan.query.Search;
import org.infinispan.query.SearchManager;
import org.infinispan.query.dsl.Query;
import org.infinispan.query.dsl.QueryFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Caching for Queries.
 *
 * @author The eFaps Team
 * @version $Id$
 */
public final class QueryCache
{

    /**
     * DefaultKey.
     */
    public static final String DEFAULTKEY = QueryCache.class.getName() + ".DefaultKey";

    /**
     * Name of the Cache for Instances.
     */
    public static final String SQLCACHE = QueryCache.class.getName() + ".Sql";

    /**
     * Name of the Cache for AccessKey.
     */
    public static final String INDEXCACHE = QueryCache.class.getName() + ".Index";

    /**
     * Logging instance used in this class.
     */
    private static final Logger LOG = LoggerFactory.getLogger(QueryCache.class);

    /**
     * NoOp cache in case the QueryCache mechanism is deactivated.
     */
    private static NoOpQueryCache NOOP;


    /**
     * Utility class therefore no public Constructor.
     */
    private QueryCache()
    {
    }

    /**
     * Method to initialize the Cache of this CacheObjectInterface.
     */
    public static void initialize()
    {
        if (AppConfigHandler.get().isQueryCacheDeactivated()) {
            QueryCache.NOOP = new NoOpQueryCache();
        } else {
            if (InfinispanCache.get().exists(QueryCache.INDEXCACHE)) {
                InfinispanCache.get().getCache(QueryCache.INDEXCACHE).clear();
            } else {
                final Cache cache = InfinispanCache.get().getCache(
                                QueryCache.INDEXCACHE);
                cache.addListener(new CacheLogListener(QueryCache.LOG));
            }
            if (InfinispanCache.get().exists(QueryCache.SQLCACHE)) {
                InfinispanCache.get().getCache(QueryCache.SQLCACHE).clear();
            } else {
                final Cache cache = InfinispanCache.get().getCache(
                                QueryCache.SQLCACHE);
                cache.addListener(new CacheLogListener(QueryCache.LOG));
                cache.addListener(new SqlCacheListener());
            }
        }
    }

    /**
     * @param _key key to be cleaned
     */
    public static void cleanByKey(final String _key)
    {
        if (!AppConfigHandler.get().isQueryCacheDeactivated()) {
            final Cache indexCache = InfinispanCache.get().getIgnReCache(
                            QueryCache.INDEXCACHE);
            if (!indexCache.isEmpty()) {
                final SearchManager searchManager = Search.getSearchManager(indexCache);
                final QueryFactory qf = searchManager.getQueryFactory();
                final Query query = qf.from(QueryKey.class).having("key").eq(_key).toBuilder().build();
                final List result = query.list();
                if (result != null) {
                    for (final Object key : result) {
                        QueryCache.getSqlCache().remove(key);
                        indexCache.remove(((QueryKey) key).getIndexKey());
                    }
                }
            }
        }
    }

    /**
     * @param _cacheDef cacheDefinition
     * @param _querykey QueryKey
     * @param _object   object to store
     */
    public static void put(final ICacheDefinition _cacheDef,
                           final QueryKey _querykey,
                           final Object _object)
    {
        if (!AppConfigHandler.get().isQueryCacheDeactivated()) {
            final Cache cache = QueryCache.getSqlCache();
            if (_cacheDef.getMaxIdleTime() != 0) {
                cache.put(_querykey, _object, _cacheDef.getLifespan(), _cacheDef.getLifespanUnit(),
                                _cacheDef.getMaxIdleTime(), _cacheDef.getMaxIdleTimeUnit());
            } else if (_cacheDef.getLifespan() != 0) {
                cache.put(_querykey, _object, _cacheDef.getLifespan(), _cacheDef.getLifespanUnit());
            } else {
                cache.put(_querykey, _object);
            }
        }
    }

    /**
     * @return the QueryCache
     */
    public static Cache getSqlCache()
    {
        Cache ret;
        if (AppConfigHandler.get().isQueryCacheDeactivated()) {
            ret = QueryCache.NOOP;
        } else {
            ret = InfinispanCache.get().getCache(QueryCache.SQLCACHE).getAdvancedCache()
                            .withFlags(Flag.IGNORE_RETURN_VALUES);
        }
        return ret;
    }

    /**
     * Listener responsible to maintain the two Caches in sync. The SQLCache
     * will receive the new QueryKey in the moment that a new QueryKey is
     * inserted.
     */
    @Listener
    public static class SqlCacheListener
    {

        /**
         * If an QueryKey is inserted to SQLCache the QueryKey will also be
         * registered in the IndexCache.
         *
         * @param _event event to be logged
         */
        @CacheEntryCreated
        public void onCacheEntryCreated(final CacheEntryCreatedEvent _event)
        {
            if (!_event.isPre()) {
                final Cache indexCache = InfinispanCache.get()
                                .getIgnReCache(QueryCache.INDEXCACHE);

                final QueryKey querykey = (QueryKey) _event.getKey();
                indexCache.put(querykey.getIndexKey(), querykey);
            }
        }
    }

    /**
     * Implementation of a Cache that actually does not store anything.
     */
    private static class NoOpQueryCache
        extends NoOpCache
    {

    }
}