BAEL-9433 Example code for constraint validation (#18790)

Author: ashleyfrieze

spring-boot-modules/spring-boot-validation/pom.xml

@@ -30,6 +30,12 @@
             <groupId>com.h2database</groupId>
             <artifactId>h2</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/Application.java

@@ -0,0 +1,14 @@
+package com.baeldung.customstatefulvalidation;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+
+@SpringBootApplication
+@ConfigurationPropertiesScan
+public class Application {
+    
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/configuration/TenantChannels.java

@@ -0,0 +1,16 @@
+package com.baeldung.customstatefulvalidation.configuration;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties("com.baeldung.tenant")
+public class TenantChannels {
+    private String[] channels;
+
+    public String[] getChannels() {
+        return channels;
+    }
+
+    public void setChannels(String[] channels) {
+        this.channels = channels;
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/controllers/PurchaseOrderController.java

@@ -0,0 +1,19 @@
+package com.baeldung.customstatefulvalidation.controllers;
+
+import com.baeldung.customstatefulvalidation.model.PurchaseOrderItem;
+import jakarta.validation.Valid;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class PurchaseOrderController {
+
+    @PostMapping("/api/purchasing/")
+    public ResponseEntity<String> createPurchaseOrder(@Valid @RequestBody PurchaseOrderItem item) {
+        // start processing this purchase order and tell the caller we've accepted it
+
+        return ResponseEntity.accepted().build();
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/model/PurchaseOrderItem.java

@@ -0,0 +1,95 @@
+package com.baeldung.customstatefulvalidation.model;
+
+import com.baeldung.customstatefulvalidation.validators.AvailableChannel;
+import com.baeldung.customstatefulvalidation.validators.AvailableWarehouseRoute;
+import com.baeldung.customstatefulvalidation.validators.ChoosePacksOrIndividuals;
+import com.baeldung.customstatefulvalidation.validators.ProductCheckDigit;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Pattern;
+
+@ChoosePacksOrIndividuals
+@AvailableWarehouseRoute
+public class PurchaseOrderItem {
+
+    @ProductCheckDigit
+    @NotNull
+    @Pattern(regexp = "A-\\d{8}-\\d")
+    private String productId;
+
+    private String sourceWarehouse;
+    private String destinationCountry;
+
+    @AvailableChannel
+    private String tenantChannel;
+
+    private int numberOfIndividuals;
+    private int numberOfPacks;
+    private int itemsPerPack;
+
+    @org.hibernate.validator.constraints.UUID
+    private String clientUuid;
+
+    public String getProductId() {
+        return productId;
+    }
+
+    public void setProductId(String productId) {
+        this.productId = productId;
+    }
+
+    public String getSourceWarehouse() {
+        return sourceWarehouse;
+    }
+
+    public void setSourceWarehouse(String sourceWarehouse) {
+        this.sourceWarehouse = sourceWarehouse;
+    }
+
+    public String getDestinationCountry() {
+        return destinationCountry;
+    }
+
+    public void setDestinationCountry(String destinationCountry) {
+        this.destinationCountry = destinationCountry;
+    }
+
+    public String getTenantChannel() {
+        return tenantChannel;
+    }
+
+    public void setTenantChannel(String tenantChannel) {
+        this.tenantChannel = tenantChannel;
+    }
+
+    public int getNumberOfIndividuals() {
+        return numberOfIndividuals;
+    }
+
+    public void setNumberOfIndividuals(int numberOfIndividuals) {
+        this.numberOfIndividuals = numberOfIndividuals;
+    }
+
+    public int getNumberOfPacks() {
+        return numberOfPacks;
+    }
+
+    public void setNumberOfPacks(int numberOfPacks) {
+        this.numberOfPacks = numberOfPacks;
+    }
+
+    public int getItemsPerPack() {
+        return itemsPerPack;
+    }
+
+    public void setItemsPerPack(int itemsPerPack) {
+        this.itemsPerPack = itemsPerPack;
+    }
+
+    public String getClientUuid() {
+        return clientUuid;
+    }
+
+    public void setClientUuid(String clientUuid) {
+        this.clientUuid = clientUuid;
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/repository/WarehouseRouteRepository.java

@@ -0,0 +1,22 @@
+package com.baeldung.customstatefulvalidation.repository;
+
+import org.springframework.stereotype.Repository;
+
+import java.util.Set;
+import java.util.stream.Stream;
+
+import static java.util.stream.Collectors.toSet;
+
+@Repository
+public class WarehouseRouteRepository {
+    private Set<String> availableRoutes = Stream.of(
+            "Springfield:USA",
+            "Hartley:USA",
+            "Gentoo:PL",
+            "Mercury:GR")
+            .collect(toSet());
+
+    public boolean isWarehouseRouteAvailable(String sourceWarehouse, String destinationCountry) {
+        return availableRoutes.contains(sourceWarehouse + ":" + destinationCountry);
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/validators/AvailableChannel.java

@@ -0,0 +1,18 @@
+package com.baeldung.customstatefulvalidation.validators;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Constraint(validatedBy = AvailableChannelValidator.class)
+@Target({ ElementType.FIELD })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface AvailableChannel {
+    String message() default "must be available tenant channel";
+    Class<?>[] groups() default {};
+    Class<? extends Payload>[] payload() default {};
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/validators/AvailableChannelValidator.java

@@ -0,0 +1,30 @@
+package com.baeldung.customstatefulvalidation.validators;
+
+import com.baeldung.customstatefulvalidation.configuration.TenantChannels;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.IntStream;
+
+import static java.util.stream.Collectors.toSet;
+
+public class AvailableChannelValidator implements ConstraintValidator<AvailableChannel, String> {
+
+    @Autowired
+    private TenantChannels tenantChannels;
+
+    private Set<String> channels;
+
+    @Override
+    public void initialize(AvailableChannel constraintAnnotation) {
+        channels = Arrays.stream(tenantChannels.getChannels()).collect(toSet());
+    }
+
+    @Override
+    public boolean isValid(String value, ConstraintValidatorContext context) {
+        return channels.contains(value);
+    }
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/validators/AvailableWarehouseRoute.java

@@ -0,0 +1,18 @@
+package com.baeldung.customstatefulvalidation.validators;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Constraint(validatedBy = AvailableWarehouseRouteValidator.class)
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface AvailableWarehouseRoute {
+    String message() default "chosen warehouse route must be active";
+    Class<?>[] groups() default {};
+    Class<? extends Payload>[] payload() default {};
+}

spring-boot-modules/spring-boot-validation/src/main/java/com/baeldung/customstatefulvalidation/validators/AvailableWarehouseRouteValidator.java

@@ -0,0 +1,17 @@
+package com.baeldung.customstatefulvalidation.validators;
+
+import com.baeldung.customstatefulvalidation.model.PurchaseOrderItem;
+import com.baeldung.customstatefulvalidation.repository.WarehouseRouteRepository;
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+import org.springframework.beans.factory.annotation.Autowired;
+
+public class AvailableWarehouseRouteValidator implements ConstraintValidator<AvailableWarehouseRoute, PurchaseOrderItem> {
+    @Autowired
+    private WarehouseRouteRepository warehouseRouteRepository;
+
+    @Override
+    public boolean isValid(PurchaseOrderItem value, ConstraintValidatorContext context) {
+        return warehouseRouteRepository.isWarehouseRouteAvailable(value.getSourceWarehouse(), value.getDestinationCountry());
+    }
+}