Merge pull request #148 from /issues/146-refactor-structure

Fix #146: Refactor package and class structure

src/main/java/com/wultra/security/userdatastore/AuditConfiguration.java → src/main/java/com/wultra/security/userdatastore/config/AuditConfiguration.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.config;
 
 import com.wultra.core.audit.base.Audit;
 import com.wultra.core.audit.base.AuditFactory;

src/main/java/com/wultra/security/userdatastore/OpenApiConfiguration.java → src/main/java/com/wultra/security/userdatastore/config/OpenApiConfiguration.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.config;
 
 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
 import io.swagger.v3.oas.annotations.info.Contact;

src/main/java/com/wultra/security/userdatastore/SecurityConfiguration.java → src/main/java/com/wultra/security/userdatastore/config/SecurityConfiguration.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.config;
 
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.annotation.Bean;

src/main/java/com/wultra/security/userdatastore/WebSecurityConfiguration.java → src/main/java/com/wultra/security/userdatastore/config/WebSecurityConfiguration.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.config;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;

src/main/java/com/wultra/security/userdatastore/HomeController.java → src/main/java/com/wultra/security/userdatastore/controller/HomeController.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.controller;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.info.BuildProperties;
@@ -32,7 +32,7 @@
 @Controller
 class HomeController {
 
-    private BuildProperties buildProperties;
+    private final BuildProperties buildProperties;
 
     public HomeController(@Autowired(required = false) final BuildProperties buildProperties) {
         this.buildProperties = buildProperties;

src/main/java/com/wultra/security/userdatastore/userclaims/UserClaimsController.java → src/main/java/com/wultra/security/userdatastore/controller/UserClaimsController.java

@@ -15,8 +15,12 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.controller;
 
+import com.wultra.security.userdatastore.model.error.ClaimNotFoundException;
+import com.wultra.security.userdatastore.model.error.EncryptionException;
+import com.wultra.security.userdatastore.model.error.InvalidRequestException;
+import com.wultra.security.userdatastore.service.UserClaimsService;
 import io.getlime.core.rest.model.base.response.ErrorResponse;
 import io.getlime.core.rest.model.base.response.ObjectResponse;
 import io.getlime.core.rest.model.base.response.Response;
@@ -59,14 +63,14 @@ public ErrorResponse handleInvalidRequestException(final RuntimeException e) {
     }
 
     /**
-     * Exception handler for {@link NotFoundException}.
+     * Exception handler for {@link ClaimNotFoundException}.
      *
      * @param e Exception.
      * @return Response with error details.
      */
-    @ExceptionHandler(NotFoundException.class)
+    @ExceptionHandler(ClaimNotFoundException.class)
     @ResponseStatus(HttpStatus.BAD_REQUEST)
-    public ErrorResponse handleNotFoundException(final NotFoundException e) {
+    public ErrorResponse handleNotFoundException(final ClaimNotFoundException e) {
         logger.warn("Error occurred when processing request object.", e);
         return new ErrorResponse("NOT_FOUND", e.getMessage());
     }

src/main/java/com/wultra/security/userdatastore/DefaultExceptionHandler.java → src/main/java/com/wultra/security/userdatastore/errorhandling/DefaultExceptionHandler.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore;
+package com.wultra.security.userdatastore.errorhandling;
 
 import io.getlime.core.rest.model.base.response.ErrorResponse;
 import lombok.extern.slf4j.Slf4j;
@@ -33,7 +33,7 @@
  */
 @ControllerAdvice
 @Slf4j
-public class DefaultExceptionHandler {
+class DefaultExceptionHandler {
 
     /**
      * Exception handler for no resource found.

src/main/java/com/wultra/security/userdatastore/userclaims/EncryptionMode.java → src/main/java/com/wultra/security/userdatastore/model/entity/EncryptionMode.java

@@ -15,14 +15,14 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.entity;
 
 /**
  * Encryption mode.
  *
  * @author Lubos Racansky, [email protected]
  */
-enum EncryptionMode {
+public enum EncryptionMode {
 
     /**
      * No encryption.
@@ -32,5 +32,5 @@ enum EncryptionMode {
     /**
      * AES encryption with HMAC-based index.
      */
-    AES_HMAC;
+    AES_HMAC
 }

src/main/java/com/wultra/security/userdatastore/userclaims/UserClaimsEntity.java → src/main/java/com/wultra/security/userdatastore/model/entity/UserClaimsEntity.java

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.entity;
 
 import jakarta.persistence.*;
 import lombok.Getter;
@@ -33,7 +33,7 @@
 @Table(name = "uds_user_claims")
 @Getter
 @Setter
-class UserClaimsEntity {
+public class UserClaimsEntity {
 
     @Id
     private String userId;

src/main/java/com/wultra/security/userdatastore/userclaims/NotFoundException.java → src/main/java/com/wultra/security/userdatastore/model/error/ClaimNotFoundException.java

@@ -15,27 +15,27 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.error;
 
 /**
- * Exception to be thrown when the requested entity is not found.
+ * Exception to be thrown when the requested claim is not found.
  *
  * @author Lubos Racansky, [email protected]
  */
-class NotFoundException extends RuntimeException {
+public class ClaimNotFoundException extends RuntimeException {
 
     /**
      * No-arg constructor.
      */
-    public NotFoundException() {
+    public ClaimNotFoundException() {
     }
 
     /**
      * Constructs a new exception with the specified message.
      *
      * @param message message
      */
-    public NotFoundException(String message) {
+    public ClaimNotFoundException(String message) {
         super(message);
     }
 
@@ -44,7 +44,7 @@ public NotFoundException(String message) {
      *
      * @param cause cause
      */
-    public NotFoundException(Throwable cause) {
+    public ClaimNotFoundException(Throwable cause) {
         super(cause);
     }
 }

src/main/java/com/wultra/security/userdatastore/userclaims/EncryptionException.java → src/main/java/com/wultra/security/userdatastore/model/error/EncryptionException.java

@@ -15,14 +15,14 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.error;
 
 /**
  * Exception to be thrown when there is a problem at encryption layer.
  *
  * @author Lubos Racansky, [email protected]
  */
-class EncryptionException extends RuntimeException {
+public class EncryptionException extends RuntimeException {
 
     /**
      * No-arg constructor.

src/main/java/com/wultra/security/userdatastore/userclaims/InvalidRequestException.java → src/main/java/com/wultra/security/userdatastore/model/error/InvalidRequestException.java

@@ -15,14 +15,14 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.error;
 
 /**
  * Exception to be thrown when the user's request is invalid.
  *
  * @author Lubos Racansky, [email protected]
  */
-class InvalidRequestException extends RuntimeException {
+public class InvalidRequestException extends RuntimeException {
 
     /**
      * No-arg constructor.

src/main/java/com/wultra/security/userdatastore/userclaims/UserClaimsRepository.java → src/main/java/com/wultra/security/userdatastore/model/repository/UserClaimsRepository.java

@@ -15,8 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.model.repository;
 
+import com.wultra.security.userdatastore.model.entity.UserClaimsEntity;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
@@ -26,6 +27,6 @@
  * @author Lubos Racansky [email protected]
  */
 @Repository
-interface UserClaimsRepository extends JpaRepository<UserClaimsEntity, String> {
+public interface UserClaimsRepository extends JpaRepository<UserClaimsEntity, String> {
 
 }

src/main/java/com/wultra/security/userdatastore/userclaims/EncryptionService.java → src/main/java/com/wultra/security/userdatastore/service/EncryptionService.java

@@ -15,8 +15,11 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.service;
 
+import com.wultra.security.userdatastore.model.entity.EncryptionMode;
+import com.wultra.security.userdatastore.model.entity.UserClaimsEntity;
+import com.wultra.security.userdatastore.model.error.EncryptionException;
 import io.getlime.security.powerauth.crypto.lib.generator.KeyGenerator;
 import io.getlime.security.powerauth.crypto.lib.model.exception.CryptoProviderException;
 import io.getlime.security.powerauth.crypto.lib.model.exception.GenericCryptoException;

src/main/java/com/wultra/security/userdatastore/userclaims/UserClaimsService.java → src/main/java/com/wultra/security/userdatastore/service/UserClaimsService.java

@@ -15,13 +15,17 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.service;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.wultra.core.audit.base.Audit;
 import com.wultra.core.audit.base.model.AuditDetail;
+import com.wultra.security.userdatastore.model.entity.UserClaimsEntity;
+import com.wultra.security.userdatastore.model.error.ClaimNotFoundException;
+import com.wultra.security.userdatastore.model.error.InvalidRequestException;
+import com.wultra.security.userdatastore.model.repository.UserClaimsRepository;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.core.context.SecurityContextHolder;
@@ -38,7 +42,7 @@
 @Service
 @Transactional
 @Slf4j
-class UserClaimsService {
+public class UserClaimsService {
 
     private final UserClaimsRepository userClaimsRepository;
 
@@ -60,7 +64,7 @@ public Object fetchUserClaims(final String userId) {
         final String claims = userClaimsRepository.findById(userId)
                 .map(encryptionService::decryptClaims)
                 .orElseThrow(() ->
-                        new NotFoundException("Claims for user ID: '%s' not found".formatted(userId)));
+                        new ClaimNotFoundException("Claims for user ID: '%s' not found".formatted(userId)));
         audit("Retrieved claims of user ID: {}", userId);
         try {
             return objectMapper.readValue(claims, new TypeReference<>() {});

src/test/java/com/wultra/security/userdatastore/userclaims/UserClaimsControllerTest.java → src/test/java/com/wultra/security/userdatastore/controller/UserClaimsControllerTest.java

@@ -15,9 +15,10 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.controller;
 
-import com.wultra.security.userdatastore.WebSecurityConfiguration;
+import com.wultra.security.userdatastore.config.WebSecurityConfiguration;
+import com.wultra.security.userdatastore.service.UserClaimsService;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;

src/test/java/com/wultra/security/userdatastore/userclaims/EncryptionServiceTest.java → src/test/java/com/wultra/security/userdatastore/service/EncryptionServiceTest.java

@@ -15,8 +15,10 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package com.wultra.security.userdatastore.userclaims;
+package com.wultra.security.userdatastore.service;
 
+import com.wultra.security.userdatastore.model.entity.EncryptionMode;
+import com.wultra.security.userdatastore.model.entity.UserClaimsEntity;
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;