Module org.apache.wicket.bean.validation

Package org.apache.wicket.bean.validation

Class BeanValidationConfiguration

java.lang.Object

org.apache.wicket.bean.validation.BeanValidationConfiguration

All Implemented Interfaces:

BeanValidationContext, IPropertyResolver

public class BeanValidationConfiguration
extends Object
implements BeanValidationContext

Configures bean validation and integrates it with Wicket

Author:

igor

Constructor Summary

Constructors

Constructor	Description
BeanValidationConfiguration()

Method Summary

Modifier and Type	Method	Description
BeanValidationConfiguration	add(IPropertyResolver resolver)	Adds a property resolver to the configuration.
void	configure(Application application)	Binds this configuration to the application instance
static BeanValidationContext	get()	Retrieves the validation context (read only version of the configuration).
<T extends Annotation> ITagModifier<T>	getTagModifier(Class<T> annotationType)	Get the registered modifier for the given annotation.
jakarta.validation.Validator	getValidator()
IViolationTranslator	getViolationTranslator()
boolean	isRequiredConstraint(jakarta.validation.metadata.ConstraintDescriptor<?> constraint)	By default NotNull and NotEmpty constraints make a component required.
<T extends Annotation> BeanValidationConfiguration	register(Class<T> annotationType, ITagModifier<T> modifier)	Registers a tag modifier for a specific constraint annotation.
Property	resolveProperty(FormComponent<?> component)	Resolve the property for a component.
void	setValidatorProvider(Supplier<jakarta.validation.Validator> validatorProvider)	Sets the provider used to retrieve Validator instances
void	setViolationTranslator(IViolationTranslator violationTranslator)	Registers a violation translator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BeanValidationConfiguration

public BeanValidationConfiguration()

Method Details

register

public <T extends Annotation>
BeanValidationConfiguration register(Class<T> annotationType,
 ITagModifier<T> modifier)

Registers a tag modifier for a specific constraint annotation.

By default Size constraints are automatically mapped to maxlength of text inputs, this can be disabled by registering a ITagModifier.NO_OP instead: configuration.register(Size.class, ITagModifier.NO_OP});

Parameters:

annotationType - constraint annotation such as Size

modifier - tag modifier to use

Returns:

this

getTagModifier

public <T extends Annotation> ITagModifier<T> getTagModifier(Class<T> annotationType)

Get the registered modifier for the given annotation.

Specified by:

getTagModifier in interface BeanValidationContext

Returns:

tag modifier or null if none

See Also:

• register(Class, ITagModifier)

add

public BeanValidationConfiguration add(IPropertyResolver resolver)

Adds a property resolver to the configuration. Property resolvers registered last are the first to be allowed to resolve the property.

Parameters:

resolver -

Returns:

this

getValidator

public jakarta.validation.Validator getValidator()

Specified by:

getValidator in interface BeanValidationContext

Returns:

validator

setValidatorProvider

public void setValidatorProvider(Supplier<jakarta.validation.Validator> validatorProvider)

Sets the provider used to retrieve Validator instances

Parameters:

validatorProvider -

configure

public void configure(Application application)

Binds this configuration to the application instance

Parameters:

application -

getViolationTranslator

public IViolationTranslator getViolationTranslator()

Specified by:

getViolationTranslator in interface BeanValidationContext

Returns:

registered violation translator

setViolationTranslator

public void setViolationTranslator(IViolationTranslator violationTranslator)

Registers a violation translator

Parameters:

violationTranslator - A violation translator that will convert ConstraintViolations into Wicket's ValidationErrors

get

public static BeanValidationContext get()

Retrieves the validation context (read only version of the configuration). This is how components retrieve the configuration.

Returns:

validation context

resolveProperty

public Property resolveProperty(FormComponent<?> component)

Description copied from interface: BeanValidationContext

Resolve the property for a component.

Specified by:

resolveProperty in interface BeanValidationContext

Specified by:

resolveProperty in interface IPropertyResolver

Parameters:

component - component

isRequiredConstraint

public boolean isRequiredConstraint(jakarta.validation.metadata.ConstraintDescriptor<?> constraint)

By default NotNull and NotEmpty constraints make a component required.

Specified by:

isRequiredConstraint in interface BeanValidationContext

Parameters:

constraint - constraint

Returns:

true if required