Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 5.8 KB

README.md

File metadata and controls

100 lines (70 loc) · 5.8 KB

Hibernate Validator

Version: 9.0.0.CR1 - 2024-12-13

Maven Central Build Status Sonar Coverage Quality gate Develocity Reproducible Builds

What is it?

This is the reference implementation of Jakarta Validation 3.1. Jakarta Validation defines a metadata model and API for JavaBean as well as method validation. The default metadata source are annotations, with the ability to override and extend the metadata through the use of XML validation descriptors.

Documentation

The documentation for this release is included in the docs directory of the distribution package or can be accessed online.

Release Notes

The full list of changes for this release can be found in changelog.txt.

System Requirements

JDK 17 or above.

Using Hibernate Validator

  • In case you use the distribution archive from the download site, copy dist/hibernate-validator-<version>.jar together with all jar files from dist/lib/required into the classpath of your application. For the purposes of logging, Hibernate Validator uses the JBoss Logging API, an abstraction layer which supports several logging solutions such (e.g. log4j or the logging framework provided by the JDK) as implementation. Just add a supported logging library to the classpath (e.g. log4j-<version>.jar) and JBoss Logging will delegate any log requests to that provider.

  • Add the following artifact to your Maven/Ivy/Gradle dependency list:

      <dependency>
          <groupId>org.hibernate.validator</groupId>
          <artifactId>hibernate-validator</artifactId>
          <version>9.0.0.CR1</version>
      </dependency>
    

    You also need an API and implementation of the Unified Expression Language. These dependencies must be explicitly added in an SE environment. In a Jakarta EE environment, they are often already provided.

      <dependency>
         <groupId>org.glassfish.expressly</groupId>
         <artifactId>expressly</artifactId>
         <version>6.0.0-M1</version>
      </dependency>
    
  • Jakarta Validation defines integration points with CDI. If your application runs in an environment which does not provide this integration out of the box, you may use the Hibernate Validator CDI portable extension by adding the following dependency:

      <dependency>
         <groupId>org.hibernate.validator</groupId>
         <artifactId>hibernate-validator-cdi</artifactId>
         <version>9.0.0.CR1</version>
      </dependency>
    
  • hibernate-validator-annotation-processor-<version>.jar is an optional jar which can be integrated with your build environment respectively IDE to verify that constraint annotations are correctly used. Refer to the online documentation for more information.

Licensing

Hibernate Validator itself as well as the Jakarta Validation API and TCK are all provided and distributed under the Apache Software License 2.0. Refer to license.txt for more information.

Build from Source

You can build Hibernate Validator from source by cloning the git repository git://github.com/hibernate/hibernate-validator.git. You will also need a JDK 21+ and Maven 3 (>= 3.9.9). With these prerequisites in place you can compile the source via:

mvn clean install

There are more build options available as well. For more information refer to Contributing to Hibernate Validator.

Continuous Integration

The official Continuous Integration service for the project is hosted on ci.hibernate.org.

We also include a GitHub action build file that can be used by those interested in running builds on their own forks. This build runs on Linux and Windows and executes the TCK both in standalone and in container modes.

Hibernate Validator URLs