+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/AuthSystem/AuthManager.md b/docs/AuthSystem/AuthManager.md
deleted file mode 100644
index 47afbcc..0000000
--- a/docs/AuthSystem/AuthManager.md
+++ /dev/null
@@ -1,872 +0,0 @@
-#Auth Manager
-
-##Introduction
-Package Name: [com.jgcomptech.tools.authc.AuthManager](https://static.javadoc.io/com.jgcomptech.tools/java-ultimate-tools/1.5.0/com/jgcomptech/tools/authc/AuthManager.html)
-
-The Auth Manager class contains all methods needed for controlling the Auth System.
-This includes methods to manage user accounts, login sessions, user roles and user permissions.
-
-##Setup
-The Auth Manager is a singleton class but a new instance still needs to be initialized upon first use.
-When a new instance is created a "users" table is automatically created in the specified database.
-The following code can be used to create a new instance:
-``` java
-try(final var db = new Database("./mydb.db", DatabaseType.H2)) {
- final var manager = AuthManager.getNewInstance(db);
-}
-```
-
-After the new instance has been created you can use the following to retrieve the instance again:
-``` java
-try(final var db = new Database("./mydb.db", DatabaseType.H2)) {
- final var manager = AuthManager.getInstance();
-}
-```
-
-An icon path and program name may also be optionally provided as parameters to change the
-icon and program name for all login dialogs.
-
-##User Account Methods
-
-###Create A New User (createUser)
-To create a new user use the createUser method supplying the following parameters:
-
-- Username - The username of the new account
-- Password - The password of the new account
-- User Role - The user role of the new account
-
-The user role can be a text string or one of the
-items from the UserRoleManager.SystemUserRoles enum.
-
-The UserRoleManager.SystemUserRoles list contains:
-
-- ADMIN
-- AUTHOR
-- EDITOR
-- BASIC
-- NONE
-
-!!! note
- The NONE user role can never have permissions assigned to it.
- Using the NONE user role is a quick way to remove all permissions from a user.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- authManager.createUser("admin", "1234", UserRoleManager.SystemUserRoles.ADMIN);
- authManager.createUser("editor", "1234", UserRoleManager.SystemUserRoles.EDITOR);
- ```
-
-###Delete An Existing User (deleteUser)
-To delete an existing user use the deleteUser method supplying the following parameter:
-
-- Username - The username of the account to delete
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- authManager.deleteUser("admin");
- ```
-
-###Get Username Object (getUser)
-Retrieves a readonly immutable UserAccount object.
-To retrieve the object supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final UserAccount user = authManager.getUser("admin");
- ```
-
-###Check If User Exists (userExists)
-Checks to see if the specified user account exists.
-To check a user account, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.userExists("admin");
- if(result) MessageBox.show("Admin User Exists!");
- else MessageBox.show("Admin User Does Not Exist!");
- ```
-
-###Get Account Creation Date (getUserCreationDate)
-Returns the date and time the user was initially created.
-
-There is two methods to retrieving the user creation date.
-The date can either be returned as a LocalDateTime object or as a formatted string.
-
-####LocalDateTime Object
-To retrieve the user creation date, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");
- final LocalDateTime result = authManager.getUserCreationDate("admin");
- MessageBox.show("Account Was Created On " + result.format(formatter));
- ```
-
-####Formatted String Object
-To retrieve the user creation date, supply the following parameters:
-
-- Username - The username of the account to lookup
-- Format - The string that represents the format to return the date
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final String result = authManager.getUserCreationDate("admin", "yyyy-MM-dd HH:mm");
- MessageBox.show("Account Was Created On " + result);
- ```
-
-###Get User Role (getUserRole)
-Retrieves the UserRole object assigned to the specified user.
-To retrieve the object, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final UserRole userRole = authManager.getUserRole("admin");
- ```
-
-###Set User Role (getUserRole)
-Sets the user role assigned to the specified user.
-To set the user role, supply the following parameters:
-
-- Username - The username of the account to lookup
-- User Role - The user role of the new account
-
-The user role can be a text string or one of the
-items from the UserRoleManager.SystemUserRoles enum.
-
-The UserRoleManager.SystemUserRoles list contains:
-
-- ADMIN
-- AUTHOR
-- EDITOR
-- BASIC
-- NONE
-
-!!! note
- The NONE user role can never have permissions assigned to it.
- Using the NONE user role is a quick way to remove all permissions from a user.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- userManager.setUserRole("admin", UserRoleManager.SystemUserRoles.ADMIN);
- ```
-
-###Set User Password (setPassword)
-Sets the password assigned to the specified user.
-To set the new password, supply the following parameters:
-
-- Username - The username of the account to lookup
-- Password - The new password to set
-
-!!! note
- If you want to prevent a user from setting an empty password
- or to check for password complexity requirements those checks need
- to be implemented separately. This method allows empty passwords.
- Even if the password is empty, the empty password is still encrypted
- with a random secure salt just like any supplied password would be.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- authManager.setPassword("admin", "newPass");
- ```
-
-###Check If Password Matches (checkPasswordMatches)
-This method allows you to check if the supplied password matches
-the user's stored password in the database.
-To verify the password, supply the following parameters:
-
-- Username - The username of the account to lookup
-- Password - The password to verify
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.checkPasswordMatches("admin", "1234");
- if(result) MessageBox.show("Password Matches!");
- else MessageBox.show("Password Does Not Match!");
- ```
-
-###Lock/Unlock A User (lockUser and unlockUser)
-A locked user account prevents login and prevents any new sessions
-to be opened for the user. Locking an user account may be needed for numerous reasons.
-
-To lock and unlock an account, supply the following parameter:
-
-- Username - The username of the account to lock/unlock
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- //Lock The Account
- authManager.lockUser("admin");
- //Unlock The Account
- authManager.unlockUser("admin");
- ```
-
-###Check If A User Is Locked (isUserLocked)
-A locked user account prevents login and prevents any new sessions
-to be opened for the user. Locking an user account may be needed for numerous reasons.
-
-To check if an account is locked, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isUserLocked("admin");
- if(result) MessageBox.show("Admin Account Is Locked!");
- else MessageBox.show("Admin Account Is Unlocked!");
- ```
-
-###Set User Password Expiration Date (setPasswordExpirationDate)
-Setting a password to expire after a specified date allows the prevention of login and
-new session creation if the password is expired. Setting a password to expire could
-be used to force regular password changes or allow for temporary accounts to be made.
-
-To set a password expiration date, supply the following parameters:
-
-- Username - The username of the account to update
-- Expiration Date - A LocalDateTime object representing the expiration date
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- //Sets the date to now
- authManager.setPasswordExpirationDate("admin", LocalDateTime.now());
- //Sets the date to 30 days from today
- authManager.setPasswordExpirationDate("admin", LocalDateTime.now().plusDays(30));
- //First Method To Set the date to January 1st, 2019 at 8am
- authManager.setPasswordExpirationDate("admin", LocalDateTime.of(2019, 1, 1, 8, 0));
- //Second Method To Set the date to January 1st of 2019 at 8am
- authManager.setPasswordExpirationDate("admin", LocalDateTime.of(2018, Month.JANUARY, 1, 8, 0));
- //Third Method To Set the date to January 1st of 2019 at 8am
- final String str = "2019-01-01 08:00";
- final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");
- authManager.setPasswordExpirationDate("admin", LocalDateTime.parse(str, formatter));
- ```
-
-###Disable Password Expiration (disablePasswordExpiration)
-Setting a password to expire after a specified date allows the prevention of login and
-new session creation if the password is expired. Setting a password to expire could
-be used to force regular password changes or allow for temporary accounts to be made.
-
-To disable password expiration for a user, supply the following parameter:
-
-- Username - The username of the account to update
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- authManager.disablePasswordExpiration("admin");
- ```
-
-###Check If User Password Is Expired (isPasswordExpired)
-Setting a password to expire after a specified date allows the prevention of login and
-new session creation if the password is expired. Setting a password to expire could
-be used to force regular password changes or allow for temporary accounts to be made.
-
-To check if a user's password is expired, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isPasswordExpired("admin");
- if(result) MessageBox.show("Admin Account Password Is Expired!");
- else MessageBox.show("Admin Account Password Is Not Expired!");
- ```
-
-###Check If User Password Has Expiration Date (isPasswordSetToExpire)
-Setting a password to expire after a specified date allows the prevention of login and
-new session creation if the password is expired. Setting a password to expire could
-be used to force regular password changes or allow for temporary accounts to be made.
-
-To check if a user's password has an expiration date, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isPasswordSetToExpire("admin");
- if(result) MessageBox.show("Admin Account Password Has An Expiration Date!");
- else MessageBox.show("Admin Account Password Does Not Have An Expiration Date!");
- ```
-
-###Get User Password Expiration Date (getPasswordExpirationDate)
-Setting a password to expire after a specified date allows the prevention of login and
-new session creation if the password is expired. Setting a password to expire could
-be used to force regular password changes or allow for temporary accounts to be made.
-
-There is two methods to retrieving the password expiration date.
-The date can either be returned as a LocalDateTime object or as a formatted string.
-
-!!! note
- If the expiration date has been disabled or was never enabled this method will
- still return an expiration date. For logistical database reasons a date still
- has to be set. So the date will be set to 1000 years after the user account
- was created or 1000 years after the date when the password expiration date
- was last disabled. This number can be updated if any bugs occur but it seems
- like 1000 years is far enough in the future to not cause any problems.
-
-####LocalDateTime Object
-To retrieve the password expiration date, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm");
- final LocalDateTime result = authManager.getPasswordExpirationDate("admin");
- MessageBox.show("Admin Account Password Expires At " + result.format(formatter));
- ```
-
-####Formatted String Object
-To retrieve the password expiration date, supply the following parameters:
-
-- Username - The username of the account to lookup
-- Format - The string that represents the format to return the date
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final String result = authManager.getPasswordExpirationDate("admin", "yyyy-MM-dd HH:mm");
- MessageBox.show("Admin Account Password Expires At " + result);
- ```
-
-##Single-Session Methods
-
-###Get Logged-In Username (getLoggedInUsername)
-Returns the username of the currently logged in user under the single session context.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final String currentUsername = authManager.getLoggedInUsername();
- ```
-
-###Is Any User Logged-In (isUserLoggedIn)
-Checks if a user is currently logged in under the single-user context.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isUserLoggedIn();
- if(result) MessageBox.show("A user is logged-in!");
- else MessageBox.show("No user is logged-in!");
- ```
-
-###Is A Specific User Logged-In (isUserLoggedIn)
-Checks if the specified user is currently logged in under the single-user context.
-To check if a specific user is logged-in, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isUserLoggedIn("admin");
- if(result) MessageBox.show("Admin user is logged-in!");
- else MessageBox.show("Admin user is not logged-in!");
- ```
-
-###Get Currently Logged-In User Session (getSession)
-Retrieves the current session for the specified username, under the single-user context.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final Session currentSession = authManager.getSession();
- ```
-
-###Get Specific User Session (getSession)
-Retrieves the current session for the specified username, under the single-user context.
-
-To retrieve a specific user session, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final Session session = authManager.getSession("admin");
- ```
-
-###Show Login Dialog (showLoginWindow)
-Shows the login dialog window to log a user into the single-user context.
-The method returns true if a user was logged in successfully.
-Fires either the sessionLoginSuccess or the sessionLoginFailure event
-allowing the getUser method to be called by the assigned EventHandler.
-If the user does not exist, getUser will return null.
-
-To show the login dialog, supply the following parameter:
-
-- true/false - If true, if during the login process an error occurs
-the login dialog will show again listing the error text above the
-username field. If false, if during the login process an error occurs
-the entire method will return false.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.showLoginWindow(true);
- if(result) MessageBox.show("User was logged-in successfully!");
- else MessageBox.show("User login failed!");
- ```
-
-###Login A Specific User (loginUser)
-Logs in a user, under the single-user context, with the specified username,
-without checking for valid credentials.
-
-To retrieve a specific user session, supply the following parameter:
-
-- Username - The username of the account to lookup
-
-!!! warning
- This method does not validate credentials and should not be used except
- in advanced use cases. A example case could be to login a user during unit testing.
- The method showLoginWindow should be used instead. With this method
- the user is immediately logged in as long as the user exists and other
- checks pass (account unlocked, user role enabled and password not expired).
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.loginUser("admin");
- if(result) MessageBox.show("User was logged-in successfully!");
- else MessageBox.show("User login failed!");
- ```
-
-###Logout Current Logged-In User (logout)
-Logs out the specified user from the single session context
-and clears any set permissions. This method will return false
-if no user is currently logged-in.
-
-
-!!! caution
- If the user was deleted from the database while logged in, then
- the getUser event method that is accessible from the
- assigned event handler will return null.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.logoutUser();
- if(result) MessageBox.show("User was logged-out successfully!");
- else MessageBox.show("User logout failed!");
- ```
-
-###Logout Specific User (logout)
-Logs out the specified user from the single session context
-and clears any set permissions. This method will return false
-if no user is currently logged-in or if the specified user does not exist.
-
-To logout a specific user, supply the following parameter:
-
-- Username - The username of the account to logout
-
-!!! caution
- If the user was deleted from the database while logged in, then
- the getUser event method that is accessible from the
- assigned event handler will return null.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.logoutUser("admin");
- if(result) MessageBox.show("User was logged-out successfully!");
- else MessageBox.show("User logout failed!");
- ```
-
-###Get Currently Logged-In User's UserRole (getLoggedInUserRole)
-Retrieves the user role of the currently logged in user under
-the single user context. If no user is currently logged-in then this
-method will return null.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final UserRole result = authManager.getLoggedInUserRole();
- ```
-
-###Check If An Admin User Is Logged-In (isAdminLoggedIn)
-Checks if an admin user is currently logged in under the single user context.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isAdminLoggedIn();
- if(result) MessageBox.show("An Admin user is logged-in!");
- else MessageBox.show("An Admin user is not logged-in!");
- ```
-
-###Get Admin Login Override (getAdminOverride)
-Requests an admin user to authenticate to override permissions by
-showing the login dialog using the single session context. During this
-process the admin user is not actually logged-in, instead just their
-username, password and user role is verified. Returns true if
-admin override succeeded and false if the cancel button was pressed
-or if override failed.
-Fires either the sessionLoginSuccess or the sessionLoginFailure event
-allowing the getUser method to be called by the assigned EventHandler.
-If the user does not exist, getUser will return null.
-
-To show the login dialog, supply the following parameter:
-
-- true/false - If true, if during the login process an error occurs
-the login dialog will show again listing the error text above the
-username field. If false, if during the login process an error occurs
-the entire method will return false.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.getAdminOverride();
- if(result) MessageBox.show("Admin override succedded!");
- else MessageBox.show("Admin override failed!");
- ```
-
-###Get User Login Verification (getUserVerification)
-Requests that the currently logged in username to re-login using
-the single session context. During this process the user is not
-actually logged-in again, instead just their username and password is
-verified. Returns true if the user verification succeeded and false
-if the cancel button was pressed or if override failed.
-Fires either the sessionLoginSuccess or the sessionLoginFailure event
-allowing the getUser method to be called by the assigned EventHandler.
-If the user does not exist, getUser will return null.
-
-To show the login dialog, supply the following parameter:
-
-- true/false - If true, if during the login process an error occurs
-the login dialog will show again listing the error text above the
-username field. If false, if during the login process an error occurs
-the entire method will return false.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.getUserVerification();
- if(result) MessageBox.show("User verification succedded!");
- else MessageBox.show("User verification failed!");
- ```
-
-###Require That Admin Is Logged-In (requireAdmin)
-Checks that the logged-in user, under the single session context,
-is an admin and if not, requests an admin override.
-During this process the user is not actually logged-in again,
-instead their username, password and user role is just verified.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.requireAdmin();
- if(result) MessageBox.show("Admin check passed!");
- else MessageBox.show("Admin check failed!");
- ```
-
-###Require That Admin Is Logged-In And Request Verification (requireAndVerifyAdmin)
-Checks that the logged-in user, under the single session context,
-is an admin, if true, prompts the admin to re-login and
-if false, requests an admin override.
-During this process the user is not actually logged-in again,
-instead their username, password and user role is just verified.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.requireAdmin();
- if(result) MessageBox.show("Admin check passed!");
- else MessageBox.show("Admin check failed!");
- ```
-
-##Multi-Session Methods
-
-###Is A Specific User Logged-In (isUserLoggedIn)
-Checks if the specified user is currently logged in under the multi-user context.
-To check if a specific user is logged-in, supply the following parameters:
-
-- Username - The username of the account to lookup
-- true - The true boolean is required to operate under the multi-user context
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final boolean result = authManager.isUserLoggedIn("admin", true);
- if(result) MessageBox.show("Admin user is logged-in!");
- else MessageBox.show("Admin user is not logged-in!");
- ```
-
-###Get Max Allowed Sessions (getMaxSessions)
-Retrieves the maximum number of allowed sessions,
-under the multi session context, before login is disabled.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final int result = authManager.getMaxSessions();
- MessageBox.show("The max number of allowed sessions is " + result + '!');
- ```
-
-###Set Max Allowed Sessions (setMaxSessions)
-Sets the maximum number of allowed sessions,
-under the multi session context, before login is disabled.
-To disable the limit set the value to a negative number.
-To set the maximum number of allowed sessions, supply the following parameter:
-
-- value - The number of allowed sessions to set
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- //Set max sessions to 30.
- authManager.setMaxSessions(30);
- //Block all session creation by setting to 0
- authManager.setMaxSessions(0);
- ```
-
-!!! note
- Setting this value to a negative number will disable the limit
- because a negative amount of sessions can never be created.
- When the SessionManager is initialized the value is initially set to -1.
-
-###Get Session Count (getSessionsCount)
-Retrieves the current number of logged in sessions under the multi-user context.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final int result = authManager.getSessionsCount();
- MessageBox.show("The max number of logged-in sessions is " + result + '!');
- ```
-
-###Get All Sessions (getSessions)
-Retrieves the current logged in sessions as a HashMap under the multi session context.
-The returned HashMap key is the session username and the value is the related Session object.
-
-!!! example
- ``` java
- final var authManager = AuthManager.getInstance();
- final Map
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ JUT Version ChangelogLink
+Version 1.5.1 changes (10/13/2018):Link
+-
+
- Added new userHasPermissions method overload to AuthManager +
- Added new userHasPermissions method overload to Subject +
- Fixed bugs and missing methods in Subject +
- Fixed deprecated methods in NativeMethods +
- Fixed other small bugs +
Version 1.5.0 changes (10/07/2018):Link
+-
+
- Updated JDK to Java 10 +
- Login Dialogs now don't require the use of Platform.runLater() +
- Message Boxes now don't require the use of Platform.runLater() +
- Message Box Default button is now in the right order. +
- Massive changes to authentication and permissions system +
- Renamed jbdc to jdbc +
- Removed all deprecated methods from 1.4.0 +
- Updated javadoc +
- Replaced some loops with streams +
- Added trim to all string isEmpty checks +
- Added UTF_8 protection +
- Added ExceptionUtils class for use in junit tests +
- All password hashing now uses BCrypt replacing SHA-512 +
- Other minor fixes +
Version 1.4.2 changes (1/23/2018):Link
+-
+
- Fixed fatal error with isUserLoggedIn method +
Version 1.4.1 changes (1/22/2018):Link
+-
+
- Added UserManagerException +
- Added PasswordHashingFailedException +
- Added isAdminLoggedIn method +
- Added getAdminOverride and getUserVerification methods +
- Added requireAdmin and requireAndVerifyAdmin methods +
- Added isLoggedIn method +
- Fixed rare bugs with loginUser and logoutUser methods +
- Fixed exception that was thrown if user did not exist on login dialog +
- Limited number of SQLException and GeneralSecurityException checked exceptions +
- Changed Session Manager dialogs to use instance vars for parameters(old methods deprecated) +
Version 1.4.0 changes (1/19/2018):Link
+-
+
- Added User Management Classes (UserManager, UserAccount, UserRoleManager and UserRole) +
- Added Permission Management Classes (Permission Manager and Permission) +
- Added Session Management Classes (Session Manager, MultiSessionManager and Session) +
- Added Database Builder Classes For Building SQL Code +
- Added HyperSQL Database Support +
- Added Custom Event/Event Handler System +
- Added New Utilities Classes (StringUtils, NumberUtils and CollectionUtils) +
NOTE: Some API changes have occurred: +* Moved Database.Users class to UsersManager class +* Made Database class constructor auto-connect to database +* Deprecated DatabaseConnectionInfo fields and replaced with getters/setters +* Made all utility classes final and have private constructors +* Made all method parameters and most existing classes final +* Added period to first line of all javadoc comments +* Updated SecurityTools.getFileHash to use Apache Commons Codec Library (Java 9 Fix) +* Renamed ReInitalizeHW to ReInitializeHW +* Renamed ReInitalizeOS to ReInitializeOS
+Version 1.3.1 changes (⅘/2017):Link
+-
+
- Added FXML Dialog Wrapper +
- JavaDocs documentation is improved +
- Pom file is improved and updated +
- Now hosted on Maven Central +
Version 1.3.0 changes (3/31/2017):Link
+-
+
- Added MessageBox and Login dialog objects +
- Added Static Class Instantiation Protection +
- Added Database Tools classes (Includes SQLite and H2 databases) +
- All dependencies are now included in jar file +
- JavaDocs documentation is improved +
Version 1.2.0 changes (02/22/2017):Link
+-
+
- Fixed ComputerNameActive and ComputerNamePending not returning accurate value +
- Added ComputerInfo Class +
- Fixed a naming bug since version 1.1 that caused an infinite loop +
- Fixed the java.IO.File.delete calls to now use the java.nio.file.Files.delete +
- Created a demo if the library is run directly +
- Fixed error with RSA generate key pair, it didn't check if save to files was true +
- Fixed error with ConvertBytes function not returning accurate value +
Version 1.1.0 changes (02/18/2017):Link
+-
+
- Created OSInfo, HWInfo, SecurityTools and WebTools classes instead of packages to improve importing. +
- Renamed StringExpanded2 to StringExpandedFromRegistry. +
- Moved tools.osinfo.Enums to just tools.Enums. +
- Finalized JavaDocs. Everything is documented correctly now. +
Version 1.0.0 changes (02/13/2017):Link
+-
+
- Initial Release +
- To access the AuthManager's embedded SessionManager instance use the following code: - ``` java - final var authManager = AuthManager.getNewInstance(db); - final var sessionManager = authManager.getSessionManager(); - ``` - To access the UserManager's embedded SessionManager instance use the following code: - ``` java - final var userManager = new UserManager(db); - final var sessionManager = userManager.getSessionManager(); - ``` - -The Session Manager class contains all methods needed for managing -login sessions to allow users to login to your application. -This includes completing login via either using the UsernamePasswordToken -or requesting credentials from the user via a login dialog. - -##Setup -The Session Manager is not a singleton class so a new instance needs to be initialized. -Since the Session Manager is a low level class it also requires an instance -of the User Manager in addition to the database instance. -The following code can be used to create a new instance: - -!!! example - ``` java - try(final var db = new Database("./mydb.db", DatabaseType.H2)) { - final var userManager = new UserManager(db); - final var sessionManager = new SessionManager(userManager); - } - ``` - -An icon path and program name may also be optionally provided as parameters to change the -icon and program name for all login dialogs. - -##Session Explanation -A login Session is a temporary connection established by a user with a login, -until either the user or the application/service terminates the connection. - -The user must only provide credentials for authentication at the start -of a login session. The user is then authorized to use some or all of the services -offered by the application/service depending on the permissions assigned to the user. - -Within JUT there are two types of login sessions, single-user and multi-user. -All of the following documentation will be separated into two sections one -for each session type/context. - -###Single-User Session Context -Single-User sessions are meant for frontend login to an application. -These sessions can either be initiated via a UsernamePasswordToken or -via a login dialog. Only one user can be logged in at one time thus meaning -only one session can be open at a time. Some of the methods that are part -of the Session Manager can only be used under a Single-User context. - -###Multi-User Session Context -Multi-User sessions are meant for backend login to an application, usually -via a remote client software. These sessions can only be initiated -via a UsernamePasswordToken. Almost an unlimited amount of users can be logged in -at one time and is only dependant on system resources and can be limited -via the setMaxSessions method. Some of the methods that are part -of the Session Manager can only be used under a Multi-User context. - -##Single-Session Methods - -###Get Logged-In Username (getLoggedInUsername) -Returns the username of the currently logged in user under the single session context. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final String currentUsername = sessionManager.getLoggedInUsername(); - ``` - -###Is Any User Logged-In (isUserLoggedIn) -Checks if a user is currently logged in under the single-user context. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.isUserLoggedIn(); - if(result) MessageBox.show("A user is logged-in!"); - else MessageBox.show("No user is logged-in!"); - ``` - -###Is A Specific User Logged-In (isUserLoggedIn) -Checks if the specified user is currently logged in under the single-user context. -To check if a specific user is logged-in, supply the following parameter: - -- Username - The username of the account to lookup - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.isUserLoggedIn("admin"); - if(result) MessageBox.show("Admin user is logged-in!"); - else MessageBox.show("Admin user is not logged-in!"); - ``` - -###Get Currently Logged-In User Session (getSession) -Retrieves the current session for the specified username, under the single-user context. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final Session currentSession = sessionManager.getSession(); - ``` - -###Get Specific User Session (getSession) -Retrieves the current session for the specified username, under the single-user context. - -To retrieve a specific user session, supply the following parameter: - -- Username - The username of the account to lookup - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final Session session = sessionManager.getSession("admin"); - ``` - -###Show Login Dialog (showLoginWindow) -Shows the login dialog window to log a user into the single-user context. -The method returns true if a user was logged in successfully. -Fires either the sessionLoginSuccess or the sessionLoginFailure event -allowing the getUser method to be called by the assigned EventHandler. -If the user does not exist, getUser will return null. - -To show the login dialog, supply the following parameter: - -- true/false - If true, if during the login process an error occurs -the login dialog will show again listing the error text above the -username field. If false, if during the login process an error occurs -the entire method will return false. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.showLoginWindow(true); - if(result) MessageBox.show("User was logged-in successfully!"); - else MessageBox.show("User login failed!"); - ``` - -###Login A Specific User (loginUser) -Logs in a user, under the single-user context, with the specified username, -without checking for valid credentials. - -To retrieve a specific user session, supply the following parameter: - -- Username - The username of the account to lookup - -!!! warning - This method does not validate credentials and should not be used except - in advanced use cases. A example case could be to login a user during unit testing. - The method showLoginWindow should be used instead. With this method - the user is immediately logged in as long as the user exists and other - checks pass (account unlocked, user role enabled and password not expired). - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.loginUser("admin"); - if(result) MessageBox.show("User was logged-in successfully!"); - else MessageBox.show("User login failed!"); - ``` - -###Logout Current Logged-In User (logout) -Logs out the specified user from the single session context -and clears any set permissions. This method will return false -if no user is currently logged-in. - - -!!! caution - If the user was deleted from the database while logged in, then - the getUser event method that is accessible from the - assigned event handler will return null. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.logoutUser(); - if(result) MessageBox.show("User was logged-out successfully!"); - else MessageBox.show("User logout failed!"); - ``` - -###Logout Specific User (logout) -Logs out the specified user from the single session context -and clears any set permissions. This method will return false -if no user is currently logged-in or if the specified user does not exist. - -To logout a specific user, supply the following parameter: - -- Username - The username of the account to logout - -!!! caution - If the user was deleted from the database while logged in, then - the getUser event method that is accessible from the - assigned event handler will return null. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.logoutUser("admin"); - if(result) MessageBox.show("User was logged-out successfully!"); - else MessageBox.show("User logout failed!"); - ``` - -###Get Currently Logged-In User's UserRole (getLoggedInUserRole) -Retrieves the user role of the currently logged in user under -the single user context. If no user is currently logged-in then this -method will return null. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final UserRole result = sessionManager.getLoggedInUserRole(); - ``` - -###Check If An Admin User Is Logged-In (isAdminLoggedIn) -Checks if an admin user is currently logged in under the single user context. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.isAdminLoggedIn(); - if(result) MessageBox.show("An Admin user is logged-in!"); - else MessageBox.show("An Admin user is not logged-in!"); - ``` - -###Get Admin Login Override (getAdminOverride) -Requests an admin user to authenticate to override permissions by -showing the login dialog using the single session context. During this -process the admin user is not actually logged-in, instead just their -username, password and user role is verified. Returns true if -admin override succeeded and false if the cancel button was pressed -or if override failed. -Fires either the sessionLoginSuccess or the sessionLoginFailure event -allowing the getUser method to be called by the assigned EventHandler. -If the user does not exist, getUser will return null. - -To show the login dialog, supply the following parameter: - -- true/false - If true, if during the login process an error occurs -the login dialog will show again listing the error text above the -username field. If false, if during the login process an error occurs -the entire method will return false. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.getAdminOverride(); - if(result) MessageBox.show("Admin override succedded!"); - else MessageBox.show("Admin override failed!"); - ``` - -###Get User Login Verification (getUserVerification) -Requests that the currently logged in username to re-login using -the single session context. During this process the user is not -actually logged-in again, instead just their username and password is -verified. Returns true if the user verification succeeded and false -if the cancel button was pressed or if override failed. -Fires either the sessionLoginSuccess or the sessionLoginFailure event -allowing the getUser method to be called by the assigned EventHandler. -If the user does not exist, getUser will return null. - -To show the login dialog, supply the following parameter: - -- true/false - If true, if during the login process an error occurs -the login dialog will show again listing the error text above the -username field. If false, if during the login process an error occurs -the entire method will return false. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.getUserVerification(); - if(result) MessageBox.show("User verification succedded!"); - else MessageBox.show("User verification failed!"); - ``` - -###Require That Admin Is Logged-In (requireAdmin) -Checks that the logged-in user, under the single session context, -is an admin and if not, requests an admin override. -During this process the user is not actually logged-in again, -instead their username, password and user role is just verified. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.requireAdmin(); - if(result) MessageBox.show("Admin check passed!"); - else MessageBox.show("Admin check failed!"); - ``` - -###Require That Admin Is Logged-In And Request Verification (requireAndVerifyAdmin) -Checks that the logged-in user, under the single session context, -is an admin, if true, prompts the admin to re-login and -if false, requests an admin override. -During this process the user is not actually logged-in again, -instead their username, password and user role is just verified. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.requireAdmin(); - if(result) MessageBox.show("Admin check passed!"); - else MessageBox.show("Admin check failed!"); - ``` - -##Multi-Session Methods - -###Is A Specific User Logged-In (isUserLoggedIn) -Checks if the specified user is currently logged in under the multi-user context. -To check if a specific user is logged-in, supply the following parameters: - -- Username - The username of the account to lookup -- true - The true boolean is required to operate under the multi-user context - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final boolean result = sessionManager.isUserLoggedIn("admin", true); - if(result) MessageBox.show("Admin user is logged-in!"); - else MessageBox.show("Admin user is not logged-in!"); - ``` - -###Get Max Allowed Sessions (getMaxSessions) -Retrieves the maximum number of allowed sessions, -under the multi session context, before login is disabled. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final int result = sessionManager.getMaxSessions(); - MessageBox.show("The max number of allowed sessions is " + result + '!'); - ``` - -###Set Max Allowed Sessions (setMaxSessions) -Sets the maximum number of allowed sessions, -under the multi session context, before login is disabled. -To disable the limit set the value to a negative number. -To set the maximum number of allowed sessions, supply the following parameter: - -- value - The number of allowed sessions to set - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - //Set max sessions to 30. - sessionManager.setMaxSessions(30); - //Block all session creation by setting to 0 - sessionManager.setMaxSessions(0); - ``` - -!!! note - Setting this value to a negative number will disable the limit - because a negative amount of sessions can never be created. - When the SessionManager is initialized the value is initially set to -1. - -###Get Session Count (getSessionsCount) -Retrieves the current number of logged in sessions under the multi-user context. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final int result = sessionManager.getSessionsCount(); - MessageBox.show("The max number of logged-in sessions is " + result + '!'); - ``` - -###Get All Sessions (getSessions) -Retrieves the current logged in sessions as a HashMap under the multi session context. -The returned HashMap key is the session username and the value is the related Session object. - -!!! example - ``` java - final var sessionManager = new SessionManager(userManager); - final Map
- To access the AuthManager's embedded UserManager instance use the following code: - ``` java - final var authManager = AuthManager.getNewInstance(db); - final var userManager = authManager.getUserManager(); - ``` - -The User Manager manages all user accounts in the database. -This is where all the native SQL code is automatically -generated using the Database Builder classes. - -##Setup -The User Manager is not a singleton class so a new instance needs to be initialized. -When a new instance is created a "users" table is automatically created in the specified database. -The following code can be used to create a new instance: - -!!! example - ``` java - try(final var db = new Database("./mydb.db", DatabaseType.H2)) { - final var userManager = new UserManager(db); - } - ``` - -An icon path and program name may also be optionally provided as parameters to change the -icon and program name for all login dialogs. - -##User Account Methods - -###Create A New User (createUser) -To create a new user use the createUser method supplying the following parameters: - -- Username - The username of the new account -- Password - The password of the new account -- User Role - The user role of the new account - -The user role can be a text string or one of the -items from the UserRoleManager.SystemUserRoles enum. - -The UserRoleManager.SystemUserRoles list contains: - -- ADMIN -- AUTHOR -- EDITOR -- BASIC -- NONE - -!!! note - The NONE user role can never have permissions assigned to it. - Using the NONE user role is a quick way to remove all permissions from a user. - -!!! example - ``` java - final var userManager = new UserManager(db); - userManager.createUser("admin", "1234", UserRoleManager.SystemUserRoles.ADMIN); - userManager.createUser("editor", "1234", UserRoleManager.SystemUserRoles.EDITOR); - ``` - -###Delete An Existing User (deleteUser) -To delete an existing user use the deleteUser method supplying the following parameter: - -- Username - The username of the account to delete - -!!! example - ``` java - final var userManager = new UserManager(db); - userManager.deleteUser("admin"); - ``` - -###Get Username Object (getUser) -Retrieves a readonly immutable UserAccount object. -To retrieve the object, supply the following parameter: - -- Username - The username of the account to lookup - -!!! example - ``` java - final var userManager = new UserManager(db); - final UserAccount user = userManager.getUser("admin"); - ``` - -###Check If User Exists (userExists) -Checks to see if the specified user account exists. -To check a user account, supply the following parameter: - -- Username - The username of the account to lookup - -!!! example - ``` java - final var userManager = new UserManager(db); - final boolean result = userManager.userExists("admin"); - if(result) MessageBox.show("Admin User Exists!"); - else MessageBox.show("Admin User Does Not Exist!"); - ``` - -###Get User Role (getUserRole) -Retrieves the UserRole object assigned to the specified user. -To retrieve the object, supply the following parameter: - -- Username - The username of the account to lookup - -!!! example - ``` java - final var userManager = new UserManager(db); - final UserRole userRole = userManager.getUserRole("admin"); - ``` - -###Set User Role (getUserRole) -Sets the user role assigned to the specified user. -To set the user role, supply the following parameters: - -- Username - The username of the account to lookup -- User Role - The user role of the new account - -The user role can be a text string or one of the -items from the UserRoleManager.SystemUserRoles enum. - -The UserRoleManager.SystemUserRoles list contains: - -- ADMIN -- AUTHOR -- EDITOR -- BASIC -- NONE - -!!! note - The NONE user role can never have permissions assigned to it. - Using the NONE user role is a quick way to remove all permissions from a user. - -!!! example - ``` java - final var userManager = new UserManager(db); - userManager.setUserRole("admin", UserRoleManager.SystemUserRoles.ADMIN); - ``` - -###Set User Password (setPassword) -Sets the password assigned to the specified user. -To set the new password, supply the following parameters: - -- Username - The username of the account to lookup -- Password - The new password to set - -!!! note - If you want to prevent a user from setting an empty password - or to check for password complexity requirements those checks need - to be implemented separately. This method allows empty passwords. - Even if the password is empty, the empty password is still encrypted - with a random secure salt just like any supplied password would be. - -!!! example - ``` java - final var userManager = new UserManager(db); - userManager.setPassword("admin", "newPass"); - ``` - -###Check If Password Matches (checkPasswordMatches) -This method allows you to check if the supplied password matches -the user's stored password in the database. -To verify the password, supply the following parameters: - -- Username - The username of the account to lookup -- Password - The password to verify - -!!! example - ``` java - final var userManager = new UserManager(db); - final boolean result = userManager.checkPasswordMatches("admin", "1234"); - if(result) MessageBox.show("Password Matches!"); - else MessageBox.show("Password Does Not Match!"); - ``` - -###Lock/Unlock A User Account(setLockStatus) -A locked user account prevents login and prevents any new sessions -to be opened for the user. Locking an user account may be needed for numerous reasons. - -To lock and unlock an account, supply the following parameters: - -- Username - The username of the account to lock/unlock -- true/false - The value to set, true to lock, false to unlock - -!!! example - ``` java - final var userManager = new UserManager(db); - //Lock The Account - userManager.setLockStatus("admin", true); - //Unlock The Account - userManager.setLockStatus("admin", false); - ``` - -###Set User Password Expiration Date (setPasswordExpirationDate) -Setting a password to expire after a specified date allows the prevention of login and -new session creation if the password is expired. Setting a password to expire could -be used to force regular password changes or allow for temporary accounts to be made. - -To set a password expiration date, supply the following parameters: - -- Username - The username of the account to update -- Expiration Date - A LocalDateTime object representing the expiration date - -!!! example - ``` java - final var userManager = new UserManager(db); - //Sets the date to now - userManager.setPasswordExpirationDate("admin", LocalDateTime.now()); - //Sets the date to 30 days from today - userManager.setPasswordExpirationDate("admin", LocalDateTime.now().plusDays(30)); - //First Method To Set the date to January 1st, 2019 at 8am - userManager.setPasswordExpirationDate("admin", LocalDateTime.of(2019, 1, 1, 8, 0)); - //Second Method To Set the date to January 1st of 2019 at 8am - userManager.setPasswordExpirationDate("admin", LocalDateTime.of(2018, Month.JANUARY, 1, 8, 0)); - //Third Method To Set the date to January 1st of 2019 at 8am - final String str = "2019-01-01 08:00"; - final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm"); - userManager.setPasswordExpirationDate("admin", LocalDateTime.parse(str, formatter)); - ``` - -###Disable Password Expiration (disablePasswordExpiration) -Setting a password to expire after a specified date allows the prevention of login and -new session creation if the password is expired. Setting a password to expire could -be used to force regular password changes or allow for temporary accounts to be made. - -To disable password expiration for a user, supply the following parameter: - -- Username - The username of the account to update - -!!! example - ``` java - final var userManager = new UserManager(db); - userManager.disablePasswordExpiration("admin"); - ``` - -##Other Methods - -###Get All Username Objects (getUsersList) -The getUsersList method retrieves a readonly immutable UserAccount object for each user -account and returns the list as a HashSet. - -!!! example - ``` java - final var userManager = new UserManager(db); - final HashMap
[github.io(Current GitHub Branch)](https://jgcomptech.github.io/JavaUltimateTools/) - stored in the doc folder in the project repository on Github -
[javadoc.io(Current Maven Release)](http://www.javadoc.io/doc/com.jgcomptech.tools/java-ultimate-tools) - the released JavaDoc jar on Maven Central - -## Download JAR -**[ Download v1.5.1](https://github.com/JGCompTech/JavaUltimateTools/releases/tag/v1.5.1)** - -The changelog can be found [[Changelog | here]]. - -## Using with Maven -If you are familiar with [Maven](http://maven.apache.org), add the following XML -fragments into your pom.xml file. With those settings, your Maven will automatically download our library into your local Maven repository, since our libraries are synchronized with the [Maven central repository](http://repo1.maven.org/maven2/com/jgcomptech/tools/java-ultimate-tools/). - -``` tab="Maven" -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
deleted file mode 100644
index 86edec9..0000000
--- a/mkdocs.yml
+++ /dev/null
@@ -1,71 +0,0 @@
-site_name: Java Ultimate Tools Documentation
-site_description: The Official Documentation For The Java Ultimate Tools Library
-
-theme:
- name: material
- palette:
- primary: 'blue grey'
- accent: 'amber'
- font:
- text: 'Ubuntu'
- code: 'Ubuntu Mono'
- logo:
- icon: 'settings_applications'
-
-site_author: Joshua Gager
-
-repo_name: 'JavaUltimateTools-Docs'
-repo_url: 'https://github.com/JGCompTech/JavaUltimateTools-Docs'
-
-extra:
- social:
- - type: 'github'
- link: 'https://github.com/JGCompTech'
- - type: 'globe'
- link: 'https://jgcomptech.com'
-
-markdown_extensions:
- - admonition
- - codehilite:
- linenums: true
- - footnotes
- - abbr
- - sane_lists
- - mdx_semanticwikilinks
- - toc:
- permalink: Link
- - pymdownx.betterem:
- smart_enable: all
- - pymdownx.caret
- - pymdownx.critic
- - pymdownx.details
- - pymdownx.inlinehilite
- - pymdownx.magiclink
- - pymdownx.mark
- - pymdownx.smartsymbols
- - pymdownx.superfences
- - pymdownx.tasklist:
- custom_checkbox: true
- - pymdownx.tilde
-
-nav:
- - Home: index.md
- - Classes:
- - Auth System:
- - Intoduction: AuthSystem/index.md
- - Auth Manager: AuthSystem/AuthManager.md
- - Permission Manager: AuthSystem/PermissionManager.md
- - Session Manager: AuthSystem/SessionManager.md
- - Subject: AuthSystem/Subject.md
- - User Manager: AuthSystem/UserManager.md
- - User Role Manager: AuthSystem/UserRoleManager.md
- - Database Tools: DatabaseTools/index.md
- - Dialogs: Dialogs/index.md
- - Event Management: EventManagement/index.md
- - HWInfo : HWInfo/index.md
- - OSInfo: OSInfo/index.md
- - Security Tools: SecurityTools/index.md
- - Utils : Utils/index.md
- - Changelog: changelog.md
- - JavaDoc: http://www.javadoc.io/doc/com.jgcomptech.tools/java-ultimate-tools
- - GitHub: https://github.com/JGCompTech/JavaUltimateTools
\ No newline at end of file
diff --git a/search/search_index.json b/search/search_index.json
new file mode 100755
index 0000000..ba9f6bd
--- /dev/null
+++ b/search/search_index.json
@@ -0,0 +1 @@
+{"config":{"lang":["en"],"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome to Java Ultimate Tools Docs Link What is Java Ultimate Tools? Link Java Ultimate Tools, or JUT for short, is a large powerful and flexible open-source repository for use in any Java program. Java Ultimate Tools Features Link OSInfo - Contains many classes that return information about the current Windows installation. This includes Architecture, Edition, Name, Product Key, Service Pack, User Info and Version. HWInfo - Contains many classes that return information about the current computer hardware. This includes BIOS, Network, OEM, Processor, RAM and Storage. SecurityTools - Contains methods surrounding hashing and encryption. Includes methods using MD5, SHA1, SHA256, SHA384 and SHA512. Also includes encryption/decryption with RSA. CommandInfo - Allows you to run any console command and will return the result to a string to use within your program. You can also run the command elevated and it will open in a new cmd window and show the results. Note: If elevated, result cannot be returned as a string. MessageBox and Login dialogs - Dialogs to use in JavaFX applications FXML Dialog Wrapper - Class to wrap a FXML dialog object, reducing the amount of required code DatabaseTools - Allows communication with H2, HyperSQL and SQLite databases SQL Statement Builders - Allows for using methods instead of native SQL code to generate Prepared Statements User Account Management Tools - Includes User Roles, Sessions and Permissions Custom Event Manager System - Creates Events similar to the JavaFX Events but not using any JavaFX classes Utility Classes - Includes classes for managing collections, numbers and strings And Much More! NOTE: This Project Has Now Been Updated To Use Java 10!!! Development Link Want to contribute? Great! Any help with development is greatly appreciated. If you want to add something or fix any issues please submit a pull request and if it is helpful it may be merged. Please check out our Code of Conduct for Contributors . Documentation Link The documentation for JUT is currently a work in progress and new changes will be occurring soon. JavaDoc Link The JavaDoc info is hosted at the following 2 locations: github.io(Current GitHub Branch) - stored in the doc folder in the project repository on Github javadoc.io(Current Maven Release) - the released JavaDoc jar on Maven Central Download JAR Link Download v1.5.1 The changelog can be found here . Using with Maven Link If you are familiar with Maven , add the following XML fragments into your pom.xml file. With those settings, your Maven will automatically download our library into your local Maven repository, since our libraries are synchronized with the Maven central repository . Maven 1 2 3 4 5 6 7
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Welcome to Java Ultimate Tools DocsLink
+
What is Java Ultimate Tools?Link
+Java Ultimate Tools, or JUT for short, is a large powerful and flexible open-source repository for use in any Java program.
+Java Ultimate Tools FeaturesLink
+-
+
- OSInfo - Contains many classes that return information about the current Windows installation. This includes Architecture, Edition, Name, Product Key, Service Pack, User Info and Version. +
- HWInfo - Contains many classes that return information about the current computer hardware. This includes BIOS, Network, OEM, Processor, RAM and Storage. +
- SecurityTools - Contains methods surrounding hashing and encryption. Includes methods using MD5, SHA1, SHA256, SHA384 and SHA512. Also includes encryption/decryption with RSA. +
- CommandInfo - Allows you to run any console command and will return the result to a string to use within your program. You can also run the command elevated and it will open in a new cmd window and show the results. Note: If elevated, result cannot be returned as a string. +
- MessageBox and Login dialogs - Dialogs to use in JavaFX applications +
- FXML Dialog Wrapper - Class to wrap a FXML dialog object, reducing the amount of required code +
- DatabaseTools - Allows communication with H2, HyperSQL and SQLite databases +
- SQL Statement Builders - Allows for using methods instead of native SQL code to generate Prepared Statements +
- User Account Management Tools - Includes User Roles, Sessions and Permissions +
- Custom Event Manager System - Creates Events similar to the JavaFX Events but not using any JavaFX classes +
- Utility Classes - Includes classes for managing collections, numbers and strings +
- And Much More! +
NOTE: This Project Has Now Been Updated To Use Java 10!!!
+DevelopmentLink
+Want to contribute? Great! +Any help with development is greatly appreciated. If you want to add something or fix any issues please submit a pull request and if it is helpful it may be merged. Please check out our Code of Conduct for Contributors.
+DocumentationLink
+The documentation for JUT is currently a work in progress and new changes will be occurring soon.
+JavaDocLink
+The JavaDoc info is hosted at the following 2 locations:
+
github.io(Current GitHub Branch) - stored in the doc folder in the project repository on Github
+
javadoc.io(Current Maven Release) - the released JavaDoc jar on Maven Central
Download JARLink
+ +The changelog can be found here.
+Using with MavenLink
+If you are familiar with Maven, add the following XML +fragments into your pom.xml file. With those settings, your Maven will automatically download our library into your local Maven repository, since our libraries are synchronized with the Maven central repository.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+1 +2 +3 +4 +5 +6 +7 | <dependencies> + <dependency> + <groupId>com.jgcomptech.tools</groupId> + <artifactId>java-ultimate-tools</artifactId> + <version>1.5.1</version> + </dependency> +</dependencies> + |
1 | compile 'com.jgcomptech.tools:java-ultimate-tools:1.5.1' + |
1 | compile(group = "com.jgcomptech.tools", name = "java-ultimate-tools", version = "1.5.1") + |
1 | libraryDependencies += "com.jgcomptech.tools" % "java-ultimate-tools" % "1.5.1" + |
1 | <dependency org="com.jgcomptech.tools" name="java-ultimate-tools" rev="1.5.1" /> + |
1 +2 +3 | @Grapes( + @Grab(group='com.jgcomptech.tools', module='java-ultimate-tools', version='1.5.1') +) + |
LicenseLink
+
JavaUltimateTools by J&G CompTech is licensed under a Creative Commons Attribution 4.0 International License.
+©2018 J&G CompTech
+ + + + + + + + + +