com.google.api.server.spi.config

Class ApiConfigLoader

java.lang.Object

com.google.api.server.spi.config.ApiConfigLoader

public class ApiConfigLoader
extends java.lang.Object

Loader for entire configurations for swarm endpoints. The current implementation hardcodes two configuration sources. First annotation configuration is read, then if requested by the config so far, datastore configuration is read, overriding the annotation configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTERNAL_API_NAME The common API name to use for all internal-mechanism endpoint classes loaded through loadInternalConfiguration.

Constructor Summary

Constructors

Constructor and Description
ApiConfigLoader() Constructor with basic defaults suitable for unit tests.
ApiConfigLoader(ApiConfig.Factory configFactory, TypeLoader typeLoader, ApiConfigAnnotationReader annotationSource, ApiConfigSource... apiConfigSources) Creates a ApiConfigLoader.

Method Summary

Modifier and Type	Method and Description
boolean	isStaticConfig(ApiConfig config)
ApiConfig	loadConfiguration(ServiceContext serviceContext, java.lang.Class<?> endpointClass)
ApiConfig	loadInternalConfiguration(ServiceContext serviceContext, java.lang.Class<?> endpointClass) Only used for internal-mechanism Apis.
ApiConfig	reloadConfiguration(ServiceContext serviceContext, java.lang.Class<?> endpointClass, ApiConfig oldConfig)

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_API_NAME

public static final java.lang.String INTERNAL_API_NAME

The common API name to use for all internal-mechanism endpoint classes loaded through loadInternalConfiguration.

See Also:

Constant Field Values

Constructor Detail

ApiConfigLoader

public ApiConfigLoader(ApiConfig.Factory configFactory,
                       TypeLoader typeLoader,
                       ApiConfigAnnotationReader annotationSource,
                       ApiConfigSource... apiConfigSources)

Creates a ApiConfigLoader.

Parameters:

configFactory - Factory class in charge of creating ApiConfigs.

typeLoader - Utility class for dealing with types in endpoint config generation.

annotationSource - Config source which reads annotations in endpoint classes.

apiConfigSources - Additional config sources, if any, to operate on endpoints.

Throws:

java.lang.IllegalArgumentException - if apiConfigSources includes another instance of ApiConfigAnnotationReader.

ApiConfigLoader

public ApiConfigLoader()
                throws java.lang.ClassNotFoundException

Constructor with basic defaults suitable for unit tests.

Throws:

java.lang.ClassNotFoundException

Method Detail

loadConfiguration

public ApiConfig loadConfiguration(ServiceContext serviceContext,
                                   java.lang.Class<?> endpointClass)
                            throws ApiConfigException

Throws:

ApiConfigException

loadInternalConfiguration

public ApiConfig loadInternalConfiguration(ServiceContext serviceContext,
                                           java.lang.Class<?> endpointClass)
                                    throws ApiConfigException

Only used for internal-mechanism Apis. Loads default values for class-wide configuration. Most validation is skipped/ignored as these Apis are not configurable and often follow different rules anyway.

Throws:

ApiConfigException

isStaticConfig

public boolean isStaticConfig(ApiConfig config)

reloadConfiguration

public ApiConfig reloadConfiguration(ServiceContext serviceContext,
                                     java.lang.Class<?> endpointClass,
                                     ApiConfig oldConfig)
                              throws ApiConfigException

Throws:

ApiConfigException