AYS-523 | Architecture Has Been Refactored and Sonar Issuses Have Been Fixed

README.md

@@ -287,12 +287,14 @@ at org.eclipse.angus.mail.smtp.SMTPTransport$Authenticator.authenticate(SMTPTran
 > details: https://www.jetbrains.com/help/idea/run-debug-configuration-spring-boot.html#spring-boot
 ---
 
-# Project Infrastucture
+# Project Infrastructure
 
-## 🏛️ Layer Architecture
+## 🏛️ HexaLayered Architecture
 
 ![](/documents/architecture/ays-architecture.png?raw=true)
 
+> **Reference: [HexaLayered Architecture](https://github.com/agitrubard/hexalayered-architecture)**
+
 ## 📦 Package Architecture
 
 ![](/documents/architecture/package-architecture-example.png?raw=true)

src/main/java/org/ays/auth/util/exception/AysAdminRegistrationApplicationAlreadyApprovedException.java → src/main/java/org/ays/auth/exception/AysAdminRegistrationApplicationAlreadyApprovedException.java

@@ -1,18 +1,18 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import org.ays.auth.model.enums.AdminRegistrationApplicationStatus;
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception indicating that an admin registration application is already approved.
- * This exception is a subclass of {@link AysAlreadyException}, which is typically used to indicate that an entity or
+ * This exception is a subclass of {@link AysConflictException}, which is typically used to indicate that an entity or
  * resource already exists with expected behaviour.
  * Typically, this exception is thrown when an approval operation is performed on an admin register application
  * entity to an already approved or rejected admin register application.
  */
-public class AysAdminRegistrationApplicationAlreadyApprovedException extends AysAlreadyException {
+public final class AysAdminRegistrationApplicationAlreadyApprovedException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysAdminRegistrationApplicationAlreadyRejectedException.java → src/main/java/org/ays/auth/exception/AysAdminRegistrationApplicationAlreadyRejectedException.java

@@ -1,17 +1,17 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception indicating that an admin registration application is already rejected.
- * This exception is a subclass of {@link AysAlreadyException}, which is typically used to indicate that an entity or
+ * This exception is a subclass of {@link AysConflictException}, which is typically used to indicate that an entity or
  * resource already exists with expected behaviour.
  * Typically, this exception is thrown when a rejection operation is performed on an admin register application
  * entity to an already rejected admin register application.
  */
-public class AysAdminRegistrationApplicationAlreadyRejectedException extends AysAlreadyException {
+public final class AysAdminRegistrationApplicationAlreadyRejectedException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysAdminRegistrationApplicationInCompleteException.java → src/main/java/org/ays/auth/exception/AysAdminRegistrationApplicationInCompleteException.java

@@ -1,7 +1,7 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import org.ays.auth.model.enums.AdminRegistrationApplicationStatus;
-import org.ays.common.util.exception.AysBadRequestException;
+import org.ays.common.exception.AysBadRequestException;
 
 import java.io.Serial;
 
@@ -12,7 +12,7 @@
  * Typically, this exception is thrown when a rejection operation is performed on an admin register application
  * entity to an incomplete application, where its status is not set to 'COMPLETE'.
  */
-public class AysAdminRegistrationApplicationInCompleteException extends AysBadRequestException {
+public final class AysAdminRegistrationApplicationInCompleteException extends AysBadRequestException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AdminRegistrationApplicationNotExistException.java → src/main/java/org/ays/auth/exception/AysAdminRegistrationApplicationNotExistByIdAuthException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 
@@ -10,20 +10,20 @@
  * Typically, this exception is thrown when an operation or query is performed on an admin register application
  * entity using an ID that does not correspond to an existing admin register application.
  */
-public final class AdminRegistrationApplicationNotExistException extends AysAuthException {
+public final class AysAdminRegistrationApplicationNotExistByIdAuthException extends AysAuthException {
 
     /**
      * Unique identifier for serialization.
      */
     @Serial
-    private static final long serialVersionUID = 8875043711494901525L;
+    private static final long serialVersionUID = -6284753696808049193L;
 
     /**
-     * Constructs a new {@link AdminRegistrationApplicationNotExistException} with the specified ID.
+     * Constructs a new {@link AysAdminRegistrationApplicationNotExistByIdAuthException} with the specified ID.
      *
      * @param id The ID of the admin registration application that does not exist.
      */
-    public AdminRegistrationApplicationNotExistException(String id) {
+    public AysAdminRegistrationApplicationNotExistByIdAuthException(String id) {
         super("admin registration application does not exist! id:" + id);
     }
 

src/main/java/org/ays/auth/util/exception/AdminRegistrationApplicationNotExistByIdException.java → src/main/java/org/ays/auth/exception/AysAdminRegistrationApplicationNotExistByIdException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 
@@ -11,20 +11,20 @@
  * Typically, this exception is thrown when an operation or query is performed on an admin register application
  * entity using an ID that does not correspond to an existing admin register application.
  */
-public final class AdminRegistrationApplicationNotExistByIdException extends AysNotExistException {
+public final class AysAdminRegistrationApplicationNotExistByIdException extends AysNotExistException {
 
     /**
      * Unique identifier for serialization.
      */
     @Serial
-    private static final long serialVersionUID = 8416712253227498925L;
+    private static final long serialVersionUID = -2626144009258745267L;
 
     /**
-     * Constructs a new {@link AdminRegistrationApplicationNotExistByIdException} with the specified ID.
+     * Constructs a new {@link AysAdminRegistrationApplicationNotExistByIdException} with the specified ID.
      *
      * @param id The ID of the admin registration application that does not exist.
      */
-    public AdminRegistrationApplicationNotExistByIdException(String id) {
+    public AysAdminRegistrationApplicationNotExistByIdException(String id) {
         super("admin registration application not exist! id:" + id);
     }
 

src/main/java/org/ays/auth/util/exception/AysEmailAddressNotValidException.java → src/main/java/org/ays/auth/exception/AysEmailAddressNotValidException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysInvalidRoleStatusException.java → src/main/java/org/ays/auth/exception/AysInvalidRoleStatusException.java

@@ -1,7 +1,7 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import org.ays.auth.model.enums.AysRoleStatus;
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysKeyReadException.java → src/main/java/org/ays/auth/exception/AysKeyReadException.java

@@ -1,4 +1,4 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysPasswordNotValidException.java → src/main/java/org/ays/auth/exception/AysPasswordNotValidException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysPermissionNotExistException.java → src/main/java/org/ays/auth/exception/AysPermissionNotExistException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 import java.util.List;

src/main/java/org/ays/auth/util/exception/AysRoleAlreadyDeletedException.java → src/main/java/org/ays/auth/exception/AysRoleAlreadyDeletedException.java

@@ -1,13 +1,13 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception thrown when a role is deleted and attempting to perform an action that requires a deleted role.
  */
-public final class AysRoleAlreadyDeletedException extends AysAlreadyException {
+public final class AysRoleAlreadyDeletedException extends AysConflictException {
 
     /**
      * Unique serial version ID.

src/main/java/org/ays/auth/util/exception/AysRoleAlreadyExistsByNameException.java → src/main/java/org/ays/auth/exception/AysRoleAlreadyExistsByNameException.java

@@ -1,13 +1,13 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception to be thrown when a role with a given name already exists.
  */
-public final class AysRoleAlreadyExistsByNameException extends AysAlreadyException {
+public final class AysRoleAlreadyExistsByNameException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysRoleAssignedToUserException.java → src/main/java/org/ays/auth/exception/AysRoleAssignedToUserException.java

@@ -1,13 +1,13 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception thrown when a role is deleted and attempting to perform an action that requires a deleted role.
  */
-public class AysRoleAssignedToUserException extends AysAlreadyException {
+public class AysRoleAssignedToUserException extends AysConflictException {
 
     /**
      * Unique serial version ID.

src/main/java/org/ays/auth/util/exception/AysRoleNotExistByIdException.java → src/main/java/org/ays/auth/exception/AysRoleNotExistByIdException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysRolesNotExistException.java → src/main/java/org/ays/auth/exception/AysRolesNotExistException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 import java.util.List;

src/main/java/org/ays/auth/util/exception/AysTokenAlreadyInvalidatedException.java → src/main/java/org/ays/auth/exception/AysTokenAlreadyInvalidatedException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysTokenNotValidException.java → src/main/java/org/ays/auth/exception/AysTokenNotValidException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysUserAlreadyDeletedException.java → src/main/java/org/ays/auth/exception/AysUserAlreadyDeletedException.java

@@ -1,13 +1,13 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception thrown when a user is deleted and attempting to perform an action that requires a deleted user.
  */
-public final class AysUserAlreadyDeletedException extends AysAlreadyException {
+public final class AysUserAlreadyDeletedException extends AysConflictException {
 
     /**
      * Unique serial version ID.

src/main/java/org/ays/auth/util/exception/AysUserAlreadyExistsByEmailAddressException.java → src/main/java/org/ays/auth/exception/AysUserAlreadyExistsByEmailAddressException.java

@@ -1,14 +1,14 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception indicating that an user already exists with the specified email address.
- * This exception is a subclass of {@link AysAlreadyException}.
+ * This exception is a subclass of {@link AysConflictException}.
  */
-public final class AysUserAlreadyExistsByEmailAddressException extends AysAlreadyException {
+public final class AysUserAlreadyExistsByEmailAddressException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysUserAlreadyExistsByPhoneNumberException.java → src/main/java/org/ays/auth/exception/AysUserAlreadyExistsByPhoneNumberException.java

@@ -1,14 +1,14 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
+import org.ays.common.exception.AysConflictException;
 import org.ays.common.model.AysPhoneNumber;
-import org.ays.common.util.exception.AysAlreadyException;
 
 import java.io.Serial;
 
 /**
  * This exception is thrown when attempting to create a user with a phone number that already exists in the system.
  */
-public final class AysUserAlreadyExistsByPhoneNumberException extends AysAlreadyException {
+public final class AysUserAlreadyExistsByPhoneNumberException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysUserDoesNotAccessPageException.java → src/main/java/org/ays/auth/exception/AysUserDoesNotAccessPageException.java

@@ -1,7 +1,7 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import org.ays.auth.model.enums.AysSourcePage;
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysUserIdNotValidException.java → src/main/java/org/ays/auth/exception/AysUserIdNotValidException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysUserIsNotActiveOrPassiveException.java → src/main/java/org/ays/auth/exception/AysUserIsNotActiveOrPassiveException.java

@@ -1,13 +1,13 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAlreadyException;
+import org.ays.common.exception.AysConflictException;
 
 import java.io.Serial;
 
 /**
  * Exception to be thrown when a user has a status which is not active or passive.
  */
-public final class AysUserIsNotActiveOrPassiveException extends AysAlreadyException {
+public final class AysUserIsNotActiveOrPassiveException extends AysConflictException {
 
     /**
      * Unique identifier for serialization.

src/main/java/org/ays/auth/util/exception/AysUserNotActiveException.java → src/main/java/org/ays/auth/exception/AysUserNotActiveException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysAuthException;
+import org.ays.common.exception.AysAuthException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysUserNotExistByIdException.java → src/main/java/org/ays/auth/exception/AysUserNotExistByIdException.java

@@ -1,6 +1,6 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;
 

src/main/java/org/ays/auth/util/exception/AysUserNotPassiveException.java → src/main/java/org/ays/auth/exception/AysUserNotPassiveException.java

@@ -1,7 +1,7 @@
-package org.ays.auth.util.exception;
+package org.ays.auth.exception;
 
 import org.ays.auth.model.enums.AysUserStatus;
-import org.ays.common.util.exception.AysNotExistException;
+import org.ays.common.exception.AysNotExistException;
 
 import java.io.Serial;