com.google.api.server.spi.config.datastore

Class ApiConfigDatastoreReader

java.lang.Object

com.google.api.server.spi.config.datastore.ApiConfigDatastoreReader

All Implemented Interfaces:

ApiConfigSource

public final class ApiConfigDatastoreReader
extends java.lang.Object
implements ApiConfigSource

Configuration source for configuration data stored in appengine datastore.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENDPOINT_CONFIGURATION_KIND
static java.lang.String	METHOD_CONFIGURATION_KIND

Constructor Summary

Constructors

Constructor and Description
ApiConfigDatastoreReader()
ApiConfigDatastoreReader(com.google.appengine.api.datastore.DatastoreService datastoreService, com.google.appengine.api.memcache.AsyncMemcacheService memcacheService)

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.

Methods inherited from class java.lang.Object

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

Field Detail

ENDPOINT_CONFIGURATION_KIND

public static final java.lang.String ENDPOINT_CONFIGURATION_KIND

See Also:

Constant Field Values

METHOD_CONFIGURATION_KIND

public static final java.lang.String METHOD_CONFIGURATION_KIND

See Also:

Constant Field Values

Constructor Detail

ApiConfigDatastoreReader

public ApiConfigDatastoreReader(com.google.appengine.api.datastore.DatastoreService datastoreService,
                                com.google.appengine.api.memcache.AsyncMemcacheService memcacheService)

ApiConfigDatastoreReader

public ApiConfigDatastoreReader()

Method Detail

loadEndpointClass

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

Description copied from interface: ApiConfigSource

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

Specified by:

loadEndpointClass in interface ApiConfigSource

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

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

Description copied from interface: ApiConfigSource

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

Specified by:

loadEndpointMethods in interface ApiConfigSource

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.

isStaticConfig

public boolean isStaticConfig(ApiConfig config)

Description copied from interface: ApiConfigSource

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.

Specified by:

isStaticConfig in interface ApiConfigSource

Parameters:

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