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.web.includes;
35
36 import java.util.Locale;
37
38 import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
39 import fr.paris.lutece.portal.service.plugin.PluginEvent;
40 import fr.paris.lutece.portal.service.plugin.PluginEventListener;
41 import fr.paris.lutece.portal.service.plugin.PluginService;
42
43 /**
44 * Cache service for LinksInclude
45 */
46 public class LinksIncludeCacheService extends AbstractCacheableService implements PluginEventListener
47 {
48 public static final String SERVICE_NAME = "LinksIncludeCacheService";
49
50 public LinksIncludeCacheService( )
51 {
52 initCache( );
53 PluginService.registerPluginEventListener( this );
54 }
55
56 @Override
57 public String getName( )
58 {
59 return SERVICE_NAME;
60 }
61
62 /**
63 * Get a cache key
64 *
65 * @param nMode
66 * mode
67 * @param strPage
68 * page id
69 * @param locale
70 * locale
71 * @return a cache key
72 */
73 public String getCacheKey( int nMode, String strPage, Locale locale )
74 {
75 StringBuilder builder = new StringBuilder( "[mode=" );
76 builder.append( nMode ).append( ']' );
77 if ( strPage != null )
78 {
79 builder.append( "[page=" ).append( strPage ).append( ']' );
80 }
81 builder.append( "[locale=" ).append( locale ).append( ']' );
82 return builder.toString( );
83 }
84
85 @Override
86 public void processPluginEvent( PluginEvent event )
87 {
88 resetCache( );
89 }
90
91 }