public class ConstraintValidatorContextImpl extends Object implements HibernateConstraintValidatorContext
ConstraintValidatorContext.ConstraintViolationBuilder
Constructor and Description |
---|
ConstraintValidatorContextImpl(List<String> methodParameterNames,
ClockProvider clockProvider,
PathImpl propertyPath,
ConstraintDescriptor<?> constraintDescriptor,
Object constraintValidatorPayload) |
Modifier and Type | Method and Description |
---|---|
HibernateConstraintValidatorContext |
addExpressionVariable(String name,
Object value)
Allows to set an additional expression variable which will be available as an EL variable during interpolation.
|
HibernateConstraintValidatorContext |
addMessageParameter(String name,
Object value)
Allows to set an additional named parameter which can be interpolated in the constraint violation message.
|
ConstraintValidatorContext.ConstraintViolationBuilder |
buildConstraintViolationWithTemplate(String messageTemplate)
Returns a constraint violation builder building a violation report
allowing to optionally associate it to a sub path.
|
void |
disableDefaultConstraintViolation()
Disables the default
ConstraintViolation object generation (which
is using the message template declared on the constraint). |
ClockProvider |
getClockProvider()
Returns the provider for obtaining the current time in the form of a
Clock ,
e.g. |
ConstraintDescriptor<?> |
getConstraintDescriptor() |
<C> C |
getConstraintValidatorPayload(Class<C> type)
Returns an instance of the specified type or
null if the current constraint validator payload isn't of
the given type. |
List<ConstraintViolationCreationContext> |
getConstraintViolationCreationContexts() |
String |
getDefaultConstraintMessageTemplate() |
List<String> |
getMethodParameterNames() |
<T> T |
unwrap(Class<T> type)
Returns an instance of the specified type allowing access to
provider-specific APIs.
|
HibernateConstraintValidatorContext |
withDynamicPayload(Object violationContext)
Allows to set an object that may further describe the violation.
|
public ConstraintValidatorContextImpl(List<String> methodParameterNames, ClockProvider clockProvider, PathImpl propertyPath, ConstraintDescriptor<?> constraintDescriptor, Object constraintValidatorPayload)
public final void disableDefaultConstraintViolation()
ConstraintValidatorContext
ConstraintViolation
object generation (which
is using the message template declared on the constraint).
Useful to set a different violation message or generate a ConstraintViolation
based on a different property.
disableDefaultConstraintViolation
in interface ConstraintValidatorContext
public final String getDefaultConstraintMessageTemplate()
getDefaultConstraintMessageTemplate
in interface ConstraintValidatorContext
public final ConstraintValidatorContext.ConstraintViolationBuilder buildConstraintViolationWithTemplate(String messageTemplate)
ConstraintValidatorContext
To create the ConstraintViolation
, one must call either one of
the addConstraintViolation()
methods available in one of the
interfaces of the fluent API.
If another method is called after addConstraintViolation()
on
ConstraintViolationBuilder
or any of its associated nested interfaces
an IllegalStateException
is raised.
If ConstraintValidator.isValid(Object, ConstraintValidatorContext)
returns
false
, a ConstraintViolation
object will be built per constraint
violation report including the default one (unless
ConstraintValidatorContext.disableDefaultConstraintViolation()
has been called).
ConstraintViolation
objects generated from such a call
contain the same contextual information (root bean, path and so on) unless
the path has been overridden.
To create a different ConstraintViolation
, a new constraint violation builder
has to be retrieved from ConstraintValidatorContext
Here are a few usage examples:
//assuming the following domain model public class User { public Map<String,Address> getAddresses() { ... } } public class Address { public String getStreet() { ... } public Country getCountry() { ... } } public class Country { public String getName() { ... } } //From a property-level constraint on User.addresses //Build a constraint violation on the default path - i.e. the "addresses" property context.buildConstraintViolationWithTemplate( "this detail is wrong" ) .addConstraintViolation(); //From a class level constraint on Address //Build a constraint violation on the default path + "street" //i.e. the street property of Address context.buildConstraintViolationWithTemplate( "this detail is wrong" ) .addPropertyNode( "street" ) .addConstraintViolation(); //From a property-level constraint on User.addresses //Build a constraint violation on the default path + the bean stored //under the "home" key in the map context.buildConstraintViolationWithTemplate( "Incorrect home address" ) .addBeanNode() .inContainer( Map.class, 1 ) .inIterable().atKey( "home" ) .addConstraintViolation(); //From a class level constraint on User //Build a constraint violation on the default path + addresses["home"].country.name //i.e. property "country.name" on the object stored under "home" in the map context.buildConstraintViolationWithTemplate( "this detail is wrong" ) .addPropertyNode( "addresses" ) .addPropertyNode( "country" ) .inContainer( Map.class, 1 ) .inIterable().atKey( "home" ) .addPropertyNode( "name" ) .addConstraintViolation(); //From a class level constraint on User //Build a constraint violation on the default path + addresses["home"].<map key> //i.e. a container element constraint violation for the map key context.buildConstraintViolationWithTemplate( "the map key is invalid" ) .addPropertyNode( "addresses" ) .addContainerElementNode( "<map key>", Map.class, 0 ) .inIterable().atKey( "invalid" ) .addConstraintViolation();
Cross-parameter constraints on a method can create a node specific to a particular parameter if required. Let's explore a few examples:
//Cross-parameter constraint on method //createUser(String password, String passwordRepeat) //Build a constraint violation on the default path + "passwordRepeat" context.buildConstraintViolationWithTemplate("Passwords do not match") .addParameterNode(1) .addConstraintViolation(); //Cross-parameter constraint on a method //mergeAddresses(Map<String,Address> addresses, // Map<String,Address> otherAddresses) //Build a constraint violation on the default path + "otherAddresses["home"] //i.e. the Address bean hosted in the "home" key of the "otherAddresses" map parameter context.buildConstraintViolationWithTemplate( "Map entry home present in both and does not match") .addParameterNode(1) .addBeanNode() .inContainer( Map.class, 1 ) .inIterable().atKey("home") .addConstraintViolation(); //Cross-parameter constraint on a method //mergeAddresses(Map<String,Address> addresses, // Map<String,Address> otherAddresses) //Build a constraint violation on the default path + "otherAddresses["home"].city //i.e. on the "city" property of the Address bean hosted in //the "home" key of the "otherAddresses" map context.buildConstraintViolationWithTemplate( "Map entry home present in both but city does not match") .addParameterNode(1) .addPropertyNode("city") .inContainer( Map.class, 1 ) .inIterable().atKey("home") .addConstraintViolation();
buildConstraintViolationWithTemplate
in interface ConstraintValidatorContext
messageTemplate
- new un-interpolated constraint messagepublic <T> T unwrap(Class<T> type)
ConstraintValidatorContext
ValidationException
is thrown.unwrap
in interface ConstraintValidatorContext
T
- the type of the object to be returnedtype
- the class of the object to be returnedpublic HibernateConstraintValidatorContext addExpressionVariable(String name, Object value)
HibernateConstraintValidatorContext
ConstraintViolationBuilder
.
To create multiple constraint violations with different variable values, this method can be called
between successive calls to ConstraintValidatorContext.ConstraintViolationBuilder.addConstraintViolation()
.
For example:
public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
HibernateConstraintValidatorContext context = constraintValidatorContext.unwrap( HibernateConstraintValidatorContext.class );
context.addExpressionVariable( "foo", "bar" );
context.buildConstraintViolationWithTemplate( "${foo}" )
.addConstraintViolation();
context.addExpressionVariable( "foo", "snafu" );
context.buildConstraintViolationWithTemplate( "${foo}" )
.addConstraintViolation();
return false;
}
addExpressionVariable
in interface HibernateConstraintValidatorContext
name
- the name under which to bind the expression variable, cannot be null
value
- the value to be bound to the specified namepublic HibernateConstraintValidatorContext addMessageParameter(String name, Object value)
HibernateConstraintValidatorContext
ConstraintViolationBuilder
.
To create multiple constraint violations with different variable values, this method can be called
between successive calls to ConstraintViolationBuilder#addConstraintViolation()
.
For example:
public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
HibernateConstraintValidatorContext context = constraintValidatorContext.unwrap( HibernateConstraintValidatorContext.class );
context.addMessageParameter( "foo", "bar" );
context.buildConstraintViolationWithTemplate( "{foo}" )
.addConstraintViolation();
context.addMessageParameter( "foo", "snafu" );
context.buildConstraintViolationWithTemplate( "{foo}" )
.addConstraintViolation();
return false;
}
addMessageParameter
in interface HibernateConstraintValidatorContext
name
- the name under which to bind the parameter, cannot be null
value
- the value to be bound to the specified namepublic ClockProvider getClockProvider()
ConstraintValidatorContext
Clock
,
e.g. when validating the Future
and Past
constraints.getClockProvider
in interface ConstraintValidatorContext
null
. If no
specific provider has been configured during bootstrap, a default implementation using
the current system time and the current default time zone as returned by
Clock.systemDefaultZone()
will be returned.public HibernateConstraintValidatorContext withDynamicPayload(Object violationContext)
HibernateConstraintValidatorContext
javax.validation.ConstraintViolation
has to be serialized.withDynamicPayload
in interface HibernateConstraintValidatorContext
violationContext
- an object representing additional information about the violationpublic <C> C getConstraintValidatorPayload(Class<C> type)
HibernateConstraintValidatorContext
null
if the current constraint validator payload isn't of
the given type.getConstraintValidatorPayload
in interface HibernateConstraintValidatorContext
type
- the type of payload to retrievenull
if the current constraint validator payload isn't of
the given typeHibernateValidatorConfiguration.constraintValidatorPayload(Object)
public final ConstraintDescriptor<?> getConstraintDescriptor()
public final List<ConstraintViolationCreationContext> getConstraintViolationCreationContexts()
Copyright © 2019 JBoss by Red Hat. All rights reserved.