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
36 import java.util.concurrent.ConcurrentHashMap;
37
38 import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
39 import fr.paris.lutece.portal.service.util.AppException;
40 import net.sf.ehcache.Ehcache;
41 import net.sf.ehcache.Element;
42
43 /**
44 * Page Cache Service
45 */
46 public class PageCacheService extends AbstractCacheableService
47 {
48 private static final String SERVICE_NAME = "Page Cache Service";
49
50 // Performance patch
51 private static ConcurrentHashMap<String, String> _keyMemory = new ConcurrentHashMap<>( );
52
53 /**
54 * {@inheritDoc }
55 */
56 public String getName( )
57 {
58 return SERVICE_NAME;
59 }
60
61 /**
62 * Get a memory key
63 *
64 * @param strKey
65 * The key
66 * @return The key
67 */
68 String getKey( String strKey )
69 {
70 String keyInMemory = _keyMemory.putIfAbsent( strKey, strKey );
71
72 if ( keyInMemory != null )
73 {
74 return keyInMemory;
75 }
76
77 return strKey;
78 }
79
80 /**
81 * @see net.sf.ehcache.event.CacheEventListener#notifyElementEvicted(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
82 * @param cache
83 * The Ehcache object
84 * @param element
85 * The Element object
86 */
87 @Override
88 public void notifyElementEvicted( Ehcache cache, Element element )
89 {
90 removeKeyFromMap( element );
91 }
92
93 /**
94 * @see net.sf.ehcache.event.CacheEventListener#notifyElementExpired(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
95 * @param cache
96 * The Ehcache object
97 * @param element
98 * The Element object
99 */
100 @Override
101 public void notifyElementExpired( Ehcache cache, Element element )
102 {
103 removeKeyFromMap( element );
104 }
105
106 /**
107 * @see net.sf.ehcache.event.CacheEventListener#notifyElementRemoved(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)
108 * @param cache
109 * The Ehcache object
110 * @param element
111 * The Element object
112 */
113 @Override
114 public void notifyElementRemoved( Ehcache cache, Element element )
115 {
116 removeKeyFromMap( element );
117 }
118
119 /**
120 * @see net.sf.ehcache.event.CacheEventListener#notifyRemoveAll(net.sf.ehcache.Ehcache)
121 * @param cache
122 * The Ehcache object
123 */
124 @Override
125 public void notifyRemoveAll( Ehcache cache )
126 {
127 _keyMemory.clear( );
128 }
129
130 /**
131 * @param element
132 * The Element object
133 */
134 public void removeKeyFromMap( Element element )
135 {
136 _keyMemory.remove( (String) element.getKey( ) );
137 }
138
139 /**
140 * @see java.lang.Object#clone()
141 * @return the instance
142 */
143 @Override
144 public Object clone( )
145 {
146 throw new AppException( "This class shouldn't be cloned" );
147 }
148 }