Skip to content

Latest commit

 

History

History
105 lines (63 loc) · 6.52 KB

README.md

File metadata and controls

105 lines (63 loc) · 6.52 KB
Raw

bean-validation-custom-constraint: Bean Validation Using Custom Constraints

Author: Giriraj Sharma
Level: Beginner
Technologies: CDI, JPA, BV
Summary: The bean-validation-custom-constraint quickstart demonstrates how to use the Bean Validation API to define custom constraints and validators.
Target Product: ${product.name}
Source: <${github.repo.url}>

What is it?

The bean-validation-custom-constraint quickstart demonstrates how to use CDI, JPA, and Bean Validation in ${product.name.full}. Bean Validation API allows the developers to define their own constraints by creating a new annotation and writing the validator which is used to validate the value. This quickstart will show you how to create custom constraints and then use it to validate your data. It includes a persistence unit and some sample persistence code to introduce you to database access in enterprise Java.

This quickstart does not contain a user interface layer. The purpose of this project is to show you how to test bean validation using custom constraints with Arquillian. In this quickstart, the personAddress field of entity Person is validated using a set of custom constraints defined in the class AddressValidator. If you want to see an example of how to test bean validation with a user interface, look at the kitchensink example.

Note: This quickstart uses the H2 database included with ${product.name.full} ${product.version}. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!

Note: This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in ${product.name} and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the Configuration Guide for ${product.name.full}.

System requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.

All you need to build this project is ${build.requirements}. See Configure Maven for ${product.name} ${product.version} to make sure you are configured correctly for testing the quickstarts.

Use of ${jboss.home.name}

In the following instructions, replace ${jboss.home.name} with the actual path to your ${product.name} installation. The installation path is described in detail here: Use of ${jboss.home.name} and JBOSS_HOME Variables.

Start the ${product.name} Server

  1. Open a command prompt and navigate to the root of the ${product.name} directory.

  2. The following shows the command line to start the server:

     For Linux:   ${jboss.home.name}/bin/standalone.sh
 For Windows: ${jboss.home.name}\bin\standalone.bat

Run the Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.

  1. Make sure you have started the ${product.name} server as described above.

  2. Open a command prompt and navigate to the root directory of this quickstart.

  3. Type the following command to run the test goal with the following profile activated:

     mvn clean verify -Parq-remote

You can also let Arquillian manage the ${product.name} server by using the arq-managed profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.

Investigate the Console Output

When you run the tests, JUnit will present you test report summary:

Tests run: 2, Failures: 0, Errors: 0, Skipped: 0

If you are interested in more details, look in the target/surefire-reports directory.

You can also check the server console output to verify that the Arquillian tests deployed to and ran in the application server. Search for lines similar to the following ones in the server output log:

INFO [org.jboss.as.server.deployment] (MSC service thread 1-5) WFLYSRV0027: Starting deployment of "test.war" (runtime-name: "test.war")
...
INFO [org.jboss.as.server] (management-handler-thread - 2) WFLYSRV0010: Deployed "test.war" (runtime-name : "test.war")
...
INFO [org.jboss.as.server.deployment] (MSC service thread 1-3) WFLYSRV0028: Stopped deployment test.war (runtime-name: test.war) in 32ms
...
INFO [[org.jboss.as.server] (management-handler-thread - 2) WFLYSRV0009: Undeployed "test.war" (runtime-name: "test.war")

Server Log: Expected warnings and errors

Note: You will see the following warnings in the server log. You can ignore these warnings.

WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in a future version.

HHH000431: Unable to determine H2 database version, certain features may not work

Test the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

    mvn dependency:sources

You may see the following message when you run the command. It indicates the source is not provided in the third-party antlr JAR.

    [INFO] The following files have NOT been resolved:
    [INFO]    antlr:antlr:jar:sources:2.7.7:provided