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
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 * XmlTransformerCacheService
45 *
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
53 /**
54 * Inits the.
55 */
56 public static void init( )
57 {
58 CacheService.registerCacheableService( new XmlTransformerCacheService( ) );
59 }
60
61 /**
62 * {@inheritDoc }
63 */
64 @Override
65 public String getName( )
66 {
67 return SERVICE_NAME;
68 }
69
70 /**
71 * {@inheritDoc }
72 */
73 @Override
74 public boolean isCacheEnable( )
75 {
76 return true;
77 }
78
79 /**
80 * {@inheritDoc }
81 */
82 @Override
83 public int getCacheSize( )
84 {
85 return XmlTransformer.getTransformersCount( );
86 }
87
88 /**
89 * {@inheritDoc }
90 */
91 @Override
92 public void resetCache( )
93 {
94 XmlTransformer.cleanTransformerList( );
95 }
96
97 /**
98 * {@inheritDoc }
99 */
100 @Override
101 public void enableCache( boolean bEnable )
102 {
103 // Always enable
104 }
105
106 /**
107 * {@inheritDoc }
108 */
109 @Override
110 public List<String> getKeys( )
111 {
112 List<String> list = new ArrayList<>( );
113 list.add( MSG_KEYS_NOT_AVAILABLE );
114
115 return list;
116 }
117
118 /**
119 * {@inheritDoc }
120 */
121 @Override
122 public int getMaxElements( )
123 {
124 return XmlTransformer.TRANSFORMER_POOL_SIZE * XmlTransformer.MAX_TRANSFORMER_SIZE;
125 }
126
127 /**
128 * {@inheritDoc }
129 */
130 @Override
131 public long getTimeToLive( )
132 {
133 return 0L;
134 }
135
136 /**
137 * {@inheritDoc }
138 */
139 @Override
140 public long getMemorySize( )
141 {
142 return 0L;
143 }
144
145 /**
146 * {@inheritDoc }
147 */
148 @Override
149 public String getInfos( )
150 {
151 return "This cache can't be disabled - Poolsize = " + XmlTransformer.TRANSFORMER_POOL_SIZE;
152 }
153 }