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.prefs;
35
36 import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
37
38 import org.apache.commons.lang3.StringUtils;
39
40 import java.util.ArrayList;
41 import java.util.List;
42
43 /**
44 * Cache service for {@link BaseUserPreferencesServiceImpl}
45 */
46 public class BaseUserPreferencesCacheService extends AbstractCacheableService
47 {
48 private static final String CACHE_SERVICE_NAME = "BaseUserPreferencesCacheService";
49 private static final String CONSTANT_UNDERSCORE = "_";
50
51 /**
52 * {@inheritDoc}
53 */
54 @Override
55 public String getName( )
56 {
57 return CACHE_SERVICE_NAME;
58 }
59
60 /**
61 * Get the key in the cache of a preference of a user
62 *
63 * @param strUserId
64 * The id of the user
65 * @param strKey
66 * The preference key
67 * @return The key in the cache of the preference of the user
68 */
69 public String getCacheKey( String strUserId, String strKey )
70 {
71 return strUserId + CONSTANT_UNDERSCORE + strKey;
72 }
73
74 /**
75 * Remove every values stored in cache for a given user
76 *
77 * @param strUserId
78 * The user id to remove from cache
79 */
80 public void removeCacheValuesOfUser( String strUserId )
81 {
82 if ( StringUtils.isNotEmpty( strUserId ) )
83 {
84 String strPrefix = strUserId + CONSTANT_UNDERSCORE;
85 List<String> listKeysToRemove = new ArrayList<>( );
86
87 for ( String strKey : getKeys( ) )
88 {
89 if ( strKey.startsWith( strPrefix ) )
90 {
91 listKeysToRemove.add( strKey );
92 }
93 }
94
95 for ( String strKey : listKeysToRemove )
96 {
97 removeKey( strKey );
98 }
99 }
100 }
101 }