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