View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.pluginaction;
35  
36  import fr.paris.lutece.portal.business.user.AdminUser;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  import java.util.List;
40  import java.util.Map;
41  
42  import javax.servlet.http.HttpServletRequest;
43  
44  
45  /**
46   *
47   * PluginActionManager.
48   * <ul>
49   * <li>
50   * Use {@link #getPluginAction(HttpServletRequest, Class)} to find the invoked action
51   * <li>
52   * Use {@link #fillModel(HttpServletRequest, AdminUser, Map, Class, String)} to fill you model
53   * </ul>
54   * @see #getListPluginAction(Class)
55   * @see #getPluginAction(HttpServletRequest, Class)
56   * @see #fillModel(HttpServletRequest, AdminUser, Map, Class, String)
57   *
58   */
59  public final class PluginActionManager
60  {
61      /**
62       * Empty constructor
63       */
64      private PluginActionManager(  )
65      {
66          // nothing
67      }
68  
69      /**
70       * Gets the list of {@link IDirectoryAction}.
71       *
72       * @param <A> the generic type
73       * @param pluginActionClass the plugin action class
74       * @return the list
75       */
76      public static <A extends IPluginAction<?>> List<A> getListPluginAction( Class<A> pluginActionClass )
77      {
78          return SpringContextService.getBeansOfType( pluginActionClass );
79      }
80  
81      /**
82       * Gets the {@link IPluginAction} for the request.
83       *
84       * @param <A> the generic type
85       * @param request the request
86       * @param pluginActionClass the plugin action class
87       * @return the invoked {@link IPluginAction}, <code>null</code> otherwise.
88       * @see IPluginAction#isInvoked(HttpServletRequest)
89       */
90      public static <A extends IPluginAction<?>> A getPluginAction( HttpServletRequest request, Class<A> pluginActionClass )
91      {
92          for ( A action : getListPluginAction( pluginActionClass ) )
93          {
94              if ( action.isInvoked( request ) )
95              {
96                  return action;
97              }
98          }
99  
100         return null;
101     }
102 
103     /**
104      * Fills the model with all actions and adds the list to the given marker
105      * @param request the request
106      * @param adminUser the admin user
107      * @param model the model
108      * @param pluginActionClass the action class (usually the interface)
109      * @param strMark the marker to put for the actions list
110      * @param <A> the action type (usually the interface)
111      */
112     public static <A extends IPluginAction<?>> void fillModel( HttpServletRequest request, AdminUser adminUser,
113         Map<String, Object> model, Class<A> pluginActionClass, String strMark )
114     {
115         for ( A action : SpringContextService.getBeansOfType( pluginActionClass ) )
116         {
117             action.fillModel( request, adminUser, model );
118         }
119 
120         // add the action list
121         model.put( strMark, getListPluginAction( pluginActionClass ) );
122     }
123 }