https://github.com/netceteragroup/valdr-bean-validation
Java Bean Validation plugin
https://github.com/netceteragroup/valdr-bean-validation
Last synced: 6 days ago
JSON representation
Java Bean Validation plugin
- Host: GitHub
- URL: https://github.com/netceteragroup/valdr-bean-validation
- Owner: netceteragroup
- License: mit
- Created: 2014-03-20T21:31:43.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T17:20:58.000Z (8 months ago)
- Last Synced: 2025-05-09T07:47:47.207Z (9 days ago)
- Language: Java
- Homepage:
- Size: 244 KB
- Stars: 35
- Watchers: 12
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# valdr Bean Validation
[](https://github.com/netceteragroup/valdr-bean-validation/actions/workflows/build.yml)
[](https://coveralls.io/r/netceteragroup/valdr-bean-validation?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/com.github.valdr/valdr-bean-validation/)
[](https://github.com/netceteragroup/valdr-bean-validation/blob/master/LICENSE)
[Bean Validation](http://beanvalidation.org/) (JSR 303) plugin for [valdr](https://github.com/netceteragroup/valdr)
- [Offering](#offering)
- [Features](#features)
- [Use](#use)
- [CLI client](#cli-client)
- [Servlet](#servlet)
- [Dependency on valdr](#dependency-on-valdr)
- [Mapping of Bean Validation constraints to valdr constraints](#mapping-of-bean-validation-constraints-to-valdr-constraints)
- [Support](#support)
- [License](#license)
## Offering
valdr Bean Validation parses Java model classes for Bean Validation constraints (aka JSR 303 annotations)
and extracts their information into a [JSON document to be used by valdr](https://github.com/netceteragroup/valdr#constraints-json). This allows to apply the exact same
validation rules on the server and on the client.
## Features
- _offline use:_ CLI client which can be integrated into build process to produce static valdr JSON which is packaged
and delivered with the web application
- _online use:_ Servlet which parses model classes at runtime and sends JSON back to the client (e.g. during
client start or on-demand)
- both Servlet and CLI client support a number of [config options](https://github.com/netceteragroup/valdr-bean-validation/blob/master/valdr-bean-validation-demo/src/main/resources/valdr-bean-validation.json)
- list of packages to scan
- list of classes in those packages to exclude
- list of fields to exclude
- list of custom annotation classes to include in JSON
- whether to output simple or full type names
- the output file name (CLI only)
- CORS `Access-Control-Allow-Origin` HTTP header value (Servlet only)
- Servlet offers built-in [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing) support
## Use
Check out the [demo](valdr-bean-validation-demo) for usage samples of both CLI client and Servlet.
```xml
com.github.valdr
valdr-bean-validation
see-latest-version-at-the-top-of-this-page
```
### CLI client
Example of Maven integration:
```xml
org.codehaus.mojo
exec-maven-plugin
${exec-maven-plugin.version}
process-bean-validation-annotations
process-classes
java
com.github.valdr.cli.ValdrBeanValidation
-cf
my-config.json
-outputFile
${basedir}/src/main/webapp/validation/validation.json
```
### Servlet
Example of `web.xml`:
```xml
valdr Bean Validation Servlet
com.github.valdr.ValidationRulesServlet
configFile
my-config.json
```
## Dependency on valdr
valdr Bean Validation is dependent on valdr in two ways:
* [JSON structure](https://github.com/netceteragroup/valdr#constraints-json) is defined by valdr
* validators listed in the JSON document have to be either a [supported valdr valdidator](https://github.com/netceteragroup/valdr#built-in-validators) or one of your [custom JavaScript validators](https://github.com/netceteragroup/valdr#adding-custom-validators)
To indicate which valdr version a specific valdr Bean Validation version supports there's a simple rule: the first
digit of the valdr Bean Validation version denotes the supported valdr version. Version 1.x will support valdr 1.
This means that valdr Bean Validation 1.x+1 may introduce breaking changes over 1.x because the second version digit
kind-of represents the "major" version.
## Mapping of Bean Validation constraints to valdr constraints
The [BuiltInConstraint.java](https://github.com/netceteragroup/valdr-bean-validation/blob/master/valdr-bean-validation/src/main/java/com/github/valdr/BuiltInConstraint.java) enum defines the mapping of Bean Validation constraints to valdr constraints.
| Bean Validation | valdr | Comment |
|-----------------------------------------------------------------------------------------------------------------|-------|---------|
| [NotNull](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/notnull) | [required](https://github.com/netceteragroup/valdr#required) | |
| [Min](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/min) | [min](https://github.com/netceteragroup/valdr#min--max) | |
| [Max](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/max) | [max](https://github.com/netceteragroup/valdr#min--max) | |
| [Size](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/size) | [size](https://github.com/netceteragroup/valdr#size) | |
| [Digits](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/digits) | [digits](https://github.com/netceteragroup/valdr#digits) | |
| [Pattern](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/pattern) | [pattern](https://github.com/netceteragroup/valdr#partern) | Java regex pattern is transformed to JavaScript pattern |
| [Future](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/future) | [future](https://github.com/netceteragroup/valdr#future--past) | |
| [Past](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/past) | [past](https://github.com/netceteragroup/valdr#future--past) | |
| [Email](https://jakarta.ee/specifications/bean-validation/3.0/apidocs/jakarta/validation/constraints/email) |[email](https://github.com/netceteragroup/valdr#email) | |
| [URL](https://docs.jboss.org/hibernate/stable/validator/api/org/hibernate/validator/constraints/URL.html) |[url](https://github.com/netceteragroup/valdr#url) | proprietary Hibernate Validator (not in Bean Validation spec) |
## Support
[Ask a question on Stack Overflow](http://stackoverflow.com/questions/ask?tags=valdr-bean-validation) and tag it with [`valdr-bean-validation`](http://stackoverflow.com/tags/valdr-bean-validation).
## License
[MIT](http://opensource.org/licenses/MIT) © Netcetera AG