javadoc, support configuration over hocon config

Author: kliushnichenko

modules/jooby-apt/src/main/java/io/jooby/apt/JoobyProcessor.java

@@ -385,7 +385,7 @@ private void verifyBeanValidationDependency(Collection<MvcRouter> routers) {
                 "Unable to load 'BeanValidator' class. " +
                 "Bean validation usage (@Valid) was detected, but the appropriate dependency is missing. " +
                 "Please ensure that you have added the corresponding validation dependency " +
-                "(e.g., jooby-hbv).");
+                "(e.g., jooby-hibernate-validator).");
       }
     }
   }

modules/jooby-hibernate-validator/src/main/java/io/jooby/hibernate/validator/HibernateValidatorModule.java

@@ -5,6 +5,7 @@
  */
 package io.jooby.hibernate.validator;
 
+import com.typesafe.config.Config;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.Extension;
 import io.jooby.Jooby;
@@ -22,8 +23,36 @@
 
 import static jakarta.validation.Validation.byProvider;
 
+/**
+ * Hibernate Validator Module: https://jooby.io/modules/hibernate-validator.
+ *
+ * <pre>{@code
+ * {
+ *   install(new HibernateValidatorModule());
+ *
+ * }
+ *
+ * public class Controller {
+ *
+ *   @POST("/create")
+ *   public void create(@Valid Bean bean) {
+ *   }
+ *
+ * }
+ * }</pre>
+ *
+ * <p>Supports validation of a single bean, list, array, or map.</p>
+ *
+ * <p>The module also provides a built-in error handler that catches {@link ConstraintViolationException}
+ * and transforms it into a {@link io.jooby.validation.ValidationResult}</p>
+ *
+ * @author kliushnichenko
+ * @since 3.2.10
+ */
 public class HibernateValidatorModule implements Extension {
 
+    private static final String CONFIG_ROOT_PATH = "hibernate.validator";
+
     private Consumer<HibernateValidatorConfiguration> configurer;
     private StatusCode statusCode = StatusCode.UNPROCESSABLE_ENTITY;
     private String title = "Validation failed";
@@ -79,14 +108,21 @@ public HibernateValidatorModule disableViolationHandler() {
     }
 
     @Override
-    public void install(@NonNull Jooby app) {
-        HibernateValidatorConfiguration cfg = byProvider(HibernateValidator.class).configure();
+    public void install(@NonNull Jooby app) throws Exception {
+        Config config = app.getConfig();
+        HibernateValidatorConfiguration hbvConfig = byProvider(HibernateValidator.class).configure();
+
+        if (config.hasPath(CONFIG_ROOT_PATH)) {
+            config.getConfig(CONFIG_ROOT_PATH)
+                    .root()
+                    .forEach((k, v) -> hbvConfig.addProperty(CONFIG_ROOT_PATH + "." + k, v.unwrapped().toString()));
+        }
 
         if (configurer != null) {
-            configurer.accept(cfg);
+            configurer.accept(hbvConfig);
         }
 
-        try (ValidatorFactory factory = cfg.buildValidatorFactory()) {
+        try (ValidatorFactory factory = hbvConfig.buildValidatorFactory()) {
             Validator validator = factory.getValidator();
             app.getServices().put(Validator.class, validator);
             app.getServices().put(MvcValidator.class, new MvcValidatorImpl(validator));
@@ -97,7 +133,7 @@ public void install(@NonNull Jooby app) {
         }
     }
 
-    static class MvcValidatorImpl implements MvcValidator<ConstraintViolationException> {
+    static class MvcValidatorImpl implements MvcValidator {
 
         private final Validator validator;
 
@@ -106,7 +142,7 @@ static class MvcValidatorImpl implements MvcValidator<ConstraintViolationExcepti
         }
 
         @Override
-        public void validate(Object bean) {
+        public void validate(Object bean) throws ConstraintViolationException {
             Set<ConstraintViolation<Object>> violations = validator.validate(bean);
             if (!violations.isEmpty()) {
                 throw new ConstraintViolationException(violations);

modules/jooby-validation/src/main/java/io/jooby/validation/BeanValidator.java

@@ -12,10 +12,16 @@
 import java.util.Collection;
 import java.util.Map;
 
+/**
+ * This class is a helper that provides a single entry point for bean validation without being strictly tied
+ * to a specific bean validation implementation. Initially, it is utilized in `jooby-apt` for MVC bean validation,
+ * but it can also be used independently in the scripting API.
+ * It relies on an implementation of {@link MvcValidator} that should be available in the service registry
+ */
 public final class BeanValidator {
 
     public static <T> T validate(Context ctx, T bean) {
-        MvcValidator<?> validator = ctx.require(MvcValidator.class);
+        MvcValidator validator = ctx.require(MvcValidator.class);
 
         if (bean instanceof Collection<?>) {
             validateCollection(validator, (Collection<?>) bean);
@@ -30,13 +36,13 @@ public static <T> T validate(Context ctx, T bean) {
         return bean;
     }
 
-    private static void validateCollection(MvcValidator<?> validator, Collection<?> beans) {
+    private static void validateCollection(MvcValidator validator, Collection<?> beans) {
         for (Object item : beans) {
             validateObject(validator, item);
         }
     }
 
-    private static void validateObject(MvcValidator<?> validator, Object bean) {
+    private static void validateObject(MvcValidator validator, Object bean) {
         try {
             validator.validate(bean);
         } catch (Throwable e) {

modules/jooby-validation/src/main/java/io/jooby/validation/MvcValidator.java

@@ -1,6 +1,17 @@
 package io.jooby.validation;
 
-public interface MvcValidator<E extends Throwable> {
+/**
+ * This interface should be implemented by modules that provide bean validation functionality.
+ * An instance of this interface must be registered in the Jooby service registry.
+ * Doing so will enable bean validation for MVC routes.
+ * For an example implementation, refer to the HibernateValidatorModule.
+ */
+public interface MvcValidator {
 
-    void validate(Object bean) throws E;
+    /**
+     * Method should validate the bean and throw an exception if any constraint violations are detected
+     * @param bean bean to be validated
+     * @throws RuntimeException an exception with violations to be thrown (e.g. ConstraintViolationException)
+     */
+    void validate(Object bean) throws RuntimeException;
 }