WidgetContentCacheService.java

/*
 * Copyright (c) 2002-2014, Mairie de 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.plugins.myportal.service.cache;

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

/**
 * WidgetContentCacheService
 */
public final class WidgetContentCacheService extends AbstractCacheableService
{
    private static final String SERVICE_NAME = "MyPortal Widget Content Cache Service";
    private static WidgetContentCacheService _singleton;

    /**
     * Constructor
     */
    private WidgetContentCacheService( )
    {
    }

    /**
     * Get the instance of WidgetContentCacheService
     * 
     * @return an instance of WidgetContentCacheService
     */
    public static WidgetContentCacheService getInstance( )
    {
        if ( _singleton == null )
        {
            _singleton = new WidgetContentCacheService( );
        }

        return _singleton;
    }

    /**
     * {@inheritDoc }
     */
    public String getName( )
    {
        return SERVICE_NAME;
    }

    /**
     * Remove the cache by a key
     * 
     * @param strKey
     *            the cache key
     */
    public void removeCache( String strKey )
    {
        try
        {
            if ( isCacheEnable( ) && ( getCache( ) != null ) )
            {
                getCache( ).remove( strKey );
            }
        }
        catch( IllegalStateException e )
        {
            AppLogService.error( e.getMessage( ), e );
        }
    }
}