Minor JavaDocs Updates

CircleCI integration

Signed-off-by: Joshua Gager <jlgager@jgcomptech.com>

Author: jlgager24

.circleci/config.yml

@@ -0,0 +1,42 @@
+# Java Maven CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-java/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+    # specify the version you desire here
+    - image: circleci/openjdk:10-jdk
+
+    # Specify service dependencies here if necessary
+    # CircleCI maintains a library of pre-built images
+    # documented at https://circleci.com/docs/2.0/circleci-images/
+    # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    environment:
+      # Customize the JVM maximum heap limit
+      MAVEN_OPTS: -Xmx3200m
+
+    steps:
+    - checkout
+
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+        - v1-dependencies-{{ checksum "pom.xml" }}
+        # fallback to using the latest cache if no exact match is found
+        - v1-dependencies-
+
+    - run: mvn dependency:go-offline
+
+    - save_cache:
+        paths:
+        - ~/.m2
+        key: v1-dependencies-{{ checksum "pom.xml" }}
+
+    # run tests!
+    - run: mvn integration-test
+

src/main/java/com/jgcomptech/tools/authc/AuthManager.java

@@ -15,6 +15,8 @@
 import java.util.HashSet;
 import java.util.Map;
 
+//TODO Create resetInstance() method to allow a new instance to be initialized.
+
 /**
  * Manages all tasks related to a user account including sessions and user roles.
  * @since 1.5.0
@@ -84,7 +86,7 @@ public static AuthManager getNewInstance(final Database db, final String appIcon
 
     //region User Manager Methods
     /**
-     * Creates a new user in the database using SHA-512 password hashing.
+     * Creates a new user in the database using BCrypt password hashing.
      * @param username the username to add
      * @param password the password for the new user
      * @param userRole the system user role for the new user
@@ -101,7 +103,7 @@ public boolean createUser(final String username,
     }
 
     /**
-     * Creates a new user in the database using SHA-512 password hashing.
+     * Creates a new user in the database using BCrypt password hashing.
      * @param username the username to add
      * @param password the password for the new user
      * @param userRole the name of the user role for the new user
@@ -169,6 +171,7 @@ public String getUserCreationDate(final String username, final String format) {
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if an error occurs during lookup
      */
+    //TODO create UserManager implementation to reduce database activity
     public boolean isUserLocked(final String username) { return getUser(username).isLocked(); }
 
     /**
@@ -212,6 +215,7 @@ private boolean setLocked(final String username, final boolean status) {
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if an error occurs during lookup
      */
+    //TODO create UserManager implementation to reduce database activity
     public boolean isPasswordExpired(final String username) { return getUser(username).isPasswordExpired(); }
 
     /**
@@ -222,6 +226,7 @@ private boolean setLocked(final String username, final boolean status) {
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if an error occurs during lookup
      */
+    //TODO create UserManager implementation to reduce database activity
     public boolean isPasswordSetToExpire(final String username) { return getUser(username).hasPasswordExpiration(); }
 
     /**
@@ -232,6 +237,7 @@ private boolean setLocked(final String username, final boolean status) {
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if an error occurs during lookup
      */
+    //TODO create UserManager implementation to reduce database activity
     public LocalDateTime getPasswordExpirationDate(final String username) {
         return getUser(username).getPasswordExpirationDate();
     }
