org.apache.bval.jsr

Class ConfigurationImpl

java.lang.Object

org.apache.bval.jsr.ConfigurationImpl

All Implemented Interfaces:

Configuration<ApacheValidatorConfiguration>, ConfigurationState, ApacheValidatorConfiguration

public class ConfigurationImpl
extends Object
implements ApacheValidatorConfiguration, ConfigurationState

Description: used to configure apache-validation for jsr. Implementation of Configuration that also implements ConfigurationState, hence this can be passed to buildValidatorFactory(ConfigurationState).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bval.jsr.ApacheValidatorConfiguration

ApacheValidatorConfiguration.Properties

Field Summary

Fields

Modifier and Type	Field and Description
protected BootstrapConfiguration	bootstrapConfiguration
protected ConstraintValidatorFactory	constraintValidatorFactory
protected Class<? extends ConstraintValidatorFactory>	constraintValidatorFactoryClass
protected ConstraintValidatorFactory	defaultConstraintValidatorFactory Configured ConstraintValidatorFactory
protected MessageInterpolator	defaultMessageInterpolator Configured MessageInterpolator
protected ParameterNameProvider	defaultParameterNameProvider
protected TraversableResolver	defaultTraversableResolver
protected Collection<ExecutableType>	executableValidation
protected MessageInterpolator	messageInterpolator
protected Class<? extends MessageInterpolator>	messageInterpolatorClass
protected ParameterNameProvider	parameterNameProvider
protected Class<? extends ParameterNameProvider>	parameterNameProviderClass
protected ValidationProvider<?>	provider Configured ValidationProvider
protected Class<? extends ValidationProvider<?>>	providerClass Configured ValidationProvider class
protected ValidationProviderResolver	providerResolver Configured ValidationProviderResolver
protected TraversableResolver	traversableResolver
protected Class<? extends TraversableResolver>	traversableResolverClass

Constructor Summary

Constructors

Constructor and Description
ConfigurationImpl(BootstrapState aState, ValidationProvider<?> aProvider) Create a new ConfigurationImpl instance.

Method Summary

Modifier and Type	Method and Description
ApacheValidatorConfiguration	addMapping(InputStream stream) Add a stream describing constraint mapping in the Bean Validation XML format.
ApacheValidatorConfiguration	addProperty(String name, String value) Add a provider specific property.
ValidatorFactory	buildValidatorFactory() main factory method to build a ValidatorFactory
ConfigurationImpl	constraintValidatorFactory(ConstraintValidatorFactory constraintFactory)
void	constraintValidatorFactoryClass(Class<ConstraintValidatorFactory> clazz)
BootstrapConfiguration	getBootstrapConfiguration()
Closeable	getClosable()
ConstraintValidatorFactory	getConstraintValidatorFactory()
ConstraintValidatorFactory	getDefaultConstraintValidatorFactory()
MessageInterpolator	getDefaultMessageInterpolator()
ParameterNameProvider	getDefaultParameterNameProvider()
TraversableResolver	getDefaultTraversableResolver()
Collection<ExecutableType>	getExecutableValidation()
Set<InputStream>	getMappingStreams()
MessageInterpolator	getMessageInterpolator()
ParameterNameProvider	getParameterNameProvider()
Map<String,String>	getProperties() Return a map of non type-safe custom properties.
ValidationProvider<?>	getProvider() Get the configured ValidationProvider.
TraversableResolver	getTraversableResolver()
ApacheValidatorConfiguration	ignoreXmlConfiguration() Ignore data from the META-INF/validation.xml file if this method is called.
boolean	isIgnoreXmlConfiguration() Returns true if Configuration.ignoreXMLConfiguration() has been called.
ConfigurationImpl	messageInterpolator(MessageInterpolator resolver)
void	messageInterpolatorClass(Class<MessageInterpolator> clazz)
ApacheValidatorConfiguration	parameterNameProvider(ParameterNameProvider parameterNameProvider)
void	parameterNameProviderClass(Class<? extends ParameterNameProvider> clazz)
void	setExecutableValidation(Collection<ExecutableType> executableValidation)
void	setProviderClass(Class<? extends ValidationProvider<?>> providerClass) Set ValidationProvider class.
ApacheValidatorConfiguration	traversableResolver(TraversableResolver resolver)
void	traversableResolverClass(Class<TraversableResolver> clazz)

Methods inherited from class java.lang.Object

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

Field Detail

provider

protected final ValidationProvider<?> provider

Configured ValidationProvider

providerResolver

protected final ValidationProviderResolver providerResolver

Configured ValidationProviderResolver

providerClass

protected Class<? extends ValidationProvider<?>> providerClass

Configured ValidationProvider class

defaultMessageInterpolator

protected MessageInterpolator defaultMessageInterpolator

Configured MessageInterpolator

messageInterpolator

protected MessageInterpolator messageInterpolator

messageInterpolatorClass

protected Class<? extends MessageInterpolator> messageInterpolatorClass

defaultConstraintValidatorFactory

protected ConstraintValidatorFactory defaultConstraintValidatorFactory

Configured ConstraintValidatorFactory

constraintValidatorFactory

protected ConstraintValidatorFactory constraintValidatorFactory

constraintValidatorFactoryClass

protected Class<? extends ConstraintValidatorFactory> constraintValidatorFactoryClass

defaultTraversableResolver

protected TraversableResolver defaultTraversableResolver

traversableResolver

protected TraversableResolver traversableResolver

traversableResolverClass

