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.business.attributes;
35  
36  import fr.paris.lutece.portal.service.spring.SpringContextService;
37  import fr.paris.lutece.portal.service.util.AppLogService;
38  
39  import org.apache.commons.lang3.StringUtils;
40  
41  import java.util.List;
42  
43  
44  /**
45   *
46   * MapProviderManager : manages all map providers register.
47   * <br />
48   * Map providers are registered through {@link SpringContextService#getBeansOfType}.
49   * Such providers implement {@link IMapProvider} and need to be declared in a spring context file.
50   * @see IMapProvider
51   * @see SpringContextService#getBeansOfType
52   *
53   */
54  public final class MapProviderManager
55  {
56      /**
57       * Empty constructor
58       */
59      private MapProviderManager(  )
60      {
61          // nothing
62      }
63  
64      /**
65       * Gets the mapProvider for the provided key.
66       * @param strKey the key
67       * @return <code>null</code> if <code>strKey</code> is blank, the map provider if found, <code>null</code> otherwise.
68       * @see StringUtils#isBlank(String)
69       */
70      public static IMapProvider getMapProvider( String strKey )
71      {
72          if ( StringUtils.isBlank( strKey ) )
73          {
74              return null;
75          }
76  
77          for ( IMapProvider mapProvider : getMapProvidersList(  ) )
78          {
79              if ( strKey.equals( mapProvider.getKey(  ) ) )
80              {
81                  return mapProvider;
82              }
83          }
84  
85          AppLogService.info( MapProviderManager.class.getName(  ) + " : No map provider found for key " + strKey );
86  
87          return null;
88      }
89  
90      /**
91       * Builds all available providers list
92       * @return all available providers
93       */
94      public static List<IMapProvider> getMapProvidersList(  )
95      {
96          return SpringContextService.getBeansOfType( IMapProvider.class );
97      }
98  }