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