XmlTransformerCacheService.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.html;

  35. import fr.paris.lutece.portal.service.cache.CacheService;
  36. import fr.paris.lutece.portal.service.cache.CacheableService;
  37. import fr.paris.lutece.util.xml.XmlTransformer;

  38. import java.util.ArrayList;
  39. import java.util.List;

  40. /**
  41.  * XmlTransformerCacheService
  42.  *
  43.  * @since v 3.0
  44.  */
  45. public class XmlTransformerCacheService implements CacheableService
  46. {
  47.     private static final String SERVICE_NAME = "XML Transformer Cache Service (XSLT)";
  48.     private static final String MSG_KEYS_NOT_AVAILABLE = "Keys not available";

  49.     /**
  50.      * Inits the.
  51.      */
  52.     public static void init( )
  53.     {
  54.         CacheService.registerCacheableService( new XmlTransformerCacheService( ) );
  55.     }

  56.     /**
  57.      * {@inheritDoc }
  58.      */
  59.     @Override
  60.     public String getName( )
  61.     {
  62.         return SERVICE_NAME;
  63.     }

  64.     /**
  65.      * {@inheritDoc }
  66.      */
  67.     @Override
  68.     public boolean isCacheEnable( )
  69.     {
  70.         return true;
  71.     }

  72.     /**
  73.      * {@inheritDoc }
  74.      */
  75.     @Override
  76.     public int getCacheSize( )
  77.     {
  78.         return XmlTransformer.getTransformersCount( );
  79.     }

  80.     /**
  81.      * {@inheritDoc }
  82.      */
  83.     @Override
  84.     public void resetCache( )
  85.     {
  86.         XmlTransformer.cleanTransformerList( );
  87.     }

  88.     /**
  89.      * {@inheritDoc }
  90.      */
  91.     @Override
  92.     public void enableCache( boolean bEnable )
  93.     {
  94.         // Always enable
  95.     }

  96.     /**
  97.      * {@inheritDoc }
  98.      */
  99.     @Override
  100.     public List<String> getKeys( )
  101.     {
  102.         List<String> list = new ArrayList<>( );
  103.         list.add( MSG_KEYS_NOT_AVAILABLE );

  104.         return list;
  105.     }

  106.     /**
  107.      * {@inheritDoc }
  108.      */
  109.     @Override
  110.     public int getMaxElements( )
  111.     {
  112.         return XmlTransformer.TRANSFORMER_POOL_SIZE * XmlTransformer.MAX_TRANSFORMER_SIZE;
  113.     }

  114.     /**
  115.      * {@inheritDoc }
  116.      */
  117.     @Override
  118.     public long getTimeToLive( )
  119.     {
  120.         return 0L;
  121.     }

  122.     /**
  123.      * {@inheritDoc }
  124.      */
  125.     @Override
  126.     public long getMemorySize( )
  127.     {
  128.         return 0L;
  129.     }

  130.     /**
  131.      * {@inheritDoc }
  132.      */
  133.     @Override
  134.     public String getInfos( )
  135.     {
  136.         return "This cache can't be disabled - Poolsize = " + XmlTransformer.TRANSFORMER_POOL_SIZE;
  137.     }
  138. }