updated coding rules.
[utils] / security / src / main / java / org / wamblee / usermgt / User.java
index f239c141b6d6f56201b694c033b1fb65275ca21e..0a69cef9b27cd21cf3b72aa3d17f2ed056b09168 100644 (file)
@@ -35,27 +35,27 @@ public class User extends AbstractPersistent implements Serializable, Comparable
     /**
      * User name. 
      */
-    private String _name;
+    private String name;
 
     /**
      * Password. 
      */
-    private String _password;
+    private String password;
 
     /**
      * Groups the user belongs to. 
      */
-    private Set<Group> _groups;
+    private Set<Group> groups;
     
     /**
      * Password validator. 
      */
-    private NameValidator _passwordValidator; 
+    private NameValidator passwordValidator; 
 
     /**
      * Password encoder. 
      */
-    private MessageDigester _passwordEncoder;
+    private MessageDigester passwordEncoder;
     
     /**
      * Constructs the user. 
@@ -66,34 +66,34 @@ public class User extends AbstractPersistent implements Serializable, Comparable
     User(String aName, String aPassword, Group aGroup, NameValidator aPasswordValidator, 
             MessageDigester aPasswordEncoder) throws UserMgtException {
         super(); 
-        _name = aName;
+        name = aName;
         aPasswordValidator.validate(aPassword);
-        _password = aPasswordEncoder.hash(aPassword);
-        _groups = new TreeSet<Group>(); 
-        _groups.add(aGroup);
-        _passwordValidator = aPasswordValidator;
-        _passwordEncoder = aPasswordEncoder;
+        password = aPasswordEncoder.hash(aPassword);
+        groups = new TreeSet<Group>(); 
+        groups.add(aGroup);
+        passwordValidator = aPasswordValidator;
+        passwordEncoder = aPasswordEncoder;
     }
     
     public User(User aUser) { 
         super(aUser); 
-        _name = aUser._name;
-        _password = aUser._password;
-        _groups = new TreeSet<Group>(); 
-        for (Group group: aUser._groups) {
-            _groups.add(new Group(group)); 
+        name = aUser.name;
+        password = aUser.password;
+        groups = new TreeSet<Group>(); 
+        for (Group group: aUser.groups) {
+            groups.add(new Group(group)); 
         }
-        _passwordValidator = aUser._passwordValidator; 
-        _passwordEncoder = aUser._passwordEncoder;
+        passwordValidator = aUser.passwordValidator; 
+        passwordEncoder = aUser.passwordEncoder;
     }
     
     User() { 
         super(); 
-        _name = null; 
-        _password = null; 
-        _groups = null; 
-        _passwordValidator = null; 
-        _passwordEncoder = null;
+        name = null; 
+        password = null; 
+        groups = null; 
+        passwordValidator = null; 
+        passwordEncoder = null;
     }
     
     /**
@@ -101,7 +101,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @param aPasswordValidator Validator. 
      */
     public void setPasswordValidator(NameValidator aPasswordValidator) { 
-        _passwordValidator = aPasswordValidator;
+        passwordValidator = aPasswordValidator;
     }
     
     /**
@@ -109,14 +109,14 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @param aPasswordEncoder Encoder. 
      */
     public void setPasswordEncoder(MessageDigester aPasswordEncoder) { 
-        _passwordEncoder = aPasswordEncoder; 
+        passwordEncoder = aPasswordEncoder; 
     }
 
     /**
-     * @return Returns the _password.
+     * @return Returns the password.
      */
     String getPassword() {
-        return _password;
+        return password;
     }
     
     /**
@@ -125,8 +125,8 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @throws UserMgtException In case the password is incorrect. 
      */
     public void checkPassword(String aPassword) throws UserMgtException {
-        String encoded = _passwordEncoder.hash(aPassword);
-        if ( !_password.equals(encoded) ) { 
+        String encoded = passwordEncoder.hash(aPassword);
+        if ( !password.equals(encoded) ) { 
             throw new UserMgtException(Reason.INVALID_PASSWORD, this);
         }
     }
@@ -139,7 +139,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      */
     public void changePassword(String aOldPassword, String aNewPassword) throws UserMgtException {
         checkPassword(aOldPassword);
-        _passwordValidator.validate(aNewPassword);
+        passwordValidator.validate(aNewPassword);
         setPassword(aNewPassword);
     }
 
@@ -148,8 +148,8 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      *            The password to set.
      */
     public void setPassword(String aPassword) throws UserMgtException {
-        _passwordValidator.validate(aPassword);
-        _password = _passwordEncoder.hash(aPassword);
+        passwordValidator.validate(aPassword);
+        password = passwordEncoder.hash(aPassword);
     }
     
     /**
@@ -157,7 +157,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @return Password. 
      */
     protected String getPasswordString() { 
-        return _password;
+        return password;
     }
     
     /**
@@ -165,14 +165,14 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @param aPassword Password. 
      */
     protected void setPasswordString(String aPassword) { 
-        _password = aPassword; 
+        password = aPassword; 
     }
 
     /**
      * @return Returns the _user.
      */
     public String getName() {
-        return _name;
+        return name;
     }
 
     /**
@@ -180,7 +180,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      *            The username to set.
      */
     void setName(String aName) {
-        _name = aName;
+        name = aName;
     }
 
     /**
@@ -189,7 +189,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      */
     public Set<Group> getGroups() {
         Set<Group> result = new TreeSet<Group>(); 
-        result.addAll(_groups);
+        result.addAll(groups);
         return result; 
     }
     
@@ -199,7 +199,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @return True if the user belongs to the group.
      */
     public boolean isInGroup(Group aGroup) {
-        return _groups.contains(aGroup);
+        return groups.contains(aGroup);
     }
     
     /**
@@ -208,7 +208,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @return True if the user belongs to the group.
      */
     public boolean isInGroup(String aGroup) {
-        return _groups.contains(new Group(aGroup));
+        return groups.contains(new Group(aGroup));
     }
     
     /**
@@ -216,7 +216,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @return set of groups. 
      */
     Set<Group> getGroupSet() { 
-        return _groups;
+        return groups;
     }
 
     /**
@@ -224,7 +224,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @param aGroups Groups.
      */
     void setGroupSet(Set<Group> aGroups) {
-        _groups = aGroups;
+        groups = aGroups;
     }
 
     /**
@@ -233,10 +233,10 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @throws UserMgtException In case the user already belongs to the group.  
      */
     void addGroup(Group aGroup) throws UserMgtException {
-        if (_groups.contains(aGroup)) {
+        if (groups.contains(aGroup)) {
             throw new UserMgtException(Reason.USER_ALREADY_IN_GROUP, aGroup);
         }
-        _groups.add(aGroup);
+        groups.add(aGroup);
     }
 
     /**
@@ -245,13 +245,13 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @throws UserMgtException In case the user does not belong to the group.
      */
     void removeGroup(Group aGroup) throws UserMgtException {
-        if (!_groups.contains(aGroup)) {
+        if (!groups.contains(aGroup)) {
             throw new UserMgtException(Reason.USER_NOT_IN_GROUP, this, aGroup);
         }
-        if ( _groups.size() == 1 ) { 
+        if ( groups.size() == 1 ) { 
             throw new UserMgtException(Reason.USER_MUST_BE_IN_A_GROUP, this, aGroup); 
         }
-        _groups.remove(aGroup);
+        groups.remove(aGroup);
     }
     
     /* (non-Javadoc)
@@ -263,7 +263,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
             return false; 
         }
         User user = (User)aUser; 
-        return _name.equals(user._name);
+        return name.equals(user.name);
     }
     
     /* (non-Javadoc)
@@ -271,7 +271,7 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      */
     @Override
     public int hashCode() {
-        return _name.hashCode(); 
+        return name.hashCode(); 
     }
     
     /* (non-Javadoc)
@@ -279,8 +279,8 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      */
     @Override
     public String toString() {
-        String result = "User(name=" + _name + ", password=" + _password;
-        for (Group group: _groups) { 
+        String result = "User(name=" + name + ", password=" + password;
+        for (Group group: groups) { 
             result += ", group=" + group; 
         }
         return result + ")"; 
@@ -290,6 +290,6 @@ public class User extends AbstractPersistent implements Serializable, Comparable
      * @see java.lang.Comparable#compareTo(T)
      */
     public int compareTo(Object aUser) {
-        return _name.compareTo(((User)aUser)._name);
+        return name.compareTo(((User)aUser).name);
     }
 }