DatastoreCacheService.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.datastore;

import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import fr.paris.lutece.portal.service.cache.AbstractCacheableService;

/**
 * Datastore Cache Service
 */
public class DatastoreCacheService extends AbstractCacheableService
{
    private static final String CACHE_SERVICE_NAME = "Datastore Cache Service";
    private final Set<String> _prefixes;

    /** Constructor */
    public DatastoreCacheService( )
    {
        initCache( );
        _prefixes = ConcurrentHashMap.newKeySet( );
    }

    /**
     * Gets the cache service name
     * 
     * @return The service name
     */
    @Override
    public String getName( )
    {
        return CACHE_SERVICE_NAME;
    }

    /**
     * Get a cache key for an entity key
     * 
     * @param strKey
     *            the entity key
     * @return the cache key
     */
    String getEntityCacheKey( String strKey )
    {
        return "k:" + strKey;
    }

    /**
     * Get a cache key for a prefix
     * 
     * @param strPrefix
     *            the prefix
     * @return the cache key
     */
    String getPrefixCacheKey( String strPrefix )
    {
        String strCacheKey = "p:" + strPrefix;
        _prefixes.add( strCacheKey );
        return strCacheKey;
    }

    /**
     * Remove from the cache the values for all cached prefixes
     */
    void removeCachedPrefixes( )
    {
        _prefixes.forEach( ( String strPrefix ) -> removeKey( strPrefix ) );
    }
}