javax.validation.spi.ConfigurationState Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2009-2012, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.validation.spi;
import javax.validation.Configuration;
import javax.validation.ConstraintValidatorFactory;
import javax.validation.MessageInterpolator;
import javax.validation.ParameterNameProvider;
import javax.validation.TraversableResolver;
import javax.validation.ValidatorFactory;
import java.io.InputStream;
import java.util.Map;
import java.util.Set;
/**
* Contract between a {@link Configuration} and a
* {@link ValidationProvider} to create a {@link ValidatorFactory}.
*
* The configuration artifacts defined in the XML configuration and provided to the
* {@code Configuration} are merged and passed along via
* {@code ConfigurationState}.
*
* @author Emmanuel Bernard
* @author Hardy Ferentschik
* @author Gunnar Morling
*/
public interface ConfigurationState {
/**
* Returns {@code true} if {@link Configuration#ignoreXmlConfiguration()} has been called.
*
* In this case, the {@link ValidatorFactory} must ignore
* {@code META-INF/validation.xml}.
*
* @return {@code true} if {@code META-INF/validation.xml} should be ignored
*/
boolean isIgnoreXmlConfiguration();
/**
* Returns the message interpolator of this configuration.
*
* Message interpolator is defined in the following decreasing priority:
*
* - set via the {@link Configuration} programmatic API
* - defined in {@code META-INF/validation.xml} provided that
* {@code ignoreXmlConfiguration} is false. In this case the instance
* is created via its no-arg constructor.
* - {@code null} if undefined.
*
*
* @return message interpolator instance or {@code null} if not defined
*/
MessageInterpolator getMessageInterpolator();
/**
* Returns a set of configuration streams.
*
* The streams are defined by:
*
* - mapping XML streams passed programmatically in {@link Configuration}
* - mapping XML streams located in the resources defined in
* {@code META-INF/validation.xml} (constraint-mapping element)
*
*
* Streams represented in the XML configuration and opened by the
* {@code Configuration} implementation must be closed by the
* {@code Configuration} implementation after the {@link ValidatorFactory}
* creation (or if an exception occurs). All streams are guaranteed to
* adhere to the mark/reset contract (see {@link InputStream#markSupported()}
* by the Bean Validation provider.
*
* @return set of input stream
*/
Set getMappingStreams();
/**
* Returns the constraint validator factory of this configuration.
*
* The {@link ConstraintValidatorFactory} implementation is defined in the following
* decreasing priority:
*
* - set via the {@link Configuration} programmatic API
* - defined in {@code META-INF/validation.xml} provided that
* {@code ignoredXmlConfiguration} is {@code false}. In this case the instance
* is created via its no-arg constructor.
* - {@code null} if undefined.
*
*
* @return factory instance or {@code null} if not defined
*/
ConstraintValidatorFactory getConstraintValidatorFactory();
/**
* Returns the traversable resolver for this configuration.
*
* {@link TraversableResolver} is defined in the following decreasing priority:
*
* - set via the {@link Configuration} programmatic API
* - defined in {@code META-INF/validation.xml} provided that
* {@code ignoredXmlConfiguration} is {@code false}. In this case the
* instance is created via its no-arg constructor.
* - {@code null} if undefined.
*
*
* @return traversable resolver instance or {@code null} if not defined
*/
TraversableResolver getTraversableResolver();
/**
* Returns the parameter name provider for this configuration.
*
* {@link ParameterNameProvider} is defined in the following decreasing priority:
*
* - set via the {@link Configuration} programmatic API
* - defined in {@code META-INF/validation.xml} provided that
* {@code ignoreXmlConfiguration} is {@code false}. In this case the instance
* is created via its no-arg constructor.
* - {@code null} if undefined.
*
*
* @return parameter name provider instance or {@code null} if not defined
*
* @since 1.1
*/
ParameterNameProvider getParameterNameProvider();
/**
* Returns a map of non type-safe custom properties.
*
* Properties defined via:
*
* - {@link Configuration#addProperty(String, String)}
* - {@code META-INF/validation.xml} provided that
* {@code ignoreXmlConfiguration}
is {@code false}.
*
*
* If a property is defined both programmatically and in XML,
* the value defined programmatically has priority.
*
* @return {@code Map} whose key is the property key and the value
* the property value
*/
Map getProperties();
}