javax.validation.spi.ValidationProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation
Java(TM) EE 7 Specification APIs
There is a newer version: 8.0.1
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, 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.ValidationException;
import javax.validation.ValidationProviderResolver;
import javax.validation.ValidatorFactory;

/**
 * Contract between the validation bootstrap mechanism and the provider engine.
 * 
 * Implementations must have a public no-arg constructor. The construction of a provider
 * should be as "lightweight" as possible.
 *
 * {@code T} represents the provider specific Configuration subclass
 * which typically host provider's additional configuration methods.
 *
 * @author Emmanuel Bernard
 * @author Hardy Ferentschik
 */
public interface ValidationProvider> {

	/**
	 * Returns a {@link Configuration} instance implementing {@code T},
	 * the {@code Configuration} sub-interface.
	 * The returned {@code Configuration} instance must use the current provider
	 * ({@code this}) to build the {@code ValidatorFactory} instance.
	 *
	 * @param state bootstrap state
	 * @return specific {@code Configuration} implementation
	 */
	T createSpecializedConfiguration(BootstrapState state);

	/**
	 * Returns a {@link Configuration} instance. This instance is not bound to
	 * use the current provider. The choice of provider follows the algorithm described
	 * in {@code Configuration}
	 * 

	 * The {@link ValidationProviderResolver} used by {@code Configuration}
	 * is provided by {@code state}.
	 * If null, the default {@code ValidationProviderResolver} is used.
	 *
	 * @param state bootstrap state
	 * @return non specialized Configuration implementation
	 */
	Configuration createGenericConfiguration(BootstrapState state);

	/**
	 * Build a {@link ValidatorFactory} using the current provider implementation.
	 * 

	 * The {@code ValidatorFactory} is assembled and follows the configuration passed
	 * via {@link ConfigurationState}.
	 * 
	 * The returned {@code ValidatorFactory} is properly initialized and ready for use.
	 *
	 * @param configurationState the configuration descriptor
	 * @return the instantiated {@code ValidatorFactory}
	 * @throws ValidationException if the {@code ValidatorFactory} cannot be built
	 */
	ValidatorFactory buildValidatorFactory(ConfigurationState configurationState);
}