Removed DOCUMENT ME comments that were generated and applied source code
[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      */
39     protected AbstractUserSet(NameValidator aPasswordValidator,
40         MessageDigester aPasswordEncoder) {
41         passwordValidator = aPasswordValidator;
42         passwordEncoder = aPasswordEncoder;
43     }
44
45     /**
46      * Sets the password validtor and encoder in the user.
47      * 
48      * @param aUser
49      *            User.
50      */
51     protected void setPasswordInfo(User aUser) {
52         aUser.setPasswordValidator(passwordValidator);
53         aUser.setPasswordEncoder(passwordEncoder);
54     }
55
56     /*
57      * (non-Javadoc)
58      * 
59      * @see org.wamblee.usermgt.UserSet#createUser(java.lang.String,
60      * java.lang.String, org.wamblee.usermgt.Group)
61      */
62     public User createUser(String aUsername, String aPassword, Group aGroup)
63         throws UserMgtException {
64         User user = new User(aUsername, aPassword, aGroup, passwordValidator,
65             passwordEncoder);
66
67         if (contains(user)) {
68             throw new UserMgtException(DUPLICATE_USER, user);
69         }
70
71         add(user);
72
73         return user;
74     }
75 }