View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.plugins.document.web;
35  
36  import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
37  
38  import net.sf.ehcache.Cache;
39  
40  
41  /**
42   * ResourceServletCache
43   */
44  public class ResourceServletCache extends AbstractCacheableService
45  {
46      private static final String NAME = "Document ResourceServlet Cache";
47  
48      /**
49       * Default constructor
50       */
51      public ResourceServletCache(  )
52      {
53          initCache( getName(  ) );
54      }
55  
56      /**
57       * Gets the cache name
58       * @return The cache name
59       */
60      public final String getName(  )
61      {
62          return NAME;
63      }
64  
65      /**
66       * Get from the cache
67       * @param strKey The key
68       * @return The object or null if not found
69       */
70      public ResourceValueObject get( String strKey )
71      {
72          return (ResourceValueObject) getFromCache( strKey );
73      }
74  
75      /**
76       * Put an object into the cache
77       * @param strKey The key
78       * @param resource The value
79       */
80      public void put( String strKey, ResourceValueObject resource )
81      {
82          putInCache( strKey, resource );
83      }
84  
85      /**
86       * Remove keys from a key pattern
87       * @param strKeyPattern The key pattern
88       */
89      void removeFromKeyPattern( String strKeyPattern )
90      {
91          Cache cache = getCache(  );
92  
93          for ( String strKey : getKeys(  ) )
94          {
95              if ( strKey.contains( strKeyPattern ) )
96              {
97                  cache.remove( strKey );
98              }
99          }
100     }
101 }