com.google.api.server.spi.tools

Class EndpointsToolAction

java.lang.Object

com.google.appengine.tools.util.Action

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

Direct Known Subclasses:

GenApiConfigAction, GenClientLibAction, GetClientLibAction, GetDiscoveryDocAction, GetOpenApiDocAction, HelpAction

public abstract class EndpointsToolAction
extends com.google.appengine.tools.util.Action

Base class for Actions used by the Cloud Endpoints command line tool. Users can use Endpoints command line tool to generate client library bundles and discovery docs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EndpointsToolAction.EndpointsOption Base class for Options used by the Cloud Endpoints tool.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_BASE_PATH_LONG
static java.lang.String	OPTION_BASE_PATH_SHORT
static java.lang.String	OPTION_BUILD_SYSTEM_LONG
static java.lang.String	OPTION_BUILD_SYSTEM_SHORT
static java.lang.String	OPTION_CLASS_PATH_LONG
static java.lang.String	OPTION_CLASS_PATH_SHORT
static java.lang.String	OPTION_DEBUG
static java.lang.String	OPTION_FORMAT_LONG
static java.lang.String	OPTION_FORMAT_SHORT
static java.lang.String	OPTION_HOSTNAME_LONG
static java.lang.String	OPTION_HOSTNAME_SHORT
static java.lang.String	OPTION_LANGUAGE_LONG
static java.lang.String	OPTION_LANGUAGE_SHORT
static java.lang.String	OPTION_OUTPUT_DIR_LONG
static java.lang.String	OPTION_OUTPUT_DIR_SHORT
static java.lang.String	OPTION_WAR_LONG
static java.lang.String	OPTION_WAR_SHORT

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

extraOptions, shortDescription

Constructor Summary

Constructors

