View Javadoc
1   /*
2    * Copyright (c) 2002-2024, 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.identitystore.cache;
35  
36  import fr.paris.lutece.plugins.identitystore.business.attribute.AttributeKey;
37  import fr.paris.lutece.plugins.identitystore.business.attribute.AttributeKeyHome;
38  import fr.paris.lutece.plugins.identitystore.v3.web.rs.util.Constants;
39  import fr.paris.lutece.plugins.identitystore.web.exception.ResourceNotFoundException;
40  import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
41  import fr.paris.lutece.portal.service.util.AppLogService;
42  
43  import java.util.ArrayList;
44  import java.util.List;
45  
46  public class AttributeKeyCache extends AbstractCacheableService
47  {
48      public static final String SERVICE_NAME = "AttributeKeyCache";
49  
50      public AttributeKeyCache( )
51      {
52          this.initCache( );
53      }
54  
55      public void refresh( )
56      {
57          AppLogService.debug( "Init AttributeKey cache" );
58          this.resetCache( );
59          AttributeKeyHome.getAttributeKeysList( true ).forEach( attributeKey -> this.put( attributeKey.getKeyName( ), attributeKey ) );
60      }
61  
62      public void put( final String keyName, final AttributeKey attributeKey )
63      {
64          if ( this.getKeys( ).contains( keyName ) )
65          {
66              this.removeKey( keyName );
67          }
68          this.putInCache( keyName, attributeKey );
69          AppLogService.debug( "AttributeKey added to cache: " + keyName );
70      }
71  
72      public void remove( final String keyName )
73      {
74          if ( this.getKeys( ).contains( keyName ) )
75          {
76              this.removeKey( keyName );
77          }
78  
79          AppLogService.debug( "AttributeKey removed from cache: " + keyName );
80      }
81  
82      public List<AttributeKey> getAll( )
83      {
84          final List<AttributeKey> allAttributeKeys = new ArrayList<>( );
85          if ( this.getKeys( ).isEmpty( ) )
86          {
87              this.refresh( );
88          }
89          for ( final String key : this.getKeys( ) )
90          {
91              try
92              {
93                  allAttributeKeys.add( this.get( key ) );
94              }
95              catch( final ResourceNotFoundException e )
96              {
97                  // this shouldn't happen : do nothing.
98              }
99          }
100         // If cache is not activated, get from db
101         if ( allAttributeKeys.isEmpty( ) )
102         {
103             allAttributeKeys.addAll( AttributeKeyHome.getAttributeKeysList( true ) );
104         }
105         return allAttributeKeys;
106     }
107 
108     public AttributeKey get( final String keyName ) throws ResourceNotFoundException
109     {
110         AttributeKey../../fr/paris/lutece/plugins/identitystore/business/attribute/AttributeKey.html#AttributeKey">AttributeKey attributeKey = (AttributeKey) this.getFromCache( keyName );
111         if ( attributeKey == null )
112         {
113             attributeKey = this.getFromDatabase( keyName );
114             this.put( keyName, attributeKey );
115         }
116         return attributeKey;
117     }
118 
119     public AttributeKey getFromDatabase( final String keyName ) throws ResourceNotFoundException
120     {
121         final AttributeKey attributeKey = AttributeKeyHome.findByKey( keyName, true );
122         if ( attributeKey == null )
123         {
124             throw new ResourceNotFoundException( "No attribute key could be found with key " + keyName, Constants.PROPERTY_REST_ERROR_UNKNOWN_ATTRIBUTE_KEY );
125         }
126         return attributeKey;
127     }
128 
129     @Override
130     public String getName( )
131     {
132         return SERVICE_NAME;
133     }
134 }