@@ -245,6 +251,7 @@ public LocalDateTime getPasswordExpirationDate(final String username) {
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if an error occurs during lookup
      */
+    //TODO create UserManager implementation to reduce database activity
     public String getPasswordExpirationDate(final String username, final String format) {
         if(format == null || format.trim().isEmpty()) {
             throw new IllegalArgumentException("Format Cannot Be Null Or Empty!");
@@ -304,7 +311,7 @@ public boolean disablePasswordExpiration(final String username) {
      * @return true if no errors occurred
      * @throws IllegalArgumentException if values are null or empty
      * @throws TableNotFoundException if users table is missing
-     * @throws UserManagerException if an error occurs while changing user type
+     * @throws UserManagerException if an error occurs while changing user role
      */
     public boolean setUserRole(final String username,
                                final UserRoleManager.SystemUserRoles userRole) {
@@ -318,14 +325,14 @@ public boolean setUserRole(final String username,
      * @return true if no errors occurred
      * @throws IllegalArgumentException if values are null or empty
      * @throws TableNotFoundException if users table is missing
-     * @throws UserManagerException if an error occurs while changing user type
+     * @throws UserManagerException if an error occurs while changing user role
      */
     public boolean setUserRole(final String username, final String userRole) {
         return userManager.setUserRole(username, userRole);
     }
 
     /**
-     * Sets a new password for an existing user using SHA-512 password hashing.
+     * Sets a new password for an existing user using BCrypt password hashing.
      * @param username the username to change
      * @param password the new password
      * @return true if password is changed successfully
@@ -361,8 +368,8 @@ public boolean checkPasswordMatches(final String username, final String password
     public HashSet<UserAccount> getUsersList() { return userManager.getUsersList(); }
 
     /**
-     * Returns a list of the user names in the database.
-     * @return a list of the user names in the database
+     * Returns a list of the usernames in the database.
+     * @return a list of the usernames in the database
      * @throws TableNotFoundException if users table is missing
      */
     public HashSet<String> getUsernameList() { return userManager.getUsernameList(); }

src/main/java/com/jgcomptech/tools/authc/SessionManager.java

@@ -657,6 +657,7 @@ public boolean loginUser(final String username)
      * @throws LockedAccountException if the user account is locked
      * @since 1.5.0
      */
+    //TODO create a method for multi-user context that accepts a UsernameLoginToken
     public boolean loginUser(final String username, final boolean multiSession)
             throws IllegalStateException, ExpiredCredentialsException, LockedAccountException {
         if(username == null || username.trim().isEmpty()) {

src/main/java/com/jgcomptech/tools/authc/Subject.java

@@ -210,7 +210,7 @@ public Session getSession(final boolean multiSession) {
     public String getUsername() { return username; }
 
     /**
-     * Sets a new password for the user using SHA-512 password hashing.
+     * Sets a new password for the user using BCrypt password hashing.
      * @param password the new password
      * @return true if password is changed successfully
      */
@@ -224,7 +224,7 @@ public boolean setPassword(final String password) {
 
     /**
      * Returns the user role of the currently assigned username.
-     * @return the user type of the currently assigned username
+     * @return the user role of the currently assigned username
      */
     public UserRole getUserRole() {
         assertNotAnonymous();

src/main/java/com/jgcomptech/tools/authc/UserManager.java

@@ -71,6 +71,7 @@ public UserManager(final Database db, final String appIconPath, final String pro
         try {
             if(!db.getInfo().tableExists(TABLE_NAME)) {
                 //The password field is 150 chars in length due to the length of a SHA-512 hash
+                //TODO check if 150 chars is too excessive since changing to BCrypt
                 TypedStatement.newTable()
                         .CREATE(TABLE_NAME, db)
                         .addColumn(new ColumnBuilder(ID_FIELD, DataTypes.INTEGER).notNull().primaryKey().autoIncrement())
@@ -93,7 +94,7 @@ public UserManager(final Database db, final String appIconPath, final String pro
     }
 
     /**
-     * Creates a new user in the database using SHA-512 password hashing.
+     * Creates a new user in the database using BCrypt password hashing.
      * @param username the username to add
      * @param password the password for the new user
      * @param userRole the system user role for the new user
@@ -119,7 +120,7 @@ public boolean createUser(final String username,
     }
 
     /**
-     * Creates a new user in the database using SHA-512 password hashing.
+     * Creates a new user in the database using BCrypt password hashing.
      * @param username the username to add
      * @param password the password for the new user
      * @param userRole the name of the user role for the new user
@@ -248,9 +249,9 @@ public boolean userExists(final String username) {
     }
 
     /**
-     * Returns userType for the specified username.
+     * Returns user role for the specified username.
      * @param username the username to lookup
-     * @return the userType
+     * @return the user role
      * @throws IllegalArgumentException if username is null or empty or if username does not exist
      * @throws TableNotFoundException if users table is missing
      * @throws UserManagerException if error occurs during lookup
@@ -278,13 +279,13 @@ public UserRole getUserRole(final String username) {
     }
 
     /**
-     * Sets the user type of the specified user.
+     * Sets the user role of the specified user.
      * @param username the username of the user to update
      * @param userRole the system user role to change to
      * @return true if no errors occurred
      * @throws IllegalArgumentException if values are null or empty
      * @throws TableNotFoundException if users table is missing
-     * @throws UserManagerException if an error occurs while changing user type
+     * @throws UserManagerException if an error occurs while changing user role
      */
     public boolean setUserRole(final String username,
                                final UserRoleManager.SystemUserRoles userRole) {
@@ -298,13 +299,13 @@ public boolean setUserRole(final String username,
     }
 
     /**
-     * Sets the user type of the specified user.
+     * Sets the user role of the specified user.
      * @param username the username of the user to update
      * @param userRole the name of the user role to change to
      * @return true if no errors occurred
      * @throws IllegalArgumentException if values are null or empty
      * @throws TableNotFoundException if users table is missing
-     * @throws UserManagerException if an error occurs while changing user type
+     * @throws UserManagerException if an error occurs while changing user role
      */
     public boolean setUserRole(final String username, final String userRole) {
         if(username == null || username.trim().isEmpty()) {
@@ -327,7 +328,7 @@ public boolean setUserRole(final String username, final String userRole) {
     }
 
     /**
-     * Sets a new password for an existing user using SHA-512 password hashing.
+     * Sets a new password for an existing user using BCrypt password hashing.
      * @param username the username to change
      * @param password the new password
      * @return true if password is changed successfully

src/main/java/com/jgcomptech/tools/authz/PermissionManager.java

@@ -439,13 +439,13 @@ public void loadPermissions(final boolean enableAll) {
     }
 
     /**
-     * Sets the correct permissions according to the specified user type.
+     * Sets the correct permissions according to the specified user role.
      * @param userRole the user role to use to set permissions
      */
     public void loadPermissions(final UserRoleManager.SystemUserRoles userRole) { loadPermissions(userRole.getRole()); }
 
     /**
-     * Sets the correct permissions according to the specified user type.
+     * Sets the correct permissions according to the specified user role.
      * @param userRole the user role to use to set permissions
      * @since 1.5.0 now uses a parallel stream allowing a large list of permissions
      */