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.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39
40
41 /**
42 *
43 * @author Etienne
44 */
45 public interface ILdapUserDAO
46 {
47 /**
48 * Generates a new primary key
49 * @param plugin The Plugin using this data access service
50 * @return The new primary key
51 */
52 int newPrimaryKey( Plugin plugin );
53
54 /**
55 * Insert a new record in the table.
56 *
57 * @param ldapUser The ldapUser object
58 * @param plugin The Plugin using this data access service
59 */
60 void insert( LdapUser ldapUser, Plugin plugin );
61
62 /**
63 * Load the data of LdapUser from the table
64 *
65 * @param nLdapUserId The identifier of ldapUser
66 * @param plugin The Plugin using this data access service
67 * @return the instance of the LdapUser
68 */
69 LdapUser load( int nLdapUserId, Plugin plugin );
70
71 /**
72 * Delete a record from the table
73 * @param ldapUser The ldapUser object
74 * @param plugin The Plugin using this data access service
75 */
76 void delete( LdapUser ldapUser, Plugin plugin );
77
78 /**
79 * Update the record in the table
80 * @param ldapUser The reference of ldapUser
81 * @param plugin The Plugin using this data access service
82 */
83 void store( LdapUser ldapUser, Plugin plugin );
84
85 /**
86 * Load the list of ldapUsers
87 * @param plugin The Plugin using this data access service
88 * @return The Collection of the ldapUsers
89 */
90 Collection<LdapUser> selectLdapUserList( Plugin plugin );
91
92 /**
93 * Load the list of ldapUsers for a guid
94 * @param strLdapGuid The ldap guid of ldapUser
95 * @param plugin The Plugin using this data access service
96 * @return The Collection of the ldapUsers
97 */
98 Collection<LdapUser> selectLdapUserListForGuid( String strLdapGuid, Plugin plugin );
99 }