com.google.api.server.spi.config.validation

Class ApiConfigValidator

java.lang.Object

com.google.api.server.spi.config.validation.ApiConfigValidator

public class ApiConfigValidator
extends java.lang.Object

Validation provider for Swarm endpoint configurations. Contains all SPI-level checks for what constitutes a valid API or configuration.

Constructor Summary

Constructors

Constructor and Description
ApiConfigValidator(TypeLoader typeLoader, SchemaRepository schemaRepository)

Method Summary

Modifier and Type	Method and Description
void	validate(ApiConfig config) Makes sure the contained configuration is valid and can be turned into a *.api file.
void	validate(java.lang.Iterable<? extends ApiConfig> apiConfigs) Validates all configurations for a single API.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiConfigValidator

public ApiConfigValidator(TypeLoader typeLoader,
                          SchemaRepository schemaRepository)

Method Detail

validate

public void validate(java.lang.Iterable<? extends ApiConfig> apiConfigs)
              throws ApiConfigInvalidException,
                     ApiClassConfigInvalidException,
                     ApiMethodConfigInvalidException,
                     ApiParameterConfigInvalidException

Validates all configurations for a single API. Makes sure the API-level configuration matches for all classes and that the contained configuration is valid and can be turned into a *.api file. Only checks for swarm-specific validity. Apiary FE may still dislike a config for its own reasons.

Throws:

ApiConfigInvalidException - on any invalid API-wide configuration.

ApiClassConfigInvalidException - on any invalid API class configuration.

ApiMethodConfigInvalidException - on any invalid API method configuration.

ApiParameterConfigInvalidException - on any invalid API parameter configuration.

validate

public void validate(ApiConfig config)
              throws ApiClassConfigInvalidException,
                     ApiMethodConfigInvalidException,
                     ApiParameterConfigInvalidException,
                     ApiConfigInvalidException

Makes sure the contained configuration is valid and can be turned into a *.api file. Only checks for swarm-specific validity. Apiary FE may still dislike a config for its own reasons.

Throws:

ApiClassConfigInvalidException - on any invalid API class or API configuration.

ApiMethodConfigInvalidException - on any invalid API method configuration.

ApiParameterConfigInvalidException - on any invalid API parameter configuration.

ApiConfigInvalidException