com.google.api.server.spi.tools

Interface ApiConfigGenerator

All Known Implementing Classes:

AnnotationApiConfigGenerator, FakeApiConfigGenerator

public interface ApiConfigGenerator

API configuration generator.

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.

Method Detail

generateConfig

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

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

Parameters:

serviceClasses - Service classes to generate API configuration for.

Returns:

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

Throws:

java.io.IOException

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

generateConfig

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

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

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:

java.io.IOException

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