com.google.api.server.spi.tools

Class GenApiConfigAction

java.lang.Object

com.google.appengine.tools.util.Action

com.google.api.server.spi.tools.EndpointsToolAction

com.google.api.server.spi.tools.GenApiConfigAction

public class GenApiConfigAction
extends EndpointsToolAction

Command to generate API configuration from annotated service classes.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.server.spi.tools.EndpointsToolAction

EndpointsToolAction.EndpointsOption

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class com.google.api.server.spi.tools.EndpointsToolAction

OPTION_BASE_PATH_LONG, OPTION_BASE_PATH_SHORT, OPTION_BUILD_SYSTEM_LONG, OPTION_BUILD_SYSTEM_SHORT, OPTION_CLASS_PATH_LONG, OPTION_CLASS_PATH_SHORT, OPTION_DEBUG, OPTION_FORMAT_LONG, OPTION_FORMAT_SHORT, OPTION_HOSTNAME_LONG, OPTION_HOSTNAME_SHORT, OPTION_LANGUAGE_LONG, OPTION_LANGUAGE_SHORT, OPTION_OUTPUT_DIR_LONG, OPTION_OUTPUT_DIR_SHORT, OPTION_WAR_LONG, OPTION_WAR_SHORT

Fields inherited from class com.google.appengine.tools.util.Action

extraOptions, shortDescription

Constructor Summary

Constructors

Constructor and Description
GenApiConfigAction()

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes the command with the given arguments.
java.lang.Iterable<java.lang.String>	genApiConfig(java.net.URL[] classPath, java.lang.String outputDirPath, java.lang.String warPath, java.util.List<java.lang.String> serviceClassNames, boolean outputToDisk) Generates API configuration for an array of service classes.
java.lang.String	getUsageString() Returns a usage string for help output.

Methods inherited from class com.google.api.server.spi.tools.EndpointsToolAction

apply, computeClassPath, getBasePath, getBuildSystem, getClassPath, getDebug, getExampleString, getFormat, getHelpLines, getHostname, getLanguage, getOpenApiOutputPath, getOptionOrDefault, getOutputPath, getServiceClassNames, getWarOutputPath, getWarPath, isHelpDisplayNeeded, makeBasePathOption, makeBuildSystemOption, makeClassPathOption, makeDebugOption, makeFormatOption, makeHostnameOption, makeLanguageOption, makeOpenApiOutputOption, makeOutputOption, makeWarOption, makeWarOutputOption, setExampleString, setHelpDisplayNeeded

Methods inherited from class com.google.appengine.tools.util.Action

getArgs, getHelpString, getNames, getNameString, getOptions, getShortDescription, setArgs, setOptions, setShortDescription

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

GenApiConfigAction

public GenApiConfigAction()

Method Detail

execute

public boolean execute()
                throws java.lang.ClassNotFoundException,
                       java.io.IOException,
                       com.google.api.server.spi.config.ApiConfigException

Description copied from class: EndpointsToolAction

Executes the command with the given arguments.

Specified by:

execute in class EndpointsToolAction

Returns:

whether or not all required arguments were provided

Throws:

java.lang.ClassNotFoundException

java.io.IOException

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

genApiConfig

public java.lang.Iterable<java.lang.String> genApiConfig(java.net.URL[] classPath,
                                                         java.lang.String outputDirPath,
                                                         java.lang.String warPath,
                                                         java.util.List<java.lang.String> serviceClassNames,
                                                         boolean outputToDisk)
                                                  throws java.lang.ClassNotFoundException,
                                                         java.io.IOException,
                                                         com.google.api.server.spi.config.ApiConfigException

Generates API configuration for an array of service classes.

Parameters:

classPath - Class path to load service classes and their dependencies

outputDirPath - Directory to write API configuration files into

serviceClassNames - Array of service class names of the API

warPath - Directory or file containing a WAR layout

outputToDisk - Iff true, outputs a *.api file to disk for each API.

Returns:

JSON-formatted configurations for each API.

Throws:

java.lang.ClassNotFoundException

java.io.IOException

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

getUsageString

public java.lang.String getUsageString()

Description copied from class: EndpointsToolAction

Returns a usage string for help output.

Specified by:

getUsageString in class EndpointsToolAction