Package com.google.api.server.spi.config.annotationreader

Class ApiConfigAnnotationReader

java.lang.Object

com.google.api.server.spi.config.annotationreader.ApiConfigAnnotationReader

All Implemented Interfaces:

ApiConfigSource

public class ApiConfigAnnotationReader
extends Object
implements ApiConfigSource

Reads annotations on endpoint classes to produce an api configuration.

Author:

Eric Orth

Constructor Summary

Constructors

Constructor	Description
ApiConfigAnnotationReader()
ApiConfigAnnotationReader(Map<String,Class<? extends Annotation>> annotationTypes)

Method Summary

Modifier and Type	Method	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, Class<?> endpointClass, ApiConfig config)	Loads all configuration data for the endpoint class from the configuration source into config.
void	loadEndpointMethods(ServiceContext serviceContext, Class<?> endpointClass, ApiClassConfig.MethodConfigMap methodConfigMap)	Loads all configuration data for the methods of the endpoint class from the configuration source into methodConfigMap.
protected void	readApiAuth(com.google.api.server.spi.config.annotationreader.ApiAuthAnnotationConfig config, Annotation auth)	Converts the auth config from the auth annotation.
protected void	readApiNamespace(ApiNamespaceAnnotationConfig config, Annotation namespace)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiConfigAnnotationReader

public ApiConfigAnnotationReader()
                          throws ClassNotFoundException

Throws:

ClassNotFoundException

ApiConfigAnnotationReader

public ApiConfigAnnotationReader(Map<String,Class<? extends Annotation>> annotationTypes)

Method Detail

loadEndpointClass

public void loadEndpointClass(ServiceContext serviceContext,
                              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,
                                Class<?> endpointClass,
                                ApiClassConfig.MethodConfigMap methodConfigMap)
                         throws ApiConfigException

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.

Throws:

ApiConfigException

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.

readApiAuth

protected void readApiAuth(com.google.api.server.spi.config.annotationreader.ApiAuthAnnotationConfig config,
                           Annotation auth)
                    throws NoSuchMethodException,
                           IllegalAccessException,
                           InvocationTargetException

Converts the auth config from the auth annotation. Subclasses may override to add additional information to the auth config.

Throws:

NoSuchMethodException

IllegalAccessException

InvocationTargetException

readApiNamespace

protected void readApiNamespace(ApiNamespaceAnnotationConfig config,
                                Annotation namespace)
                         throws IllegalAccessException,
                                InvocationTargetException,
                                NoSuchMethodException

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException