View Javadoc
1   /*
2    * Copyright (c) 2002-2025, 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.datastore;
35  
36  import java.util.Set;
37  import java.util.concurrent.ConcurrentHashMap;
38  
39  import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
40  
41  /**
42   * Datastore Cache Service
43   */
44  public class DatastoreCacheService extends AbstractCacheableService
45  {
46      private static final String CACHE_SERVICE_NAME = "Datastore Cache Service";
47      private final Set<String> _prefixes;
48  
49      /** Constructor */
50      public DatastoreCacheService( )
51      {
52          initCache( );
53          _prefixes = ConcurrentHashMap.newKeySet( );
54      }
55  
56      /**
57       * Gets the cache service name
58       * 
59       * @return The service name
60       */
61      @Override
62      public String getName( )
63      {
64          return CACHE_SERVICE_NAME;
65      }
66  
67      /**
68       * Get a cache key for an entity key
69       * 
70       * @param strKey
71       *            the entity key
72       * @return the cache key
73       */
74      String getEntityCacheKey( String strKey )
75      {
76          return "k:" + strKey;
77      }
78  
79      /**
80       * Get a cache key for a prefix
81       * 
82       * @param strPrefix
83       *            the prefix
84       * @return the cache key
85       */
86      String getPrefixCacheKey( String strPrefix )
87      {
88          String strCacheKey = "p:" + strPrefix;
89          _prefixes.add( strCacheKey );
90          return strCacheKey;
91      }
92  
93      /**
94       * Remove from the cache the values for all cached prefixes
95       */
96      void removeCachedPrefixes( )
97      {
98          _prefixes.forEach( ( String strPrefix ) -> removeKey( strPrefix ) );
99      }
100 }