#8: Cleanup & Javadoc
Some checks failed
Quality Check / Linting Check (push) Failing after 16s
Quality Check / Linting Check (pull_request) Failing after 20s
Quality Check / Javadoc Check (push) Successful in 34s
Quality Check / Javadoc Check (pull_request) Successful in 33s

Signed-off-by: Dominik Säume <Dominik.Saeume@hmmh.de>
This commit is contained in:
Dominik Säume 2024-05-22 09:49:52 +02:00
parent 7db1c83a08
commit ab0f084912
Signed by: SZUT-Dominik
GPG key ID: 67D15BB250B41E7C
7 changed files with 64 additions and 11 deletions

View file

@ -37,10 +37,17 @@ public class Main extends Application {
@Override @Override
public void start(Stage primaryStage) { public void start(Stage primaryStage) {
this.primaryStage = primaryStage; this.primaryStage = primaryStage;
executePassword(); User user = executeLogin();
if(user != null){
executeMainApplication(user);
}
} }
private void executePassword() { /**
* Executes the login.
* @return User The {@link User} object for the logged-in {@link User}. Is {@code null}, if the login was not successful,
*/
private User executeLogin() {
try { try {
FXMLLoader loader = new FXMLLoader(Main.class.getResource("/de/hitec/nhplus/login/LoginView.fxml")); FXMLLoader loader = new FXMLLoader(Main.class.getResource("/de/hitec/nhplus/login/LoginView.fxml"));
@ -55,12 +62,10 @@ public class Main extends Application {
controller.initialize(loginStage); controller.initialize(loginStage);
loginStage.showAndWait(); loginStage.showAndWait();
return controller.user;
if(controller.user != null){
executeMainApplication(controller.user);
}
} catch (IOException exception) { } catch (IOException exception) {
exception.printStackTrace(); exception.printStackTrace();
return null;
} }
} }

View file

@ -13,7 +13,12 @@ import java.sql.Connection;
import java.sql.SQLException; import java.sql.SQLException;
import java.util.*; import java.util.*;
public class UserFixture implements Fixture<User>{ /**
* {@link Fixture} for {@link User}.
*
* @author Dominik Säume
*/
public class UserFixture implements Fixture<User> {
private static final String SCHEMA = "/de/hitec/nhplus/login/database/User.sql"; private static final String SCHEMA = "/de/hitec/nhplus/login/database/User.sql";
private static final String PERMISSION_SCHEMA = "/de/hitec/nhplus/login/database/UserPermission.sql"; private static final String PERMISSION_SCHEMA = "/de/hitec/nhplus/login/database/UserPermission.sql";
private static final String TO_NURSE_SCHEMA = "/de/hitec/nhplus/login/database/UserToNurse.sql"; private static final String TO_NURSE_SCHEMA = "/de/hitec/nhplus/login/database/UserToNurse.sql";
@ -94,7 +99,7 @@ public class UserFixture implements Fixture<User>{
UserDao dao = DaoFactory.getInstance().createUserDAO(); UserDao dao = DaoFactory.getInstance().createUserDAO();
Map<String, User> usersByUsername = new HashMap<>(); Map<String, User> usersByUsername = new HashMap<>();
for (User user : users){ for (User user : users) {
dao.create(user); dao.create(user);
usersByUsername.put(user.getUsername(), user); usersByUsername.put(user.getUsername(), user);
} }

View file

@ -17,6 +17,11 @@ import java.security.NoSuchAlgorithmException;
import java.sql.SQLException; import java.sql.SQLException;
import java.util.Arrays; import java.util.Arrays;
/**
* Controller for handling the login of {@link User}s.
*
* @author Dominik Säume
*/
public class LoginController { public class LoginController {
public User user; public User user;
@ -29,11 +34,18 @@ public class LoginController {
private Stage stage; private Stage stage;
private int loginTries = 0; private int loginTries = 0;
/**
* JavaFX Initialization method that is called after the binding of all the fields.
*
* @param stage The {@link Stage}, so the modal can close itself, when finished.
*/
public void initialize(Stage stage) { public void initialize(Stage stage) {
this.stage = stage; this.stage = stage;
} }
/**
* Internal method to handle actions on wrong logins, like a shake, timout and total tries.
*/
private void handleWrongPasswordOrUsername() { private void handleWrongPasswordOrUsername() {
loginTries++; loginTries++;

View file

@ -1,5 +1,11 @@
package de.hitec.nhplus.login; package de.hitec.nhplus.login;
/**
* A simple class holding the bitmasks for all permissions.
* This is a class instead of an enum, for ease of use.
*
* @author Dominiok Säume
*/
public class Permissions { public class Permissions {
public final static int EVERYBODY = 0b0; public final static int EVERYBODY = 0b0;
public final static int NURSE = 0b1; public final static int NURSE = 0b1;

View file

@ -7,8 +7,13 @@ import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException; import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom; import java.security.SecureRandom;
public class User {
/**
* The model for a {@link User}.
*
* @author Dominik Säume
*/
public class User {
private int id; private int id;
private String username; private String username;
@ -17,6 +22,10 @@ public class User {
private int permissions = 0; private int permissions = 0;
private Nurse nurse; private Nurse nurse;
/**
* This constructor allows instantiating a {@link User} object with all existing fields.
*/
public User( public User(
int id, int id,
String username, String username,
@ -33,6 +42,9 @@ public class User {
this.nurse = nurse; this.nurse = nurse;
} }
/**
* This constructor allows instantiating a {@link User} object.
*/
public User( public User(
String username, String username,
int permissions, int permissions,
@ -42,6 +54,12 @@ public class User {
this.permissions = permissions; this.permissions = permissions;
this.nurse = nurse; this.nurse = nurse;
} }
/**
* Sets the {@link User} password. The {@link User} will need to be manually stored with the
* {@link de.hitec.nhplus.login.database.UserDao UserDao}, for changes to persists.
* @param password The new Password
*/
public void setPassword(String password) { public void setPassword(String password) {
try { try {
SecureRandom random = new SecureRandom(); SecureRandom random = new SecureRandom();
@ -59,6 +77,7 @@ public class User {
public boolean hasNursePermissions(){ public boolean hasNursePermissions(){
return (permissions & Permissions.NURSE) != 0; return (permissions & Permissions.NURSE) != 0;
} }
public boolean hasAdminPermissions(){ public boolean hasAdminPermissions(){
return (permissions & Permissions.MANAGEMENT) != 0; return (permissions & Permissions.MANAGEMENT) != 0;
} }

View file

@ -44,7 +44,7 @@ public class Nurse extends Person {
/** /**
* This constructor allows instantiating a {@link Nurse} object with * This constructor allows instantiating a {@link Nurse} object with
* specifying if the nurse is locked or not. * specifying whether the {@link Nurse} is locked or not.
*/ */
public Nurse( public Nurse(
String firstName, String firstName,

View file

@ -1,5 +1,11 @@
package de.hitec.nhplus.utils.tab; package de.hitec.nhplus.utils.tab;
/**
* A simple class holding the data needed for constructing a tab.
*
* @author Dominiok Säume
* @see TabManager
*/
public class TabStruct { public class TabStruct {
public String title; public String title;
public String view; public String view;