BaseUserPreferencesCacheService.java

  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. import fr.paris.lutece.portal.service.cache.AbstractCacheableService;

  36. import org.apache.commons.lang3.StringUtils;

  37. import java.util.ArrayList;
  38. import java.util.List;

  39. /**
  40.  * Cache service for {@link BaseUserPreferencesServiceImpl}
  41.  */
  42. public class BaseUserPreferencesCacheService extends AbstractCacheableService
  43. {
  44.     private static final String CACHE_SERVICE_NAME = "BaseUserPreferencesCacheService";
  45.     private static final String CONSTANT_UNDERSCORE = "_";

  46.     /**
  47.      * {@inheritDoc}
  48.      */
  49.     @Override
  50.     public String getName( )
  51.     {
  52.         return CACHE_SERVICE_NAME;
  53.     }

  54.     /**
  55.      * Get the key in the cache of a preference of a user
  56.      *
  57.      * @param strUserId
  58.      *            The id of the user
  59.      * @param strKey
  60.      *            The preference key
  61.      * @return The key in the cache of the preference of the user
  62.      */
  63.     public String getCacheKey( String strUserId, String strKey )
  64.     {
  65.         return strUserId + CONSTANT_UNDERSCORE + strKey;
  66.     }

  67.     /**
  68.      * Remove every values stored in cache for a given user
  69.      *
  70.      * @param strUserId
  71.      *            The user id to remove from cache
  72.      */
  73.     public void removeCacheValuesOfUser( String strUserId )
  74.     {
  75.         if ( StringUtils.isNotEmpty( strUserId ) )
  76.         {
  77.             String strPrefix = strUserId + CONSTANT_UNDERSCORE;
  78.             List<String> listKeysToRemove = new ArrayList<>( );

  79.             for ( String strKey : getKeys( ) )
  80.             {
  81.                 if ( strKey.startsWith( strPrefix ) )
  82.                 {
  83.                     listKeysToRemove.add( strKey );
  84.                 }
  85.             }

  86.             for ( String strKey : listKeysToRemove )
  87.             {
  88.                 removeKey( strKey );
  89.             }
  90.         }
  91.     }
  92. }