add basic validators

Author: SirCotare

.idea/encodings.xml

@@ -3,17 +3,56 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>3.3.2</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+
     <groupId>it.aboutbits</groupId>
     <artifactId>spring-boot-toolbox</artifactId>
     <version>BUILD-SNAPSHOT</version>
     <description>Utility library for Spring Boot projects.</description>
+    <packaging>jar</packaging>
 
     <properties>
         <java.version>21</java.version>
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+
+        <!-- Utilities -->
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <!-- Password validation -->
+        <!-- https://mvnrepository.com/artifact/org.passay/passay -->
+        <dependency>
+            <groupId>org.passay</groupId>
+            <artifactId>passay</artifactId>
+            <version>1.6.5</version>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.jetbrains/annotations -->
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>24.1.0</version>
+        </dependency>
 
+        <!-- Testing -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

pom.xml

@@ -0,0 +1,28 @@
+package it.aboutbits.springboot.toolbox.validation.enumeration;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Documented
+@Constraint(validatedBy = ValidEnumValidator.class)
+@Target({FIELD, ANNOTATION_TYPE})
+@Retention(RUNTIME)
+public @interface ValidEnum {
+
+    String message() default "{shared.error.validation.invalidEnum}";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+
+    Class<? extends Enum<?>> enumClass();
+
+}

src/main/java/it/aboutbits/springboot/toolbox/validation/enumeration/ValidEnum.java

@@ -0,0 +1,30 @@
+package it.aboutbits.springboot.toolbox.validation.enumeration;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+
+import java.util.HashSet;
+import java.util.Set;
+
+public class ValidEnumValidator implements ConstraintValidator<ValidEnum, String> {
+    private Set<String> enumValues;
+
+    @Override
+    public void initialize(ValidEnum validEnum) {
+        var enumClass = validEnum.enumClass();
+
+        enumValues = new HashSet<>();
+        for (Enum<?> anEnum : enumClass.getEnumConstants()) {
+            enumValues.add(anEnum.name());
+        }
+    }
+
+    @Override
+    public boolean isValid(String value, ConstraintValidatorContext context) {
+        if (value == null) {
+            return true;
+        }
+
+        return enumValues.contains(value);
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/validation/enumeration/ValidEnumValidator.java

@@ -0,0 +1,26 @@
+package it.aboutbits.springboot.toolbox.validation.password;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Documented
+@Constraint(validatedBy = ValidPasswordValidator.class)
+@Target({FIELD, ANNOTATION_TYPE})
+@Retention(RUNTIME)
+public @interface ValidPassword {
+    String message() default "{shared.error.validation.invalidPassword}";
+
+    String lengthMessage() default "{shared.error.validation.invalidPassword.length}";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+}

src/main/java/it/aboutbits/springboot/toolbox/validation/password/ValidPassword.java

@@ -0,0 +1,56 @@
+package it.aboutbits.springboot.toolbox.validation.password;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+import org.passay.LengthRule;
+import org.passay.PasswordData;
+import org.passay.PasswordValidator;
+import org.passay.RuleResultDetail;
+
+import java.util.List;
+
+public class ValidPasswordValidator implements ConstraintValidator<ValidPassword, String> {
+    private String message;
+    private String lengthMessage;
+
+    @Override
+    public void initialize(ValidPassword constraintAnnotation) {
+        this.message = constraintAnnotation.message();
+        this.lengthMessage = constraintAnnotation.lengthMessage();
+    }
+
+    @Override
+    public boolean isValid(String password, ConstraintValidatorContext context) {
+        if (password == null) {
+            return true;
+        }
+
+        var validator = new PasswordValidator(List.of(
+                // at least 8 characters
+                new LengthRule(8, 50)
+        ));
+
+        var result = validator.validate(new PasswordData(password));
+
+        if (!password.isBlank() && result.isValid()) {
+            return true;
+        }
+        context.disableDefaultConstraintViolation();
+        context.buildConstraintViolationWithTemplate(getMessageTemplate(result.getDetails()))
+                .addConstraintViolation();
+
+        return false;
+    }
+
+    private String getMessageTemplate(List<RuleResultDetail> ruleResultDetails) {
+        if (ruleResultDetails.isEmpty()) {
+            return message;
+        }
+
+        return switch (ruleResultDetails.getFirst().getErrorCode()) {
+            case "TOO_SHORT" -> lengthMessage;
+            case "TOO_LONG" -> lengthMessage;
+            default -> message;
+        };
+    }
+}