org.apache.bval.jsr

Class ConfigurationImpl

java.lang.Object

org.apache.bval.jsr.ConfigurationImpl

All Implemented Interfaces:

javax.validation.Configuration<ApacheValidatorConfiguration>, javax.validation.spi.ConfigurationState, ApacheValidatorConfiguration

public class ConfigurationImpl
extends Object
implements ApacheValidatorConfiguration, javax.validation.spi.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 javax.validation.BootstrapConfiguration	bootstrapConfiguration
protected javax.validation.ConstraintValidatorFactory	constraintValidatorFactory
protected Class<? extends javax.validation.ConstraintValidatorFactory>	constraintValidatorFactoryClass
protected javax.validation.ConstraintValidatorFactory	defaultConstraintValidatorFactory Configured ConstraintValidatorFactory
protected javax.validation.MessageInterpolator	defaultMessageInterpolator Configured MessageInterpolator
protected javax.validation.ParameterNameProvider	defaultParameterNameProvider
protected javax.validation.TraversableResolver	defaultTraversableResolver
protected Collection<javax.validation.executable.ExecutableType>	executableValidation
protected javax.validation.MessageInterpolator	messageInterpolator
protected Class<? extends javax.validation.MessageInterpolator>	messageInterpolatorClass
protected javax.validation.ParameterNameProvider	parameterNameProvider
protected Class<? extends javax.validation.ParameterNameProvider>	parameterNameProviderClass
protected javax.validation.spi.ValidationProvider<?>	provider Configured ValidationProvider
protected Class<? extends javax.validation.spi.ValidationProvider<?>>	providerClass Configured ValidationProvider class
protected javax.validation.ValidationProviderResolver	providerResolver Configured ValidationProviderResolver
protected javax.validation.TraversableResolver	traversableResolver
protected Class<? extends javax.validation.TraversableResolver>	traversableResolverClass

Constructor Summary

Constructors

Constructor and Description
ConfigurationImpl(javax.validation.spi.BootstrapState aState, javax.validation.spi.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.
javax.validation.ValidatorFactory	buildValidatorFactory() main factory method to build a ValidatorFactory
ConfigurationImpl	constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintFactory)
void	constraintValidatorFactoryClass(Class<javax.validation.ConstraintValidatorFactory> clazz)
javax.validation.BootstrapConfiguration	getBootstrapConfiguration()
Closeable	getClosable()
javax.validation.ConstraintValidatorFactory	getConstraintValidatorFactory()
javax.validation.ConstraintValidatorFactory	getDefaultConstraintValidatorFactory()
javax.validation.MessageInterpolator	getDefaultMessageInterpolator()
javax.validation.ParameterNameProvider	getDefaultParameterNameProvider()
javax.validation.TraversableResolver	getDefaultTraversableResolver()
Collection<javax.validation.executable.ExecutableType>	getExecutableValidation()
Set<InputStream>	getMappingStreams()
javax.validation.MessageInterpolator	getMessageInterpolator()
javax.validation.ParameterNameProvider	getParameterNameProvider()
Map<String,String>	getProperties() Return a map of non type-safe custom properties.
javax.validation.spi.ValidationProvider<?>	getProvider() Get the configured ValidationProvider.
javax.validation.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(javax.validation.MessageInterpolator resolver)
void	messageInterpolatorClass(Class<javax.validation.MessageInterpolator> clazz)
ApacheValidatorConfiguration	parameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider)
void	parameterNameProviderClass(Class<? extends javax.validation.ParameterNameProvider> clazz)
void	setExecutableValidation(Collection<javax.validation.executable.ExecutableType> executableValidation)
void	setProviderClass(Class<? extends javax.validation.spi.ValidationProvider<?>> providerClass) Set ValidationProvider class.
ApacheValidatorConfiguration	traversableResolver(javax.validation.TraversableResolver resolver)
void	traversableResolverClass(Class<javax.validation.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 javax.validation.spi.ValidationProvider<?> provider

Configured ValidationProvider

providerResolver

protected final javax.validation.ValidationProviderResolver providerResolver

Configured ValidationProviderResolver

providerClass

protected Class<? extends javax.validation.spi.ValidationProvider<?>> providerClass

Configured ValidationProvider class

defaultMessageInterpolator

protected javax.validation.MessageInterpolator defaultMessageInterpolator

Configured MessageInterpolator

messageInterpolator

protected javax.validation.MessageInterpolator messageInterpolator

messageInterpolatorClass

protected Class<? extends javax.validation.MessageInterpolator> messageInterpolatorClass

defaultConstraintValidatorFactory

protected javax.validation.ConstraintValidatorFactory defaultConstraintValidatorFactory

Configured ConstraintValidatorFactory

constraintValidatorFactory

protected javax.validation.ConstraintValidatorFactory constraintValidatorFactory

constraintValidatorFactoryClass

protected Class<? extends javax.validation.ConstraintValidatorFactory> constraintValidatorFactoryClass

defaultTraversableResolver

protected javax.validation.TraversableResolver defaultTraversableResolver

traversableResolver

protected javax.validation.TraversableResolver traversableResolver

traversableResolverClass

protected Class<? extends javax.validation.TraversableResolver> traversableResolverClass

defaultParameterNameProvider

protected javax.validation.ParameterNameProvider defaultParameterNameProvider

parameterNameProvider

protected javax.validation.ParameterNameProvider parameterNameProvider

parameterNameProviderClass

protected Class<? extends javax.validation.ParameterNameProvider> parameterNameProviderClass

bootstrapConfiguration

protected javax.validation.BootstrapConfiguration bootstrapConfiguration

executableValidation

protected Collection<javax.validation.executable.ExecutableType> executableValidation

Constructor Detail

ConfigurationImpl

public ConfigurationImpl(javax.validation.spi.BootstrapState aState,
                         javax.validation.spi.ValidationProvider<?> aProvider)

Create a new ConfigurationImpl instance.

Parameters:

aState - bootstrap state

aProvider - provider

Method Detail

traversableResolver

public ApacheValidatorConfiguration traversableResolver(javax.validation.TraversableResolver resolver)

Specified by:

traversableResolver in interface javax.validation.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 javax.validation.Configuration<ApacheValidatorConfiguration>

Returns:

this

messageInterpolator

public ConfigurationImpl messageInterpolator(javax.validation.MessageInterpolator resolver)

Specified by:

messageInterpolator in interface javax.validation.Configuration<ApacheValidatorConfiguration>

constraintValidatorFactory

public ConfigurationImpl constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintFactory)

