AdminDashboardFactory.java

  1. /*
  2.  * Copyright (c) 2002-2022, 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.business.dashboard;

  35. import fr.paris.lutece.portal.service.dashboard.admin.IAdminDashboardComponent;
  36. import fr.paris.lutece.portal.service.util.AppLogService;

  37. import java.util.ArrayList;
  38. import java.util.HashMap;
  39. import java.util.List;
  40. import java.util.Map;

  41. /**
  42.  * Factory for {@link IAdminDashboardComponent}
  43.  *
  44.  */
  45. public final class AdminDashboardFactory
  46. {
  47.     private static Map<String, IAdminDashboardComponent> _mapAdminDashboardComponents = new HashMap<>( );

  48.     /**
  49.      * Empty constructor
  50.      */
  51.     private AdminDashboardFactory( )
  52.     {
  53.         // nothing
  54.     }

  55.     /**
  56.      * Registers the new component. Name must be unique
  57.      *
  58.      * @param adminDashboardComponent
  59.      *            the component to register
  60.      * @return <code>true</code> if registered, <code>false</code> otherwise.
  61.      */
  62.     public static boolean registerDashboardComponent( IAdminDashboardComponent adminDashboardComponent )
  63.     {
  64.         String strName = adminDashboardComponent.getName( );

  65.         if ( _mapAdminDashboardComponents.containsKey( strName ) )
  66.         {
  67.             AppLogService.error( "Error while registering admin dashboard for {} class= {}, factory already contains class= {} ", strName,
  68.                     adminDashboardComponent.getClass( ), _mapAdminDashboardComponents.get( strName ) );

  69.             return false;
  70.         }

  71.         _mapAdminDashboardComponents.put( strName, adminDashboardComponent );

  72.         return true;
  73.     }

  74.     /**
  75.      * Gets the {@link IAdminDashboardComponent} for the given name
  76.      *
  77.      * @param strName
  78.      *            the name
  79.      * @return The component found, <code>null</code> otherwise.
  80.      */
  81.     public static IAdminDashboardComponent getDashboardComponent( String strName )
  82.     {
  83.         return _mapAdminDashboardComponents.get( strName );
  84.     }

  85.     /**
  86.      * Finds all registered admin dashboards
  87.      *
  88.      * @return the list
  89.      */
  90.     public static List<IAdminDashboardComponent> getAllAdminDashboardComponents( )
  91.     {
  92.         return new ArrayList<>( _mapAdminDashboardComponents.values( ) );
  93.     }
  94. }