1 /*
2 * Copyright (c) 2002-2021, 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.mylutece.modules.database.authentication.business.key;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 /**
39 *
40 * IDatabaseUserKey
41 *
42 */
43 public interface IDatabaseUserKeyDAO
44 {
45 /**
46 * Load an instance of {@link DatabaseUserKey}
47 *
48 * @param strKey
49 * the key
50 * @param plugin
51 * the plugin
52 * @return an instance of {@link DatabaseUserKey}
53 */
54 DatabaseUserKey load( String strKey, Plugin plugin );
55
56 /**
57 * Insert a new {@link DatabaseUserKey}
58 *
59 * @param userKey
60 * the {@link DatabaseUserKey}
61 * @param plugin
62 * the plugin
63 */
64 void insert( DatabaseUserKey userKey, Plugin plugin );
65
66 /**
67 * Delete a {@link DatabaseUserKey}
68 *
69 * @param strKey
70 * the key
71 * @param plugin
72 * the plugin
73 */
74 void delete( String strKey, Plugin plugin );
75
76 /**
77 * Delete by id user
78 *
79 * @param nUserId
80 * the id user
81 * @param plugin
82 * the plugin
83 */
84 void deleteByIdUser( int nUserId, Plugin plugin );
85
86 /**
87 * Find a key from a given login
88 *
89 * @param login
90 * the user's login
91 * @param plugin
92 * the plugin
93 * @return a {@link DatabaseUserKey}
94 */
95 DatabaseUserKey selectKeyByLogin( String login, Plugin plugin );
96 }