784f7f103efb86db8fe5d3bbca4afdddf04ac08e
[utils] / security / src / main / java / org / wamblee / usermgt / AbstractUserSet.java
1 /*
2  * Copyright 2005 the original author or authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.usermgt;
17
18 import org.wamblee.security.encryption.MessageDigester;
19 import static org.wamblee.usermgt.UserMgtException.Reason.DUPLICATE_USER;
20
21 /**
22  * User set base class.
23  */
24 public abstract class AbstractUserSet implements UserSet {
25     /**
26      * Password validator.
27      */
28     private NameValidator passwordValidator;
29
30     /**
31      * Password encoder.
32      */
33     private MessageDigester passwordEncoder;
34
35 /**
36      * Creates a new AbstractUserSet object.
37      *
38      * @param aPasswordValidator DOCUMENT ME!
39      * @param aPasswordEncoder DOCUMENT ME!
40      */
41     protected AbstractUserSet(NameValidator aPasswordValidator,
42         MessageDigester aPasswordEncoder) {
43         passwordValidator     = aPasswordValidator;
44         passwordEncoder       = aPasswordEncoder;
45     }
46
47     /**
48      * Sets the password validtor and encoder in the user.
49      *
50      * @param aUser User.
51      */
52     protected void setPasswordInfo(User aUser) {
53         aUser.setPasswordValidator(passwordValidator);
54         aUser.setPasswordEncoder(passwordEncoder);
55     }
56
57     /* (non-Javadoc)
58      * @see org.wamblee.usermgt.UserSet#createUser(java.lang.String, java.lang.String, org.wamblee.usermgt.Group)
59      */
60     /**
61      * DOCUMENT ME!
62      *
63      * @param aUsername DOCUMENT ME!
64      * @param aPassword DOCUMENT ME!
65      * @param aGroup DOCUMENT ME!
66      *
67      * @return DOCUMENT ME!
68      *
69      * @throws UserMgtException DOCUMENT ME!
70      */
71     public User createUser(String aUsername, String aPassword, Group aGroup)
72         throws UserMgtException {
73         User user = new User(aUsername, aPassword, aGroup, passwordValidator,
74                 passwordEncoder);
75
76         if (contains(user)) {
77             throw new UserMgtException(DUPLICATE_USER, user);
78         }
79
80         add(user);
81
82         return user;
83     }
84 }