Module io.jooby.hibernate.validator
Package io.jooby.hibernate.validator

Class HibernateValidatorModule

java.lang.Object
io.jooby.hibernate.validator.HibernateValidatorModule
All Implemented Interfaces:
Extension
public class HibernateValidatorModule extends Object implements Extension
Hibernate Validator Module: https://jooby.io/modules/hibernate-validator. 

 {
   install(new HibernateValidatorModule());

 }

 public class Controller {

   @POST("/create")
   public void create(@Valid Bean bean) {
   }

 }

Supports validation of a single bean, list, array, or map.

The module also provides a built-in error handler that catches ConstraintViolationException and transforms it into a ValidationResult.

When ProblemDetails is enabled ValidationResult transformed to compliant response, see HttpProblem

Since:
3.3.1
Author:
kliushnichenko

  • Constructor Details

    • HibernateValidatorModule

      public HibernateValidatorModule(@NonNull org.hibernate.validator.HibernateValidatorConfiguration configuration)

    • HibernateValidatorModule

      public HibernateValidatorModule()

  • Method Details

    • doWith

      @Deprecated public HibernateValidatorModule doWith(@NonNull Consumer<org.hibernate.validator.HibernateValidatorConfiguration> configurer)
      Deprecated.
      Use HibernateValidatorModule(HibernateValidatorConfiguration)
      Setups a configurer callback.
      Parameters:
      configurer - Configurer callback.
      Returns:
      This module.

    • statusCode

      public HibernateValidatorModule statusCode(@NonNull StatusCode statusCode)
      Overrides the default status code for the errors produced by validation. Default code is UNPROCESSABLE_ENTITY(422)
      Parameters:
      statusCode - new status code
      Returns:
      This module.

    • logException

      public HibernateValidatorModule logException()
      Ask the error handler to log the exception. Default is: false.
      Returns:
      This module.

    • validationTitle

      public HibernateValidatorModule validationTitle(@NonNull String title)
      Overrides the default title for the errors produced by validation. Default title is "Validation failed"
      Parameters:
      title - new title
      Returns:
      This module.

    • disableViolationHandler

      public HibernateValidatorModule disableViolationHandler()
      Disables default constraint violation handler. By default HibernateValidatorModule provides built-in error handler for the ConstraintViolationException Such exceptions are transformed into response of ValidationResult Use this flag to disable default error handler and provide your custom.
      Returns:
      This module.

    • with

      public HibernateValidatorModule with(jakarta.validation.ConstraintValidatorFactory factory)
      Add a custom ConstraintValidatorFactory. This factory is allowed to returns null allowing next factory to create an instance (default or one provided by DI).
      Parameters:
      factory - Factory.
      Returns:
      This module.

    • install

      public void install(@NonNull Jooby app) throws Exception
      Specified by:
      install in interface Extension
      Throws:
      Exception