Hibernate Validator - Bean Validation 2.0 (JSR 380) Reference Implementation
Java Other
Permalink
Failed to load latest commit information.
annotation-processor HV-451 Additional fixes and style improvements Dec 7, 2016
build-config HV-1107 Checkstyle - stricter ParenPad rule Sep 23, 2016
cdi HV-1147 Allowing documentation build to pass on JDK 9 by Nov 8, 2016
distribution HV-1181 Adding reference docs to distribution; excluding some unwante… Dec 8, 2016
documentation HV-1182 Update WildFly patch name in the documentation Dec 8, 2016
engine HV-1165 Minor additional cleanup Dec 7, 2016
integration HV-1183 Upgrading to JodaTime 2.9.5; adding integration test for Joda… Dec 8, 2016
modules HV-1167 Use the WildFly patch file when running the TCK with WildFly Nov 30, 2016
osgi HV-1178 Using a specific ValidationProviderResolver is no longer needed Dec 7, 2016
performance HV-1163 Update performance tests to 5.3.3.Final Nov 30, 2016
src/main HV-1076 Fix Checkstyle configuration and all the violations. Jun 20, 2016
tck-runner HV-1167 Removing obsolete Groovy file Dec 1, 2016
test-utils HV-1118 Using reflection based parameter names by default Oct 5, 2016
.gitattributes HV-760 Adding .gitattributes to ensure consistent line ending style May 2, 2013
.gitignore Adding .checkstyle to .gitignore Sep 22, 2016
.travis.yml HV-1092 Provide a settings-example.xml Aug 26, 2016
CONTRIBUTING.md HV-1078 Update the CONTRIBUTING.md file Jun 21, 2016
README.md [Jenkins release job] README.md updated by release build 5.3.3.Final Nov 22, 2016
changelog.txt Adding 5.3.4.Final and 5.4.0.Beta1 contents to changelog.txt Dec 8, 2016
copyright.txt HV-1164 Adding Sebastian to copyright.txt Nov 30, 2016
license.txt BVAL-31 refactored some code, imported AnnotationFactory from annotat… Jan 7, 2009
pom.xml HV-1182 Update WildFly patch name in the documentation Dec 8, 2016
settings-example.xml HV-1092 Provide a settings-example.xml Aug 26, 2016

README.md

Hibernate Validator

Version: 5.3.3.Final - 22-11-2016

What is it?

This is the reference implementation of JSR-380 - Bean Validation 2.0. Bean 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 meta-data 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 1.8 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 to your Maven or Ivy dependency list

    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>5.3.3.Final</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 an EE environment they are often already provided.

    <dependency>
       <groupId>org.glassfish</groupId>
       <artifactId>javax.el</artifactId>
       <version>3.0.1-b08</version>
    </dependency>
    
  • Bean 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</groupId>
       <artifactId>hibernate-validator-cdi</artifactId>
       <version>5.3.3.Final</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 Bean 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 8 and Maven 3 (>= 3.0.3). With these prerequisites in place you can compile the source via

mvn -s settings-example.xml clean install

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

Build on JDK 9

To build Hibernate Validator with JDK 9, export the following environment variable:

export MAVEN_OPTS="--add-modules java.annotations.common,java.xml.bind"

Then the build can be started like this:

mvn -s settings-example.xml clean install -DdisableDocumentationBuild=true -DdisableDistributionBuild

The documentation and distribution modules are known to not work on Java 9 for the time being, hence they need to be excluded. Also the integration tests on WildFly will fail on Java 9 currently, hence this "integration" module is excluded automatically when building on JDK 9.

Continuous Integration

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

We provide a .travis.yml file so that you can enable CI for your GitHub fork by enabling the build in your Travis CI account.

Hibernate Validator URLs