From 2520320c62146e197a5e16ce25aea0da2606afb1 Mon Sep 17 00:00:00 2001
From: BEAUVAIS ANTOINE <antoine.beauvais@etu.unistra.fr>
Date: Sun, 26 Sep 2021 13:59:59 +0200
Subject: [PATCH] Updated Javadoc & refactored IDatabase.
---
.../fr/unistra/sil/erp/back/DatabaseSystem.java | 6 +++---
.../unistra/sil/erp/back/ErpBackApplication.java | 11 +++++++++++
.../unistra/sil/erp/back/ServletInitializer.java | 9 +++++++++
.../java/fr/unistra/sil/erp/back/WebMvcConfig.java | 14 ++++++++++++++
.../controller/api/ApiBadRequestException.java | 6 +++---
.../api/ApiRetrieveCategoriesController.java | 4 ++--
.../controller/api/ApiRetrieveItemsController.java | 4 ++--
.../erp/back/controller/api/ApiRetrieveStocks.java | 4 ++--
.../controller/api/ApiServerErrorException.java | 6 +++---
.../api/ApiSubmitTransactionController.java | 4 ++--
.../erp/back/db/DatabaseConnectionException.java | 6 +++---
.../back/db/DatabaseResourceNotFoundException.java | 6 +++---
.../sil/erp/back/db/DatabaseSQLiteImpl.java | 2 +-
.../sil/erp/back/db/DatabaseUpdateException.java | 6 +++---
.../db/{DatabaseInterface.java => IDatabase.java} | 2 +-
.../api/ApiAuthenticationInterceptor.java | 6 +++---
16 files changed, 65 insertions(+), 31 deletions(-)
rename src/main/java/fr/unistra/sil/erp/back/db/{DatabaseInterface.java => IDatabase.java} (98%)
diff --git a/src/main/java/fr/unistra/sil/erp/back/DatabaseSystem.java b/src/main/java/fr/unistra/sil/erp/back/DatabaseSystem.java
index 854d434..627c729 100644
--- a/src/main/java/fr/unistra/sil/erp/back/DatabaseSystem.java
+++ b/src/main/java/fr/unistra/sil/erp/back/DatabaseSystem.java
@@ -5,8 +5,8 @@
package fr.unistra.sil.erp.back;
import fr.unistra.sil.erp.back.db.DatabaseConnectionException;
-import fr.unistra.sil.erp.back.db.DatabaseInterface;
import fr.unistra.sil.erp.back.db.DatabaseSQLiteImpl;
+import fr.unistra.sil.erp.back.db.IDatabase;
/**
* Manages the database implementation to use.
@@ -17,7 +17,7 @@ public class DatabaseSystem {
/**
* The database implementation object.
*/
- private static DatabaseInterface instance;
+ private static IDatabase instance;
/**
* Returns the database implementation in use.In order to change the
@@ -27,7 +27,7 @@ public class DatabaseSystem {
* @return the instance of the database implementation.
* @throws DatabaseConnectionException if the connection to the DB failed.
*/
- public static DatabaseInterface getInstance() throws DatabaseConnectionException
+ public static IDatabase getInstance() throws DatabaseConnectionException
{
if(DatabaseSystem.instance == null)
DatabaseSystem.instance = new DatabaseSQLiteImpl();
diff --git a/src/main/java/fr/unistra/sil/erp/back/ErpBackApplication.java b/src/main/java/fr/unistra/sil/erp/back/ErpBackApplication.java
index 4fca44f..054c1a6 100644
--- a/src/main/java/fr/unistra/sil/erp/back/ErpBackApplication.java
+++ b/src/main/java/fr/unistra/sil/erp/back/ErpBackApplication.java
@@ -3,9 +3,20 @@ package fr.unistra.sil.erp.back;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
+/**
+ * Java Spring entry class.
+ *
+ * This is where the Spring application boots.
+ *
+ * @author BEAUVAIS ANTOINE
+ */
@SpringBootApplication
public class ErpBackApplication {
+ /**
+ * Application's main method.
+ * @param args command-line arguments.
+ */
public static void main(String[] args) {
SpringApplication.run(ErpBackApplication.class, args);
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/ServletInitializer.java b/src/main/java/fr/unistra/sil/erp/back/ServletInitializer.java
index 99706f9..adfec88 100644
--- a/src/main/java/fr/unistra/sil/erp/back/ServletInitializer.java
+++ b/src/main/java/fr/unistra/sil/erp/back/ServletInitializer.java
@@ -3,8 +3,17 @@ package fr.unistra.sil.erp.back;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
+/**
+ * Servlet initialization class.
+ * @author BEAUVAIS ANTOINE
+ */
public class ServletInitializer extends SpringBootServletInitializer {
+ /**
+ * Configures the Spring application through its builder.
+ * @param application the application's builder.
+ * @return the Spring builder for this application.
+ */
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
return application.sources(ErpBackApplication.class);
diff --git a/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java b/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java
index f2c8d82..8680c63 100644
--- a/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java
+++ b/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java
@@ -26,6 +26,9 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
)
public class WebMvcConfig implements WebMvcConfigurer {
+ /**
+ * Autowired environment for retrieving properties.
+ */
@Autowired
private Environment env;
@@ -77,6 +80,17 @@ public class WebMvcConfig implements WebMvcConfigurer {
configurer.enable();
}*/
+ /**
+ * Adds interceptors to the application.
+ *
+ * Interceptors process HTTP requests before they reach their
+ * attributed methods.
+ *
+ * Currently, interceptors are only used for authentication in this
+ * application.
+ *
+ * @param registry
+ */
@Override
public void addInterceptors(InterceptorRegistry registry) {
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiBadRequestException.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiBadRequestException.java
index 07cf910..91a3258 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiBadRequestException.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiBadRequestException.java
@@ -23,11 +23,11 @@ public class ApiBadRequestException extends Exception {
/**
* Class constructor.
- * @param errMsg the error message.
+ * @param string the error message.
*/
- public ApiBadRequestException(String errMsg)
+ public ApiBadRequestException(String string)
{
- super(errMsg);
+ super(string);
}
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveCategoriesController.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveCategoriesController.java
index 03f98dd..a2c01ba 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveCategoriesController.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveCategoriesController.java
@@ -9,7 +9,6 @@ import fr.unistra.sil.erp.back.DatabaseSystem;
import fr.unistra.sil.erp.back.controller.IRetrieveCategoriesController;
import fr.unistra.sil.erp.back.model.Category;
import fr.unistra.sil.erp.back.db.DatabaseConnectionException;
-import fr.unistra.sil.erp.back.db.DatabaseInterface;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -17,6 +16,7 @@ import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
+import fr.unistra.sil.erp.back.db.IDatabase;
/**
* REST controller for the category list.
@@ -35,7 +35,7 @@ public class ApiRetrieveCategoriesController
@Override
public ResponseEntity<Object> getCategories() throws ApiServerErrorException
{
- DatabaseInterface db;
+ IDatabase db;
try {
db = DatabaseSystem.getInstance();
} catch (DatabaseConnectionException ex) {
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveItemsController.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveItemsController.java
index 9ff740b..5695585 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveItemsController.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveItemsController.java
@@ -9,7 +9,6 @@ import fr.unistra.sil.erp.back.DatabaseSystem;
import fr.unistra.sil.erp.back.controller.IRetrieveInfoController;
import fr.unistra.sil.erp.back.model.Item;
import fr.unistra.sil.erp.back.db.DatabaseConnectionException;
-import fr.unistra.sil.erp.back.db.DatabaseInterface;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -18,6 +17,7 @@ import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
+import fr.unistra.sil.erp.back.db.IDatabase;
/**
* REST controller for the item list.
@@ -38,7 +38,7 @@ public class ApiRetrieveItemsController implements IRetrieveInfoController {
@RequestParam(value = "category", defaultValue = "") String cat
) throws ApiServerErrorException, ApiBadRequestException
{
- DatabaseInterface db;
+ IDatabase db;
try {
db = DatabaseSystem.getInstance();
} catch (DatabaseConnectionException ex) {
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveStocks.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveStocks.java
index 44f89c3..f7a7ed8 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveStocks.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiRetrieveStocks.java
@@ -8,7 +8,6 @@ import static fr.unistra.sil.erp.back.WebMvcConfig.MAPPING_GETSTOCKS;
import fr.unistra.sil.erp.back.DatabaseSystem;
import fr.unistra.sil.erp.back.controller.IRetrieveStocks;
import fr.unistra.sil.erp.back.db.DatabaseConnectionException;
-import fr.unistra.sil.erp.back.db.DatabaseInterface;
import fr.unistra.sil.erp.back.model.Stock;
import java.util.List;
import java.util.logging.Level;
@@ -19,6 +18,7 @@ import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
+import fr.unistra.sil.erp.back.db.IDatabase;
/**
* Retrieves stocks in JSON format.
@@ -38,7 +38,7 @@ public class ApiRetrieveStocks implements IRetrieveStocks {
@Override
public ResponseEntity<Object> retrieveStocks(HttpServletRequest request,
HttpServletResponse response) throws ApiServerErrorException {
- DatabaseInterface db;
+ IDatabase db;
try {
db = DatabaseSystem.getInstance();
} catch (DatabaseConnectionException ex) {
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiServerErrorException.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiServerErrorException.java
index 2ba9a23..9331296 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiServerErrorException.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiServerErrorException.java
@@ -18,10 +18,10 @@ public class ApiServerErrorException extends Exception {
/**
* Class constructor.
- * @param errMsg the error message to display to the end-user.
+ * @param string the error message to display to the end-user.
*/
- public ApiServerErrorException(String errMsg)
+ public ApiServerErrorException(String string)
{
- super(errMsg);
+ super(string);
}
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiSubmitTransactionController.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiSubmitTransactionController.java
index 8396f29..a84da18 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiSubmitTransactionController.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/ApiSubmitTransactionController.java
@@ -10,7 +10,6 @@ import static fr.unistra.sil.erp.back.WebMvcConfig.MAPPING_SUBTRANSAC;
import fr.unistra.sil.erp.back.DatabaseSystem;
import fr.unistra.sil.erp.back.controller.ISubmitTransactionController;
import fr.unistra.sil.erp.back.db.DatabaseConnectionException;
-import fr.unistra.sil.erp.back.db.DatabaseInterface;
import fr.unistra.sil.erp.back.db.DatabaseResourceNotFoundException;
import fr.unistra.sil.erp.back.db.DatabaseUpdateException;
import fr.unistra.sil.erp.back.model.Stock;
@@ -26,6 +25,7 @@ import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
+import fr.unistra.sil.erp.back.db.IDatabase;
/**
* REST Controller for submitting transactions.
@@ -80,7 +80,7 @@ public class ApiSubmitTransactionController
if(!t.checkIfValid())
throw new ApiBadRequestException("Invalid JSON schema.");
- DatabaseInterface db;
+ IDatabase db;
Stock s;
try {
db = DatabaseSystem.getInstance();
diff --git a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseConnectionException.java b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseConnectionException.java
index 0ace8fd..cd4b82a 100644
--- a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseConnectionException.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseConnectionException.java
@@ -18,11 +18,11 @@ public class DatabaseConnectionException extends Exception {
/**
* Class constructor.
- * @param errMsg the error message.
+ * @param string the error message.
*/
- public DatabaseConnectionException(String errMsg)
+ public DatabaseConnectionException(String string)
{
- super(errMsg);
+ super(string);
}
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseResourceNotFoundException.java b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseResourceNotFoundException.java
index 9a34919..b570fb8 100644
--- a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseResourceNotFoundException.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseResourceNotFoundException.java
@@ -16,11 +16,11 @@ public class DatabaseResourceNotFoundException extends Exception {
/**
* Class constructor.
- * @param errMsg the error message.
+ * @param string the error message.
*/
- public DatabaseResourceNotFoundException(String errMsg)
+ public DatabaseResourceNotFoundException(String string)
{
- super(errMsg);
+ super(string);
}
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseSQLiteImpl.java b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseSQLiteImpl.java
index 5d94b89..2479947 100644
--- a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseSQLiteImpl.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseSQLiteImpl.java
@@ -26,7 +26,7 @@ import java.util.logging.Logger;
*
* @author BEAUVAIS ANTOINE
*/
-public class DatabaseSQLiteImpl implements DatabaseInterface {
+public class DatabaseSQLiteImpl implements IDatabase {
/**
* SQLite's connection string for the JDBC driver.
diff --git a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseUpdateException.java b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseUpdateException.java
index 465912e..60bd3ac 100644
--- a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseUpdateException.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/DatabaseUpdateException.java
@@ -17,11 +17,11 @@ public class DatabaseUpdateException extends Exception {
/**
* Class constructor.
- * @param errMsg the error message.
+ * @param string the error message.
*/
- public DatabaseUpdateException(String errMsg)
+ public DatabaseUpdateException(String string)
{
- super(errMsg);
+ super(string);
}
}
diff --git a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseInterface.java b/src/main/java/fr/unistra/sil/erp/back/db/IDatabase.java
similarity index 98%
rename from src/main/java/fr/unistra/sil/erp/back/db/DatabaseInterface.java
rename to src/main/java/fr/unistra/sil/erp/back/db/IDatabase.java
index 0fd55f5..0f9666b 100644
--- a/src/main/java/fr/unistra/sil/erp/back/db/DatabaseInterface.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/IDatabase.java
@@ -17,7 +17,7 @@ import java.util.List;
* implementations.
* @author BEAUVAIS ANTOINE
*/
-public interface DatabaseInterface {
+public interface IDatabase {
/**
* Returns the list of all items.
diff --git a/src/main/java/fr/unistra/sil/erp/back/interceptor/api/ApiAuthenticationInterceptor.java b/src/main/java/fr/unistra/sil/erp/back/interceptor/api/ApiAuthenticationInterceptor.java
index 5061c77..11435e6 100644
--- a/src/main/java/fr/unistra/sil/erp/back/interceptor/api/ApiAuthenticationInterceptor.java
+++ b/src/main/java/fr/unistra/sil/erp/back/interceptor/api/ApiAuthenticationInterceptor.java
@@ -30,11 +30,11 @@ public class ApiAuthenticationInterceptor implements HandlerInterceptor {
/**
* Class constructor.
- * @param apikey the API key.
+ * @param string the API key.
*/
- public ApiAuthenticationInterceptor(String apikey)
+ public ApiAuthenticationInterceptor(String string)
{
- this.apikey = apikey;
+ this.apikey = string;
}
/**
--
GitLab