protected Class<? extends TraversableResolver> traversableResolverClass

defaultParameterNameProvider

protected ParameterNameProvider defaultParameterNameProvider

parameterNameProvider

protected ParameterNameProvider parameterNameProvider

parameterNameProviderClass

protected Class<? extends ParameterNameProvider> parameterNameProviderClass

bootstrapConfiguration

protected BootstrapConfiguration bootstrapConfiguration

executableValidation

protected Collection<ExecutableType> executableValidation

Constructor Detail

ConfigurationImpl

public ConfigurationImpl(BootstrapState aState,
                         ValidationProvider<?> aProvider)

Create a new ConfigurationImpl instance.

Parameters:

aState - bootstrap state

aProvider - provider

Method Detail

traversableResolver

public ApacheValidatorConfiguration traversableResolver(TraversableResolver resolver)

Specified by:

traversableResolver in interface Configuration<ApacheValidatorConfiguration>

ignoreXmlConfiguration

public ApacheValidatorConfiguration ignoreXmlConfiguration()

Ignore data from the META-INF/validation.xml file if this method is called.

Specified by:

ignoreXmlConfiguration in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

messageInterpolator

public ConfigurationImpl messageInterpolator(MessageInterpolator resolver)

Specified by:

messageInterpolator in interface Configuration<ApacheValidatorConfiguration>

constraintValidatorFactory

public ConfigurationImpl constraintValidatorFactory(ConstraintValidatorFactory constraintFactory)

Specified by:

constraintValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

parameterNameProvider

public ApacheValidatorConfiguration parameterNameProvider(ParameterNameProvider parameterNameProvider)

Specified by:

parameterNameProvider in interface Configuration<ApacheValidatorConfiguration>

addMapping

public ApacheValidatorConfiguration addMapping(InputStream stream)

Add a stream describing constraint mapping in the Bean Validation XML format.

Specified by:

addMapping in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

addProperty

public ApacheValidatorConfiguration addProperty(String name,
                                                String value)

Add a provider specific property. This property is equivalent to XML configuration properties. If we do not know how to handle the property, we silently ignore it.

Specified by:

addProperty in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

getDefaultMessageInterpolator

public MessageInterpolator getDefaultMessageInterpolator()

Specified by:

getDefaultMessageInterpolator in interface Configuration<ApacheValidatorConfiguration>

getDefaultTraversableResolver

public TraversableResolver getDefaultTraversableResolver()

Specified by:

getDefaultTraversableResolver in interface Configuration<ApacheValidatorConfiguration>

getDefaultConstraintValidatorFactory

public ConstraintValidatorFactory getDefaultConstraintValidatorFactory()

Specified by:

getDefaultConstraintValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

getDefaultParameterNameProvider

public ParameterNameProvider getDefaultParameterNameProvider()

Specified by:

getDefaultParameterNameProvider in interface Configuration<ApacheValidatorConfiguration>

getProperties

public Map<String,String> getProperties()

Return a map of non type-safe custom properties.

Specified by:

getProperties in interface ConfigurationState

Returns:

null

isIgnoreXmlConfiguration

public boolean isIgnoreXmlConfiguration()

Returns true if Configuration.ignoreXMLConfiguration() has been called. In this case, we ignore META-INF/validation.xml

Specified by:

isIgnoreXmlConfiguration in interface ConfigurationState

Returns:

true

getMappingStreams

public Set<InputStream> getMappingStreams()

Specified by:

getMappingStreams in interface ConfigurationState

getMessageInterpolator

public MessageInterpolator getMessageInterpolator()

Specified by:

getMessageInterpolator in interface ConfigurationState

getBootstrapConfiguration

public BootstrapConfiguration getBootstrapConfiguration()

Specified by:

getBootstrapConfiguration in interface Configuration<ApacheValidatorConfiguration>

buildValidatorFactory

public ValidatorFactory buildValidatorFactory()

main factory method to build a ValidatorFactory

Specified by:

buildValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

Throws:

ValidationException - if the ValidatorFactory cannot be built

getConstraintValidatorFactory

public ConstraintValidatorFactory getConstraintValidatorFactory()

Specified by:

getConstraintValidatorFactory in interface ConfigurationState

Returns:

the constraint validator factory of this configuration.

getTraversableResolver

public TraversableResolver getTraversableResolver()

Specified by:

getTraversableResolver in interface ConfigurationState

getParameterNameProvider

public ParameterNameProvider getParameterNameProvider()

Specified by:

getParameterNameProvider in interface ConfigurationState

getProvider

public ValidationProvider<?> getProvider()

Get the configured ValidationProvider.

Returns:

ValidationProvider

setProviderClass

public void setProviderClass(Class<? extends ValidationProvider<?>> providerClass)

Set ValidationProvider class.

Parameters:

providerClass - the provider type

setExecutableValidation

public void setExecutableValidation(Collection<ExecutableType> executableValidation)

getExecutableValidation

public Collection<ExecutableType> getExecutableValidation()

getClosable

public Closeable getClosable()

traversableResolverClass

public void traversableResolverClass(Class<TraversableResolver> clazz)

constraintValidatorFactoryClass

public void constraintValidatorFactoryClass(Class<ConstraintValidatorFactory> clazz)

messageInterpolatorClass

public void messageInterpolatorClass(Class<MessageInterpolator> clazz)

parameterNameProviderClass

public void parameterNameProviderClass(Class<? extends ParameterNameProvider> clazz)