1 /*
2 * Copyright (c) 2002-2017, 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.plugins.mylutece.modules.ldapdatabase.authentication.business;
35
36 import fr.paris.lutece.plugins.mylutece.modules.ldapdatabase.authentication.LDAPDatabaseUser;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.portal.service.security.LuteceAuthentication;
39
40 import java.util.ArrayList;
41 import java.util.Collection;
42
43
44 /**
45 *
46 * @author Etienne
47 */
48 public interface ILdapDatabaseDAO
49 {
50 /**
51 * Find users by guid
52 *
53 * @param strLdapGuid the Ldap guid
54 * @param plugin The Plugin using this data access service
55 * @param authenticationService the LuteceAuthentication object
56 * @return LdapDatabaseUser the user corresponding to the guid
57 */
58 LDAPDatabaseUser selectLuteceUserByGuid( String strLdapGuid, Plugin plugin,
59 LuteceAuthentication authenticationService );
60
61 /**
62 * Find user's roles by guid
63 *
64 * @param strGuid the Ldap guid
65 * @param plugin The Plugin using this data access service
66 * @return ArrayList the roles key list corresponding to the guid
67 */
68 ArrayList<String> selectUserRolesFromGuid( String strGuid, Plugin plugin );
69
70 /**
71 * Find user's guid by role key
72 *
73 * @param strRoleKey the Lutece Role Key
74 * @param plugin The Plugin using this data access service
75 * @return ArrayList the guid key list corresponding to the role
76 */
77 ArrayList<String> selectUserGuidFromRole( String strRoleKey, Plugin plugin );
78
79 /**
80 * Delete roles for a user
81 * @param nIdUser The id of the user
82 * @param plugin The Plugin using this data access service
83 */
84 void deleteRolesForUser( int nIdUser, Plugin plugin );
85
86 /**
87 * Assign a role to user
88 * @param nIdUser The id of the user
89 * @param strRoleKey The key of the role
90 * @param plugin The Plugin using this data access service
91 */
92 void createRoleForUser( int nIdUser, String strRoleKey, Plugin plugin );
93
94 /**
95 * Load the list of LDAPDatabaseUser
96 * @param plugin The Plugin using this data access service
97 * @param authenticationService the LuteceAuthentication object
98 * @return The Collection of the LDAPDatabaseUser
99 */
100 Collection<LDAPDatabaseUser> selectUserList( Plugin plugin, LuteceAuthentication authenticationService );
101 }