org.jooby.hbv

Class Hbv

java.lang.Object

org.jooby.hbv.Hbv

All Implemented Interfaces:

Jooby.Module

public class Hbv
extends Object
implements Jooby.Module

Bean validation via Hibernate Validator.

exposes

• a Validator,
• a HibernateValidatorConfiguration and
• a Parser

usage

 {
   use(new Hbv());

   get("/", req  -> {
     Validator validator = req.require(Validator.class);
     Car car = req.params().to(Car.class);
     Set<ConstraintViolation> violations = validator.validate(car);
     if (violations.size()  > 0) {
       // handle errors
       ...
     }
   });
 }
 

automatic validations of HTTP params and body

Previous example demonstrate how to manually validate a bean created via: Request.params() or Request.body(). The boilerplate code can be avoided if you explicitly tell the validation module which classes require validation. The previous example can be rewritten as:

 {
    use(new Hbv(Car.class));

    get("/", ()  -> {
      Car car = req.params().to(Car.class);
      // a valid car is here
      ...
    });
 }
 

Here a Parser will do the boilerplate part and throws a ConstraintViolationException.

rendering a ConstraintViolationException

The default err handler will render the ConstraintViolationException without problem, but suppose we have a JavaScript client and want to display the errors in a friendly way.

 {
   use(new Jackson()); // JSON renderer

   use(new Hbv(Car.class)); // Validate Car objects

   err((req, rsp, err)  -> {
     Throwable cause = err.getCause();
     if (cause instanceof ConstraintViolationException) {
       Set<ConstraintViolation<?>> constraints =
           ((ConstraintViolationException) cause) .getConstraintViolations();

       Map<Path, String> errors = constraints.stream()
          .collect(Collectors.toMap(
              ConstraintViolation::getPropertyPath,
              ConstraintViolation::getMessage
           ));
       rsp.send(errors);
     }
   });

   get("/", ()  -> {
     Car car = req.params().to(Car.class);
     // a valid car is here
     ...
   });
 }

The call to rsp.send(errors); will be rendered by ```Jackson``` (or any other that applies) and will produces a more friendly response, here it will be a JavaScript object with the errors.

constraint validator factory

ConstraintValidatorFactory is the extension point for customizing how constraint validators are instantiated and released. In Jooby, a ConstraintValidatorFactory is powered by Guice.

configuration

Any property defined at hibernate.validator will be add it automatically: application.conf:

 hibernate.validator.fail_fast = true
 

Or programmatically:

 {
   use(new Hbv().doWith(config  -> {
     config.failFast(true);
   }));
 }
 

Since:

0.6.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Hbv() Creates a new Hbv module.
Hbv(Class<?>... classes) Creates a new Hbv module.
Hbv(Predicate<com.google.inject.TypeLiteral<?>> predicate) Creates a new Hbv module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Hbv	doWith(BiConsumer<org.hibernate.validator.HibernateValidatorConfiguration,com.typesafe.config.Config> configurer) Setup a configurer callback.
Hbv	doWith(Consumer<org.hibernate.validator.HibernateValidatorConfiguration> configurer) Setup a configurer callback.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Hbv

public Hbv(Predicate<com.google.inject.TypeLiteral<?>> predicate)

Creates a new Hbv module.

Parameters:

predicate - A predicate to test if a class require validation or not.

Hbv

public Hbv(Class<?>... classes)

Creates a new Hbv module.

Parameters:

classes - List of classes that require validation.

Hbv

public Hbv()

Creates a new Hbv module. No automatic validation is applied.

Method Detail

doWith

public Hbv doWith(Consumer<org.hibernate.validator.HibernateValidatorConfiguration> configurer)

Setup a configurer callback.

Parameters:

configurer - Configurer callback.

Returns:

This module.

doWith

public Hbv doWith(BiConsumer<org.hibernate.validator.HibernateValidatorConfiguration,com.typesafe.config.Config> configurer)

Setup a configurer callback.

Parameters:

configurer - Configurer callback.

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module