Constructor and Description
EndpointsToolAction(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	apply()
protected java.net.URL[]	computeClassPath(java.lang.String warPath, java.lang.String classPath) Computes an array of URLs representing a classpath for a WAR directory.
abstract boolean	execute() Executes the command with the given arguments.
protected java.lang.String	getBasePath(com.google.appengine.tools.util.Option basePathOption)
protected java.lang.String	getBuildSystem(com.google.appengine.tools.util.Option buildSystemOption)
protected java.lang.String	getClassPath(com.google.appengine.tools.util.Option classPathOption)
protected boolean	getDebug(com.google.appengine.tools.util.Option debugOption)
java.lang.String	getExampleString() Return the example string which will be displayed in the usage.
protected java.lang.String	getFormat(com.google.appengine.tools.util.Option formatOption)
protected java.util.List<java.lang.String>	getHelpLines()
protected java.lang.String	getHostname(com.google.appengine.tools.util.Option hostnameOption, java.lang.String warPath)
protected java.lang.String	getLanguage(com.google.appengine.tools.util.Option languageOption)
protected java.lang.String	getOpenApiOutputPath(com.google.appengine.tools.util.Option outputOption)
protected java.lang.String	getOptionOrDefault(com.google.appengine.tools.util.Option option, java.lang.String defaultValue)
protected java.lang.String	getOutputPath(com.google.appengine.tools.util.Option outputOption)
protected java.util.List<java.lang.String>	getServiceClassNames(java.lang.String warPath)
abstract java.lang.String	getUsageString() Returns a usage string for help output.
protected java.lang.String	getWarOutputPath(com.google.appengine.tools.util.Option outputOption, java.lang.String warPath)
protected java.lang.String	getWarPath(com.google.appengine.tools.util.Option warOption)
boolean	isHelpDisplayNeeded() Tells whether help lines of this action needs to be displayed in the usage.
protected com.google.appengine.tools.util.Option	makeBasePathOption()
protected com.google.appengine.tools.util.Option	makeBuildSystemOption()
protected com.google.appengine.tools.util.Option	makeClassPathOption()
protected com.google.appengine.tools.util.Option	makeDebugOption()
protected com.google.appengine.tools.util.Option	makeFormatOption()
protected com.google.appengine.tools.util.Option	makeHostnameOption()
protected com.google.appengine.tools.util.Option	makeLanguageOption()
protected com.google.appengine.tools.util.Option	makeOpenApiOutputOption()
protected com.google.appengine.tools.util.Option	makeOutputOption()
protected com.google.appengine.tools.util.Option	makeWarOption()
protected com.google.appengine.tools.util.Option	makeWarOutputOption()
void	setExampleString(java.lang.String exampleString) Set the example string which will be displayed in the usage.
void	setHelpDisplayNeeded(boolean helpDisplayNeeded) Controls whether the help lines of the action need to be displayed in the usage.

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

OPTION_CLASS_PATH_SHORT

public static final java.lang.String OPTION_CLASS_PATH_SHORT

See Also:

Constant Field Values

OPTION_CLASS_PATH_LONG

public static final java.lang.String OPTION_CLASS_PATH_LONG

See Also:

Constant Field Values

OPTION_OUTPUT_DIR_SHORT

public static final java.lang.String OPTION_OUTPUT_DIR_SHORT

See Also:

Constant Field Values

OPTION_OUTPUT_DIR_LONG

public static final java.lang.String OPTION_OUTPUT_DIR_LONG

See Also:

Constant Field Values

OPTION_WAR_SHORT

public static final java.lang.String OPTION_WAR_SHORT

See Also:

Constant Field Values

OPTION_WAR_LONG

public static final java.lang.String OPTION_WAR_LONG

See Also:

Constant Field Values

OPTION_LANGUAGE_SHORT

public static final java.lang.String OPTION_LANGUAGE_SHORT

See Also:

Constant Field Values

OPTION_LANGUAGE_LONG

public static final java.lang.String OPTION_LANGUAGE_LONG

See Also:

Constant Field Values

OPTION_BUILD_SYSTEM_SHORT

public static final java.lang.String OPTION_BUILD_SYSTEM_SHORT

See Also:

Constant Field Values

OPTION_BUILD_SYSTEM_LONG

public static final java.lang.String OPTION_BUILD_SYSTEM_LONG

See Also:

Constant Field Values

OPTION_FORMAT_SHORT

public static final java.lang.String OPTION_FORMAT_SHORT

See Also:

Constant Field Values

OPTION_FORMAT_LONG

public static final java.lang.String OPTION_FORMAT_LONG

See Also:

Constant Field Values

OPTION_DEBUG

public static final java.lang.String OPTION_DEBUG

See Also:

Constant Field Values

OPTION_HOSTNAME_SHORT

public static final java.lang.String OPTION_HOSTNAME_SHORT

See Also:

Constant Field Values

OPTION_HOSTNAME_LONG

public static final java.lang.String OPTION_HOSTNAME_LONG

See Also:

Constant Field Values

OPTION_BASE_PATH_SHORT

public static final java.lang.String OPTION_BASE_PATH_SHORT

See Also:

Constant Field Values

OPTION_BASE_PATH_LONG

public static final java.lang.String OPTION_BASE_PATH_LONG

See Also:

Constant Field Values

Constructor Detail

EndpointsToolAction

public EndpointsToolAction(java.lang.String name)

Method Detail

getUsageString

public abstract java.lang.String getUsageString()

Returns a usage string for help output.

execute

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

Executes the command with the given arguments.

Returns:

whether or not all required arguments were provided

Throws:

java.lang.ClassNotFoundException

java.io.IOException

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

apply

public void apply()

Specified by:

apply in class com.google.appengine.tools.util.Action

getHelpLines

protected java.util.List<java.lang.String> getHelpLines()

Overrides:

getHelpLines in class com.google.appengine.tools.util.Action

getWarPath

protected java.lang.String getWarPath(com.google.appengine.tools.util.Option warOption)

getOutputPath

protected java.lang.String getOutputPath(com.google.appengine.tools.util.Option outputOption)

getWarOutputPath

protected java.lang.String getWarOutputPath(com.google.appengine.tools.util.Option outputOption,
                                            java.lang.String warPath)

getOpenApiOutputPath

protected java.lang.String getOpenApiOutputPath(com.google.appengine.tools.util.Option outputOption)

getClassPath

protected java.lang.String getClassPath(com.google.appengine.tools.util.Option classPathOption)

getLanguage

protected java.lang.String getLanguage(com.google.appengine.tools.util.Option languageOption)

getBuildSystem

protected java.lang.String getBuildSystem(com.google.appengine.tools.util.Option buildSystemOption)

getFormat

protected java.lang.String getFormat(com.google.appengine.tools.util.Option formatOption)

getDebug

protected boolean getDebug(com.google.appengine.tools.util.Option debugOption)

getHostname

protected java.lang.String getHostname(com.google.appengine.tools.util.Option hostnameOption,
                                       java.lang.String warPath)

getBasePath

protected java.lang.String getBasePath(com.google.appengine.tools.util.Option basePathOption)

getOptionOrDefault

protected java.lang.String getOptionOrDefault(com.google.appengine.tools.util.Option option,
                                              java.lang.String defaultValue)

makeWarOption

protected com.google.appengine.tools.util.Option makeWarOption()

makeOutputOption

protected com.google.appengine.tools.util.Option makeOutputOption()

makeWarOutputOption

protected com.google.appengine.tools.util.Option makeWarOutputOption()

makeOpenApiOutputOption

protected com.google.appengine.tools.util.Option makeOpenApiOutputOption()

makeClassPathOption

protected com.google.appengine.tools.util.Option makeClassPathOption()

makeLanguageOption

protected com.google.appengine.tools.util.Option makeLanguageOption()

makeBuildSystemOption

protected com.google.appengine.tools.util.Option makeBuildSystemOption()

makeFormatOption

protected com.google.appengine.tools.util.Option makeFormatOption()

makeDebugOption

protected com.google.appengine.tools.util.Option makeDebugOption()

makeHostnameOption

protected com.google.appengine.tools.util.Option makeHostnameOption()

makeBasePathOption

protected com.google.appengine.tools.util.Option makeBasePathOption()

computeClassPath

protected java.net.URL[] computeClassPath(java.lang.String warPath,
                                          java.lang.String classPath)
                                   throws java.net.MalformedURLException

Computes an array of URLs representing a classpath for a WAR directory. Given the path to a WAR, it adds the classes subdirectory and any JAR file under the lib subdirectory.

Parameters:

warPath - a path to a directory with a WAR structure

classPath - a list of class path entries separated by File.pathSeparator.

Throws:

java.net.MalformedURLException

getServiceClassNames

protected java.util.List<java.lang.String> getServiceClassNames(java.lang.String warPath)

isHelpDisplayNeeded

public boolean isHelpDisplayNeeded()

Tells whether help lines of this action needs to be displayed in the usage.

setHelpDisplayNeeded

public void setHelpDisplayNeeded(boolean helpDisplayNeeded)

Controls whether the help lines of the action need to be displayed in the usage.

getExampleString

public java.lang.String getExampleString()

Return the example string which will be displayed in the usage.

setExampleString

public void setExampleString(java.lang.String exampleString)

Set the example string which will be displayed in the usage.