View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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  
36  import fr.paris.lutece.portal.service.cache.CacheService;
37  import fr.paris.lutece.portal.service.cache.CacheableService;
38  import fr.paris.lutece.util.xml.XmlTransformer;
39  
40  import java.util.ArrayList;
41  import java.util.List;
42  
43  
44  /**
45   * XmlTransformerCacheService
46   * @since v 3.0
47   */
48  public class XmlTransformerCacheService implements CacheableService
49  {
50      private static final String SERVICE_NAME = "XML Transformer Cache Service (XSLT)";
51      private static final String MSG_KEYS_NOT_AVAILABLE = "Keys not available";
52      private static XmlTransformerCacheService _singleton;
53  
54      /**
55       * Inits the.
56       */
57      public static void init(  )
58      {
59          _singleton = new XmlTransformerCacheService(  );
60          CacheService.registerCacheableService( _singleton );
61      }
62  
63      /**
64       * {@inheritDoc }
65       */
66      @Override
67      public String getName(  )
68      {
69          return SERVICE_NAME;
70      }
71  
72      /**
73       * {@inheritDoc }
74       */
75      @Override
76      public boolean isCacheEnable(  )
77      {
78          return true;
79      }
80  
81      /**
82       * {@inheritDoc }
83       */
84      @Override
85      public int getCacheSize(  )
86      {
87          return XmlTransformer.getTransformersCount(  );
88      }
89  
90      /**
91       * {@inheritDoc }
92       */
93      @Override
94      public void resetCache(  )
95      {
96          XmlTransformer.cleanTransformerList(  );
97      }
98  
99      /**
100      * {@inheritDoc }
101      */
102     @Override
103     public void enableCache( boolean bEnable )
104     {
105         // Always enable
106     }
107 
108     /**
109      * {@inheritDoc }
110      */
111     @Override
112     public List<String> getKeys(  )
113     {
114         List<String> list = new ArrayList<String>(  );
115         list.add( MSG_KEYS_NOT_AVAILABLE );
116 
117         return list;
118     }
119 
120     /**
121      * {@inheritDoc }
122      */
123     @Override
124     public int getMaxElements(  )
125     {
126         return XmlTransformer.TRANSFORMER_POOL_SIZE * XmlTransformer.MAX_TRANSFORMER_SIZE;
127     }
128 
129     /**
130      * {@inheritDoc }
131      */
132     @Override
133     public long getTimeToLive(  )
134     {
135         return 0L;
136     }
137 
138     /**
139      * {@inheritDoc }
140      */
141     @Override
142     public long getMemorySize(  )
143     {
144         return 0L;
145     }
146 
147     /**
148      * {@inheritDoc }
149      */
150     @Override
151     public String getInfos(  )
152     {
153         return "This cache can't be disabled - Poolsize = " + XmlTransformer.TRANSFORMER_POOL_SIZE;
154     }
155 }