ExtendableResourcePluginActionManager.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.web.resource;

  35. import fr.paris.lutece.portal.business.user.AdminUser;
  36. import fr.paris.lutece.portal.service.template.AppTemplateService;
  37. import fr.paris.lutece.portal.web.pluginaction.PluginActionManager;
  38. import fr.paris.lutece.util.html.HtmlTemplate;

  39. import java.util.HashMap;
  40. import java.util.Map;

  41. import javax.servlet.http.HttpServletRequest;

  42. /**
  43.  *
  44.  * This manager is used to fill the model with the actions that interact with extend. <br>
  45.  * It uses the method fillModel of the manager {@link PluginActionManager}.
  46.  *
  47.  */
  48. public final class ExtendableResourcePluginActionManager
  49. {
  50.     // MARKS
  51.     public static final String MARK_ID_EXTENDABLE_RESOURCE = "idExtendableResource";
  52.     public static final String MARK_EXTENDABLE_RESOURCE_TYPE = "extendableResourceType";
  53.     private static final String MARK_EXTENDABLE_RESOURCE_ACTIONS_HTML = "extendableResourceActionsHtml";
  54.     private static final String MARK_LIST_EXTENDABLE_RESOURCE_ACTIONS = "listExtendableResourceActions";

  55.     // TEMPLATES
  56.     private static final String TEMPLATE_EXTENDABLE_RESOURCE_ACTION = "admin/resource/extendable_resource_actions.html";

  57.     /**
  58.      * Instantiates a new extendable resource plugin action manager.
  59.      */
  60.     private ExtendableResourcePluginActionManager( )
  61.     {
  62.     }

  63.     /**
  64.      * Fill the model with all actions and adds the list to the given marker. It also add the mapParameter to the model.
  65.      *
  66.      * @param request
  67.      *            the request
  68.      * @param adminUser
  69.      *            the admin user
  70.      * @param model
  71.      *            the model
  72.      * @param strIdExtendableResource
  73.      *            the str id extendable resource
  74.      * @param strExtendableResourceType
  75.      *            the str extendable resource type
  76.      */
  77.     public static void fillModel( HttpServletRequest request, AdminUser adminUser, Map<String, Object> model, String strIdExtendableResource,
  78.             String strExtendableResourceType )
  79.     {
  80.         Map<String, Object> modelTmp = new HashMap<>( );
  81.         modelTmp.put( MARK_ID_EXTENDABLE_RESOURCE, strIdExtendableResource );
  82.         modelTmp.put( MARK_EXTENDABLE_RESOURCE_TYPE, strExtendableResourceType );
  83.         PluginActionManager.fillModel( request, adminUser, modelTmp, IExtendableResourcePluginAction.class, MARK_LIST_EXTENDABLE_RESOURCE_ACTIONS );

  84.         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_EXTENDABLE_RESOURCE_ACTION, request.getLocale( ), modelTmp );

  85.         model.put( MARK_EXTENDABLE_RESOURCE_ACTIONS_HTML, template.getHtml( ) );
  86.     }
  87. }