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.plugins.accesscontrol.service;
35
36 import java.util.List;
37 import java.util.Locale;
38
39 import fr.paris.lutece.api.user.User;
40 import fr.paris.lutece.plugins.accesscontrol.business.AccessControl;
41 import fr.paris.lutece.plugins.accesscontrol.business.AccessControlFilter;
42 import fr.paris.lutece.portal.business.accesscontrol.AccessControlSessionData;
43 import fr.paris.lutece.util.ReferenceList;
44
45 public interface IAccessControlService
46 {
47
48 /**
49 * create a {@link ReferenceList} containing available {@link IAccessControllerType}
50 *
51 * @param locale
52 * @return
53 */
54 ReferenceList createAccessControllerReferenceList( Locale locale );
55
56 /**
57 * Delete the AccessController
58 *
59 * @param idControlType
60 */
61 void deleteAccessController( int idControlType );
62
63 /**
64 * return a referencelist which contains a list enabled AccessControl.
65 *
66 * @param user
67 * the User
68 * @param locale
69 * the locale
70 * @return a referencelist which contains a list enabled AccessControl
71 */
72 ReferenceList getAccessControlsEnabled( User user, Locale locale );
73
74 /**
75 * return the AccessControl list by filter
76 *
77 * @param filter
78 * the filter
79 * @return the AccessControl list
80 */
81 List<AccessControl> getListAccessControlsByFilter( AccessControlFilter filter );
82
83 /**
84 * Apply the session data to the destination object
85 *
86 * @param sessionData
87 * @param destination
88 */
89 void applyPersistentData( AccessControlSessionData sessionData, Object destination );
90 }