com.google.api.server.spi.tools

Class AnnotationApiConfigGenerator

java.lang.Object

com.google.api.server.spi.tools.AnnotationApiConfigGenerator

All Implemented Interfaces:

ApiConfigGenerator

public class AnnotationApiConfigGenerator
extends java.lang.Object
implements ApiConfigGenerator

Generates configuration files from annotations on endpoint classes.

Constructor Summary

Constructors

Constructor and Description
AnnotationApiConfigGenerator()
AnnotationApiConfigGenerator(com.google.api.server.spi.config.ApiConfigWriter apiConfigWriter, java.lang.ClassLoader classLoader, com.google.api.server.spi.config.model.ApiConfig.Factory configFactory)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	generateConfig(java.lang.Class<?>... serviceClasses) Generates API configuration file as a string for a set of service classes.
java.util.Map<java.lang.String,java.lang.String>	generateConfig(com.google.api.server.spi.ServiceContext serviceContext, java.lang.Class<?>... serviceClasses) Generates API configuration file as a string for a set of service classes given a default API name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationApiConfigGenerator

public AnnotationApiConfigGenerator()
                             throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

AnnotationApiConfigGenerator

public AnnotationApiConfigGenerator(com.google.api.server.spi.config.ApiConfigWriter apiConfigWriter,
                                    java.lang.ClassLoader classLoader,
                                    com.google.api.server.spi.config.model.ApiConfig.Factory configFactory)
                             throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

Method Detail

generateConfig

public java.util.Map<java.lang.String,java.lang.String> generateConfig(java.lang.Class<?>... serviceClasses)
                                                                throws com.google.api.server.spi.config.ApiConfigException

Description copied from interface: ApiConfigGenerator

Generates API configuration file as a string for a set of service classes.

Specified by:

generateConfig in interface ApiConfigGenerator

Parameters:

serviceClasses - Service classes to generate API configuration for.

Returns:

A map of API configuration JSON strings with <apiString>.<ext> as the key.

Throws:

com.google.api.server.spi.config.ApiConfigException

generateConfig

public java.util.Map<java.lang.String,java.lang.String> generateConfig(com.google.api.server.spi.ServiceContext serviceContext,
                                                                       java.lang.Class<?>... serviceClasses)
                                                                throws com.google.api.server.spi.config.ApiConfigException

Description copied from interface: ApiConfigGenerator

Generates API configuration file as a string for a set of service classes given a default API name.

Specified by:

generateConfig in interface ApiConfigGenerator

Parameters:

serviceContext - Service context used to retrieve information about the service.

serviceClasses - Service classes to generate API configuration for.

Returns:

A map of API configuration JSON strings with <apiString>.<ext> as the key.

Throws:

com.google.api.server.spi.config.ApiConfigException