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.service;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceItem;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.sql.Timestamp;
41
42 import java.util.List;
43
44 /**
45 * User parameter service interface
46 *
47 */
48 public interface IUserParameterService
49 {
50 /**
51 * Get the parameter from a given key
52 *
53 * @param strParameterKey
54 * the key
55 * @param plugin
56 * the plugin
57 * @return the parameter
58 */
59 ReferenceItem findByKey( String strParameterKey, Plugin plugin );
60
61 /**
62 * Find all parameters
63 *
64 * @param plugin
65 * the plugin
66 * @return a ReferenceList
67 */
68 ReferenceList findAll( Plugin plugin );
69
70 /**
71 * Update a parameter
72 *
73 * @param userParam
74 * the parameter
75 * @param plugin
76 * the plugin
77 */
78 void update( ReferenceItem userParam, Plugin plugin );
79
80 /**
81 * Check if the passwords must be encrypted or not
82 *
83 * @param plugin
84 * the plugin
85 * @return true if they are encrypted, false otherwise
86 */
87 boolean isPasswordEncrypted( Plugin plugin );
88
89 /**
90 * Get the encryption algorithm
91 *
92 * @param plugin
93 * the plugin
94 * @return the encryption algorithm
95 */
96 String getEncryptionAlgorithm( Plugin plugin );
97
98 /**
99 * Get the number of password change done by a user since the given date.
100 *
101 * @param minDate
102 * Minimum date to consider.
103 * @param nUserId
104 * Id of the user
105 * @param plugin
106 * the plugin
107 * @return The number of password change done by the user since the given date.
108 */
109 int countUserPasswordHistoryFromDate( Timestamp minDate, int nUserId, Plugin plugin );
110
111 /**
112 * Gets the history of password of the given user
113 *
114 * @param nUserId
115 * Id of the user
116 * @param plugin
117 * the plugin
118 * @return The collection of recent passwords used by the user.
119 */
120 List<String> selectUserPasswordHistory( int nUserId, Plugin plugin );
121 }