Skip to site navigation (Press enter)

[CONF] Apache CXF Documentation > ValidationFeature

Andrew Redko (Confluence) Sat, 30 Nov 2013 10:17:27 -0800

ValidationFeature

Page edited by Andrew Redko

Changes (1)

Full Content

Bean Validation Feature

Introduction
Dependencies

Using Hibernate Validator as bean validation provider
Using Apache BVal as bean validation provider

Bean Validation 1.1 and JAX-RS 2.0 integration

Configuring Bean Validation 1.1 using JAXRSServerFactoryBean

Introduction

Among many other features, JAX-RS 2.0 specification introduces Bean Validation 1.1 support as a mandatory part of implementation. In an effort to fulfill this requirement, Apache CXF provides full-fledge validation support for JAX-RS / JAX-WS endpoints, both for request parameters and response values.

Dependencies

Bean Validation support in Apache CXF is implementation-independent and is built solely using API. As such, the only required dependency is:

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>


API doesn't provide implementation but there are couple of choices to pick from. Please notice that bean validation implementation is taken from the ones present in classpath. If no implementation is detected, bean validation is not available for use and constraints validation won't have any effect. 

Using Hibernate Validator as bean validation provider
http://www.hibernate.org/subprojects/validator.html

Hibernate Validator is mature and feature-rich validation provider with full support of Bean Validation 1.1 (as of version 5.x.x which is the reference implementation for JSR 349 - Bean Validation 1.1 API). To use Hibernate Validator in your Apache CXF projects, couple of additional dependencies should be included:


<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.0.1.Final</version>
</dependency>

<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <version>3.0-b02</version>
</dependency>

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0-b01/version>
</dependency>



Hibernate Validator uses Java _expression_ Language 3.0 in order to provide better validation messages support so the respective EL 3.0 API and implementation dependencies should be included.  

Using Apache BVal as bean validation provider
http://bval.apache.org/

Current stable version of Apache BVal (0.5) doesn't support Bean Validation 1.1 but the upcoming 1.1.0 should have it fully implemented (at the moment 1.1.0-alpha-SNAPSHOT could be used).

<dependency>
    <groupId>org.apache.bval</groupId>
    <artifactId>bval-jsr</artifactId>
    <version>1.1.0-alpha-SNAPSHOT</version>
</dependency>



Bean Validation 1.1 and JAX-RS 2.0 integration

Bean Validation 1.1 support in JAX-RS 2.0 is built on top of three main components:

	in-interceptor (org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInInterceptor): validates REST/WS endpoint parameters before invoking the method
	out-interceptor (org.apache.cxf.jaxrs.validation.JAXRSBeanValidationOutInterceptor): validates REST/WS endpoint return value after the method invocation
	exception mapper (org.apache.cxf.jaxrs.validation.ValidationExceptionMapper): transforms any ValidationException to corresponding HTTP status code



All these components may share the single instance of org.apache.cxf.validation.BeanValidationProvider which actually delegates all validation logic to available Bean Validation 1.1 implementation.

Configuring Bean Validation 1.1 using JAXRSServerFactoryBean

It's quite easy to enable bean validation support using JAXRSServerFactoryBean as following code snippet shows:

JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
sf.setResourceClasses( ... );
sf.setResourceProvider( ... );
sf.setProvider(new ValidationExceptionMapper());
sf.setInInterceptors(Arrays.< Interceptor< ? extends Message > >asList(new new JAXRSBeanValidationInInterceptor()));
sf.setOutInterceptors(Arrays.< Interceptor< ? extends Message > >asList(new JAXRSBeanValidationOutInterceptor()));
sf.create();

Stop watching space | Change email notification preferences

View Online | View Changes