com.google.api.server.spi.config

Interface ApiConfigSource

All Known Implementing Classes:

ApiConfigAnnotationReader

public interface ApiConfigSource

Interface for any class that can read some swarm endpoint configuration from some source. May be capable of loading a complete configuration or may only support a subset of fields, in which case it may need to be used in conjunction with another source to get the rest of the configuration.

Method Summary

Modifier and Type	Method and Description
boolean	isStaticConfig(ApiConfig config) Returns true iff configuration from this source is static and cannot change between calls to this source.
void	loadEndpointClass(ServiceContext serviceContext, java.lang.Class<?> endpointClass, ApiConfig config) Loads all configuration data for the endpoint class from the configuration source into config.
void	loadEndpointMethods(ServiceContext serviceContext, java.lang.Class<?> endpointClass, ApiClassConfig.MethodConfigMap methodConfigMap) Loads all configuration data for the methods of the endpoint class from the configuration source into methodConfigMap.

Method Detail

loadEndpointClass

void loadEndpointClass(ServiceContext serviceContext,
                       java.lang.Class<?> endpointClass,
                       ApiConfig config)
                throws ApiConfigException

Loads all configuration data for the endpoint class from the configuration source into config. Does not include configuration data for the endpoint methods.

Parameters:

serviceContext - Provides context regarding GAE application settings.

endpointClass - Class object whose configuration data is being loaded.

config - Configuration as loaded so far with defaults and any already-read configurations. The ApiConfigSource will overwrite any values with those set by its config source.

Throws:

ApiConfigException

loadEndpointMethods

void loadEndpointMethods(ServiceContext serviceContext,
                         java.lang.Class<?> endpointClass,
                         ApiClassConfig.MethodConfigMap methodConfigMap)
                  throws ApiConfigException

Loads all configuration data for the methods of the endpoint class from the configuration source into methodConfigMap.

Parameters:

serviceContext - Provides context regarding GAE application settings.

endpointClass - Class object whose configuration data is being loaded.

methodConfigMap - A map of endpoint method to its configuration data. This data will can be read and/or overwritten by this method.

Throws:

ApiConfigException

isStaticConfig

boolean isStaticConfig(ApiConfig config)

Returns true iff configuration from this source is static and cannot change between calls to this source. This would be true, for example, when the config is loaded from annotations on the java classes.

Parameters:

config - Configuration as loaded so far with defaults and any already-read configurations.