Module org.elasticsearch.server

Package org.elasticsearch.common.cli

Class EnvironmentAwareCommand

java.lang.Object

org.elasticsearch.cli.Command

org.elasticsearch.common.cli.EnvironmentAwareCommand

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ElasticsearchNodeCommand, KeyStoreAwareCommand

public abstract class EnvironmentAwareCommand
extends Command

A cli command which requires an Environment to use current paths and settings.

Field Summary

Fields inherited from class org.elasticsearch.cli.Command

description, parser

Constructor Summary

Constructors

Constructor	Description
EnvironmentAwareCommand(String description)	Construct the command with the specified command description.

Method Summary

Modifier and Type	Method	Description
protected Environment	createEnv(joptsimple.OptionSet options, ProcessInfo processInfo)	Create an Environment for the command to use.
protected void	execute(Terminal terminal, joptsimple.OptionSet options, ProcessInfo processInfo)
abstract void	execute(Terminal terminal, joptsimple.OptionSet options, Environment env, ProcessInfo processInfo)	Execute the command with the initialized Environment.
protected Build.Type	getBuildType()

Methods inherited from class org.elasticsearch.cli.Command

close, exit, main, mainWithoutErrorHandling, parseOptions, printAdditionalHelp, printUserException

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentAwareCommand

public EnvironmentAwareCommand(String description)

Construct the command with the specified command description. This command will have logging configured without reading Elasticsearch configuration files.

Parameters:

description - the command description

Method Details

execute

protected void execute(Terminal terminal,
 joptsimple.OptionSet options,
 ProcessInfo processInfo)
                throws Exception

Specified by:

execute in class Command

Throws:

Exception

createEnv

protected Environment createEnv(joptsimple.OptionSet options,
 ProcessInfo processInfo)
                         throws UserException

Create an Environment for the command to use. Overrideable for tests.

Throws:

UserException

getBuildType

protected Build.Type getBuildType()

execute

public abstract void execute(Terminal terminal,
 joptsimple.OptionSet options,
 Environment env,
 ProcessInfo processInfo)
                      throws Exception

Execute the command with the initialized Environment.

Throws:

Exception