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.cache;
35
36 import fr.paris.lutece.portal.service.security.LuteceUser;
37
38 import java.util.List;
39 import java.util.Map;
40 import java.util.Map.Entry;
41
42 /**
43 * Default cache key service
44 *
45 */
46 public class DefaultCacheKeyService implements ICacheKeyService
47 {
48 private List<String> _listAllowedParameters;
49 private List<String> _listIgnoredParameters;
50
51 /**
52 * Calculate the cache key
53 *
54 * @param mapParams
55 * A map of key/value
56 * @param nMode
57 * The mode
58 * @param user
59 * The LuteceUser
60 * @return The calculated key
61 */
62 public String getKey( Map<String, String> mapParams, int nMode, LuteceUser user )
63 {
64 StringBuilder sbKey = new StringBuilder( );
65
66 for ( Entry<String, String> entry : mapParams.entrySet( ) )
67 {
68 String strHtKey = entry.getKey( );
69
70 if ( ( ( _listAllowedParameters == null ) || _listAllowedParameters.contains( strHtKey ) )
71 && ( ( _listIgnoredParameters == null ) || ( !_listIgnoredParameters.contains( strHtKey ) ) ) )
72 {
73 sbKey.append( "[" ).append( strHtKey ).append( ":" ).append( entry.getValue( ) ).append( "]" );
74 }
75 }
76
77 String strUserName = ( user != null ) ? user.getName( ) : "-";
78
79 sbKey.append( "[m:" ).append( nMode ).append( "]" );
80 sbKey.append( "[user:" ).append( strUserName ).append( "]" );
81
82 return sbKey.toString( );
83 }
84
85 /**
86 * {@inheritDoc}
87 */
88 public void setAllowedParametersList( List<String> list )
89 {
90 _listAllowedParameters = list;
91 }
92
93 /**
94 * {@inheritDoc}
95 */
96 public void setIgnoredParametersList( List<String> list )
97 {
98 _listIgnoredParameters = list;
99 }
100 }