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.admin.AccessDeniedException;
38
39 import java.util.Map;
40
41 import javax.servlet.http.HttpServletRequest;
42 import javax.servlet.http.HttpServletResponse;
43
44
45 /**
46 * A plugin Action. <br>
47 * The action should rely on a service instead of implementing the business rules itself if possible.
48 * <ul>
49 * <li>{@link #fillModel(HttpServletRequest, AdminUser, Map)} is called by the JspBean to add additionnal data in the main model
50 * <li>{@link #getButtonTemplate()} is used to display buttons.
51 * <li>{@link #isInvoked(HttpServletRequest)} is used by a JspBean to detect the invoked action.
52 * <li>{@link #process(HttpServletRequest, HttpServletResponse, AdminUser, IPluginActionFields)} is called by the JspBean to process the invoked action.
53 * The {@link IPluginActionResult} may contain html content or a redirect url or a noop as a result of the action processing.
54 * <li>{@link #getName()} is mainly for debbuging purpose
55 * </ul>
56 * @param <FieldsDTO> the dto used by the process method, might be session variables or any useful data for the action processing.
57 */
58 public interface IPluginAction<FieldsDTO>
59 {
60 /**
61 * Returns <code>true</code> if the action is invoked, <code>false</code> otherwise. <br>
62 * Uses one or several button names to detect if the action is called or note.
63 * @param request the request
64 * @return <code>true</code> if the action is invoked, <code>false</code> otherwise.
65 */
66 boolean isInvoked( HttpServletRequest request );
67
68 /**
69 * Processes the request
70 * @param request the request
71 * @param response the response
72 * @param adminUser the user
73 * @param sessionFields the session fields
74 * @return the action result
75 * @throws AccessDeniedException if the user can't access the feature
76 */
77 IPluginActionResult process( HttpServletRequest request, HttpServletResponse response, AdminUser adminUser,
78 FieldsDTO sessionFields ) throws AccessDeniedException;
79
80 /**
81 * Fills the model to provide necessary data to fill the button template
82 * @param request the request
83 * @param adminUser the admin user to filter features
84 * @param model the model
85 */
86 void fillModel( HttpServletRequest request, AdminUser adminUser, Map<String, Object> model );
87
88 /**
89 * Gets the template to display the action (typically a button - but also check box, select...)
90 * Return an empty string if no display is needed (for default directory actions : create, search...)
91 * @return the template
92 */
93 String getButtonTemplate( );
94
95 /**
96 * The action name
97 * @return the name
98 */
99 String getName( );
100 }