Specified by:

constraintValidatorFactory in interface javax.validation.Configuration<ApacheValidatorConfiguration>

parameterNameProvider

public ApacheValidatorConfiguration parameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider)

Specified by:

parameterNameProvider in interface javax.validation.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 javax.validation.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 javax.validation.Configuration<ApacheValidatorConfiguration>

Returns:

this

getDefaultMessageInterpolator

public javax.validation.MessageInterpolator getDefaultMessageInterpolator()

Specified by:

getDefaultMessageInterpolator in interface javax.validation.Configuration<ApacheValidatorConfiguration>

getDefaultTraversableResolver

public javax.validation.TraversableResolver getDefaultTraversableResolver()

Specified by:

getDefaultTraversableResolver in interface javax.validation.Configuration<ApacheValidatorConfiguration>

getDefaultConstraintValidatorFactory

public javax.validation.ConstraintValidatorFactory getDefaultConstraintValidatorFactory()

Specified by:

getDefaultConstraintValidatorFactory in interface javax.validation.Configuration<ApacheValidatorConfiguration>

getDefaultParameterNameProvider

public javax.validation.ParameterNameProvider getDefaultParameterNameProvider()

Specified by:

getDefaultParameterNameProvider in interface javax.validation.Configuration<ApacheValidatorConfiguration>

getProperties

public Map<String,String> getProperties()

Return a map of non type-safe custom properties.

Specified by:

getProperties in interface javax.validation.spi.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 javax.validation.spi.ConfigurationState

Returns:

true

getMappingStreams

public Set<InputStream> getMappingStreams()

Specified by:

getMappingStreams in interface javax.validation.spi.ConfigurationState

getMessageInterpolator

public javax.validation.MessageInterpolator getMessageInterpolator()

Specified by:

getMessageInterpolator in interface javax.validation.spi.ConfigurationState

getBootstrapConfiguration

public javax.validation.BootstrapConfiguration getBootstrapConfiguration()

Specified by:

getBootstrapConfiguration in interface javax.validation.Configuration<ApacheValidatorConfiguration>

buildValidatorFactory

public javax.validation.ValidatorFactory buildValidatorFactory()

main factory method to build a ValidatorFactory

Specified by:

buildValidatorFactory in interface javax.validation.Configuration<ApacheValidatorConfiguration>

Throws:

javax.validation.ValidationException - if the ValidatorFactory cannot be built

getConstraintValidatorFactory

public javax.validation.ConstraintValidatorFactory getConstraintValidatorFactory()

Specified by:

getConstraintValidatorFactory in interface javax.validation.spi.ConfigurationState

Returns:

the constraint validator factory of this configuration.

getTraversableResolver

public javax.validation.TraversableResolver getTraversableResolver()

Specified by:

getTraversableResolver in interface javax.validation.spi.ConfigurationState

getParameterNameProvider

public javax.validation.ParameterNameProvider getParameterNameProvider()

Specified by:

getParameterNameProvider in interface javax.validation.spi.ConfigurationState

getProvider

public javax.validation.spi.ValidationProvider<?> getProvider()

Get the configured ValidationProvider.

Returns:

ValidationProvider

setProviderClass

public void setProviderClass(Class<? extends javax.validation.spi.ValidationProvider<?>> providerClass)

Set ValidationProvider class.

Parameters:

providerClass - the provider type

setExecutableValidation

public void setExecutableValidation(Collection<javax.validation.executable.ExecutableType> executableValidation)

getExecutableValidation

public Collection<javax.validation.executable.ExecutableType> getExecutableValidation()

getClosable

public Closeable getClosable()

traversableResolverClass

public void traversableResolverClass(Class<javax.validation.TraversableResolver> clazz)

constraintValidatorFactoryClass

public void constraintValidatorFactoryClass(Class<javax.validation.ConstraintValidatorFactory> clazz)

messageInterpolatorClass

public void messageInterpolatorClass(Class<javax.validation.MessageInterpolator> clazz)

parameterNameProviderClass

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