org.jboss.resteasy.spi.validation

Interface GeneralValidator

All Known Subinterfaces:

GeneralValidatorCDI

All Known Implementing Classes:

GeneralValidatorImpl

public interface GeneralValidator

Version:

$Revision: 1.1 $ Javadoc adapted from javax.validation.Validator and javax.validation.executable.ExecutableValidator:

Author:

Ron Sigal, Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling

Method Summary

Modifier and Type	Method and Description
void	checkViolations(HttpRequest request) Throws a ResteasyViolationException if any validation violations have been detected.
boolean	isMethodValidatable(Method method) Indicates if validation is turned on for a method.
boolean	isValidatable(Class<?> clazz) Indicates if validation is turned on for a class.
void	validate(HttpRequest request, Object object, Class<?>... groups) Validates all constraints on object.
void	validateAllParameters(HttpRequest request, Object object, Method method, Object[] parameterValues, Class<?>... groups) Validates all constraints placed on the parameters of the given method.
void	validateReturnValue(HttpRequest request, Object object, Method method, Object returnValue, Class<?>... groups) Validates all return value constraints of the given method.

Method Detail

validate

void validate(HttpRequest request,
              Object object,
              Class<?>... groups)

Validates all constraints on object.

Parameters:

request - http request

object - object to validate

groups - the group or list of groups targeted for validation (defaults to javax.validation.groups.Default)

Throws:

IllegalArgumentException - if object is null or if null is passed to the varargs groups

javax.validation.ValidationException - if a non recoverable error happens during the validation process

validateAllParameters

void validateAllParameters(HttpRequest request,
                           Object object,
                           Method method,
                           Object[] parameterValues,
                           Class<?>... groups)

Validates all constraints placed on the parameters of the given method.

Parameters:

request - http request

object - the object on which the method to validate is invoked

method - the method for which the parameter constraints is validated

parameterValues - the values provided by the caller for the given method's parameters

groups - the group or list of groups targeted for validation (defaults to javax.validation.groups.Default)

Throws:

IllegalArgumentException - if null is passed for any of the parameters or if parameters don't match with each other

javax.validation.ValidationException - if a non recoverable error happens during the validation process

validateReturnValue

void validateReturnValue(HttpRequest request,
                         Object object,
                         Method method,
                         Object returnValue,
                         Class<?>... groups)

Validates all return value constraints of the given method.

Parameters:

request - http request

object - the object on which the method to validate is invoked

method - the method for which the return value constraints is validated

returnValue - the value returned by the given method

groups - the group or list of groups targeted for validation (defaults to javax.validation.groups.Default)

Throws:

IllegalArgumentException - if null is passed for any of the object, method or groups parameters or if parameters don't match with each other

javax.validation.ValidationException - if a non recoverable error happens during the validation process

isValidatable

boolean isValidatable(Class<?> clazz)

Indicates if validation is turned on for a class.

Parameters:

clazz - Class to be examined

Returns:

true if and only if validation is turned on for clazz

isMethodValidatable

boolean isMethodValidatable(Method method)

Indicates if validation is turned on for a method.

Parameters:

method - method to be examined

Returns:

true if and only if validation is turned on for method

checkViolations

void checkViolations(HttpRequest request)

Throws a ResteasyViolationException if any validation violations have been detected.

Parameters:

request - http request