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.accesscontrol;
35
36 import java.util.Locale;
37
38 import javax.servlet.http.HttpServletRequest;
39
40 import fr.paris.lutece.api.user.User;
41 import fr.paris.lutece.portal.business.accesscontrol.AccessControlSessionData;
42 import fr.paris.lutece.portal.web.xpages.XPage;
43 import fr.paris.lutece.util.ReferenceList;
44
45 /**
46 * Provide for access control
47 */
48 public interface IAccessControlServiceProvider
49 {
50
51 /**
52 * return a referencelist which contains a list enabled AccessControl.
53 *
54 * @param user
55 * the User
56 * @param locale
57 * the locale
58 * @return a referencelist which contains a list enabled AccessControl
59 */
60 ReferenceList getAccessControlsEnabled( User user, Locale locale );
61
62 /**
63 * Find the access control used by a resource.
64 *
65 * @param idResource
66 * @param resourceType
67 * @return the id of the access control, -1 if none
68 */
69 int findAccessControlForResource( int idResource, String resourceType );
70
71 /**
72 * Create or update an AccessControlResource mapping
73 *
74 * @param idResource
75 * @param resourceType
76 * @param idAccessControl
77 */
78 void createOrUpdateAccessControlResource( int idResource, String resourceType, int idAccessControl );
79
80 /**
81 * Redirect to the accessControl XPage
82 *
83 * @param idAccessControl
84 * @return
85 */
86 XPage redirectToAccessControlXPage( HttpServletRequest request, int idResource, String resourceType, int idAccessControl );
87
88 /**
89 * Get the {@link AccessControlSessionData} associated to the resource.
90 *
91 * @param request
92 * @param idResource
93 * @param resourceType
94 * @return
95 */
96 AccessControlSessionData getSessionDataForResource( HttpServletRequest request, int idResource, String resourceType );
97
98 /**
99 * Delete the {@link AccessControlSessionData} associated to the resource.
100 *
101 * @param request
102 * @param idResource
103 * @param resourceType
104 */
105 void deleteSessionDataForResource( HttpServletRequest request, int idResource, String resourceType );
106
107 /**
108 * Apply the session data to the destination object
109 * @param sessionData
110 * @param destination
111 */
112 void applyPersistentData( AccessControlSessionData sessionData, Object destination );
113 }