PageCacheService.java

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

  35. import java.util.concurrent.ConcurrentHashMap;

  36. import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
  37. import fr.paris.lutece.portal.service.util.AppException;
  38. import net.sf.ehcache.Ehcache;
  39. import net.sf.ehcache.Element;

  40. /**
  41.  * Page Cache Service
  42.  */
  43. public class PageCacheService extends AbstractCacheableService
  44. {
  45.     private static final String SERVICE_NAME = "Page Cache Service";

  46.     // Performance patch
  47.     private static ConcurrentHashMap<String, String> _keyMemory = new ConcurrentHashMap<>( );

  48.     /**
  49.      * {@inheritDoc }
  50.      */
  51.     public String getName( )
  52.     {
  53.         return SERVICE_NAME;
  54.     }

  55.     /**
  56.      * Get a memory key
  57.      *
  58.      * @param strKey
  59.      *            The key
  60.      * @return The key
  61.      */
  62.     String getKey( String strKey )
  63.     {
  64.         String keyInMemory = _keyMemory.putIfAbsent( strKey, strKey );

  65.         if ( keyInMemory != null )
  66.         {
  67.             return keyInMemory;
  68.         }

  69.         return strKey;
  70.     }

  71.     /**
  72.      * @see net.sf.ehcache.event.CacheEventListener#notifyElementEvicted(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
  73.      * @param cache
  74.      *            The Ehcache object
  75.      * @param element
  76.      *            The Element object
  77.      */
  78.     @Override
  79.     public void notifyElementEvicted( Ehcache cache, Element element )
  80.     {
  81.         removeKeyFromMap( element );
  82.     }

  83.     /**
  84.      * @see net.sf.ehcache.event.CacheEventListener#notifyElementExpired(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
  85.      * @param cache
  86.      *            The Ehcache object
  87.      * @param element
  88.      *            The Element object
  89.      */
  90.     @Override
  91.     public void notifyElementExpired( Ehcache cache, Element element )
  92.     {
  93.         removeKeyFromMap( element );
  94.     }

  95.     /**
  96.      * @see net.sf.ehcache.event.CacheEventListener#notifyElementRemoved(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
  97.      * @param cache
  98.      *            The Ehcache object
  99.      * @param element
  100.      *            The Element object
  101.      */
  102.     @Override
  103.     public void notifyElementRemoved( Ehcache cache, Element element )
  104.     {
  105.         removeKeyFromMap( element );
  106.     }

  107.     /**
  108.      * @see net.sf.ehcache.event.CacheEventListener#notifyRemoveAll(net.sf.ehcache.Ehcache)
  109.      * @param cache
  110.      *            The Ehcache object
  111.      */
  112.     @Override
  113.     public void notifyRemoveAll( Ehcache cache )
  114.     {
  115.         _keyMemory.clear( );
  116.     }

  117.     /**
  118.      * @param element
  119.      *            The Element object
  120.      */
  121.     public void removeKeyFromMap( Element element )
  122.     {
  123.         _keyMemory.remove( (String) element.getKey( ) );
  124.     }

  125.     /**
  126.      * @see java.lang.Object#clone()
  127.      * @return the instance
  128.      */
  129.     @Override
  130.     public Object clone( )
  131.     {
  132.         throw new AppException( "This class shouldn't be cloned" );
  133.     }
  134. }