View Javadoc
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  
36  import fr.paris.lutece.portal.business.user.AdminUser;
37  import fr.paris.lutece.portal.service.template.AppTemplateService;
38  import fr.paris.lutece.portal.web.pluginaction.PluginActionManager;
39  import fr.paris.lutece.util.html.HtmlTemplate;
40  
41  import java.util.HashMap;
42  import java.util.Map;
43  
44  import javax.servlet.http.HttpServletRequest;
45  
46  /**
47   *
48   * This manager is used to fill the model with the actions that interact with extend. <br>
49   * It uses the method fillModel of the manager {@link PluginActionManager}.
50   *
51   */
52  public final class ExtendableResourcePluginActionManager
53  {
54      // MARKS
55      public static final String MARK_ID_EXTENDABLE_RESOURCE = "idExtendableResource";
56      public static final String MARK_EXTENDABLE_RESOURCE_TYPE = "extendableResourceType";
57      private static final String MARK_EXTENDABLE_RESOURCE_ACTIONS_HTML = "extendableResourceActionsHtml";
58      private static final String MARK_LIST_EXTENDABLE_RESOURCE_ACTIONS = "listExtendableResourceActions";
59  
60      // TEMPLATES
61      private static final String TEMPLATE_EXTENDABLE_RESOURCE_ACTION = "admin/resource/extendable_resource_actions.html";
62  
63      /**
64       * Instantiates a new extendable resource plugin action manager.
65       */
66      private ExtendableResourcePluginActionManager( )
67      {
68      }
69  
70      /**
71       * Fill the model with all actions and adds the list to the given marker. It also add the mapParameter to the model.
72       *
73       * @param request
74       *            the request
75       * @param adminUser
76       *            the admin user
77       * @param model
78       *            the model
79       * @param strIdExtendableResource
80       *            the str id extendable resource
81       * @param strExtendableResourceType
82       *            the str extendable resource type
83       */
84      public static void fillModel( HttpServletRequest request, AdminUser adminUser, Map<String, Object> model, String strIdExtendableResource,
85              String strExtendableResourceType )
86      {
87          Map<String, Object> modelTmp = new HashMap<>( );
88          modelTmp.put( MARK_ID_EXTENDABLE_RESOURCE, strIdExtendableResource );
89          modelTmp.put( MARK_EXTENDABLE_RESOURCE_TYPE, strExtendableResourceType );
90          PluginActionManager.fillModel( request, adminUser, modelTmp, IExtendableResourcePluginAction.class, MARK_LIST_EXTENDABLE_RESOURCE_ACTIONS );
91  
92          HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_EXTENDABLE_RESOURCE_ACTION, request.getLocale( ), modelTmp );
93  
94          model.put( MARK_EXTENDABLE_RESOURCE_ACTIONS_HTML, template.getHtml( ) );
95      }
96  }