AdminUserMenuService.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.service.user.menu;

  35. import java.util.ArrayList;
  36. import java.util.List;
  37. import java.util.ListIterator;
  38. import java.util.function.Consumer;
  39. import java.util.stream.Collectors;

  40. import javax.servlet.http.HttpServletRequest;

  41. import fr.paris.lutece.portal.business.user.menu.AdminUserMenuItem;
  42. import fr.paris.lutece.portal.business.user.menu.IAdminUserMenuItemProvider;
  43. import fr.paris.lutece.portal.service.util.AppLogService;

  44. /**
  45.  * Registry of admin user menu item providers
  46.  *
  47.  * @since 6.2.0
  48.  */
  49. public class AdminUserMenuService
  50. {
  51.     public static final String BEAN_NAME = "adminUserMenuService";

  52.     private final List<IAdminUserMenuItemProvider> _itemProviders = new ArrayList<>( );

  53.     /**
  54.      * Add an item provider to the registry
  55.      *
  56.      * Placement of the item can be altered with strAfterName or strBeforeName
  57.      *
  58.      * @param itemProvider
  59.      *            admin user menu item provider
  60.      * @param strBeforeName
  61.      *            add the item provider before the provider with this name
  62.      * @param strAfterName
  63.      *            add the item provider after the provider with this name
  64.      */
  65.     public void addItemProvider( IAdminUserMenuItemProvider itemProvider, String strAfterName, String strBeforeName )
  66.     {
  67.         if ( strAfterName != null )
  68.         {
  69.             addItemProviderInPosition( itemProvider, strAfterName, ( ListIterator<IAdminUserMenuItemProvider> i ) -> i.add( itemProvider ) );
  70.         }
  71.         else
  72.             if ( strBeforeName != null )
  73.             {
  74.                 addItemProviderInPosition( itemProvider, strBeforeName, ( ListIterator<IAdminUserMenuItemProvider> i ) -> {
  75.                     if ( i.hasPrevious( ) )
  76.                     {
  77.                         i.previous( );
  78.                         i.add( itemProvider );
  79.                     }
  80.                     else
  81.                     {
  82.                         _itemProviders.add( 0, itemProvider );
  83.                     }
  84.                 } );
  85.             }
  86.             else
  87.             {
  88.                 _itemProviders.add( itemProvider );
  89.             }
  90.         AppLogService.info( "New admin user menu item provider registered : {}", itemProvider.getName( ) );
  91.     }

  92.     private void addItemProviderInPosition( IAdminUserMenuItemProvider itemProvider, String strRefName,
  93.             Consumer<ListIterator<IAdminUserMenuItemProvider>> adder )
  94.     {
  95.         ListIterator<IAdminUserMenuItemProvider> iterator = _itemProviders.listIterator( );
  96.         boolean bFound = false;
  97.         while ( iterator.hasNext( ) )
  98.         {
  99.             IAdminUserMenuItemProvider anItem = iterator.next( );
  100.             if ( anItem.getName( ).equals( strRefName ) )
  101.             {
  102.                 bFound = true;
  103.                 adder.accept( iterator );
  104.                 break;
  105.             }
  106.         }
  107.         if ( !bFound )
  108.         {
  109.             AppLogService.error( "Did not find admin user menu item provider named <{}> when registering <{}>", strRefName, itemProvider.getName( ) );
  110.             _itemProviders.add( itemProvider );
  111.         }
  112.     }

  113.     /**
  114.      * Get all invoked admin user menu items
  115.      *
  116.      * @param request
  117.      *            the request
  118.      * @return invoked admin user menu items
  119.      */
  120.     public List<AdminUserMenuItem> getItems( final HttpServletRequest request )
  121.     {
  122.         return _itemProviders.stream( ).filter( p -> p.isInvoked( request ) ).map( p -> p.getItem( request ) ).collect( Collectors.toList( ) );
  123.     }
  124. }