org.elasticsearch.cli

Class EnvironmentAwareCommand

java.lang.Object

org.elasticsearch.cli.Command

org.elasticsearch.cli.EnvironmentAwareCommand

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

TruncateTranslogCommand

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 and Description
EnvironmentAwareCommand(java.lang.String description)

Method Summary

Modifier and Type	Method and Description
protected Environment	createEnv(Terminal terminal, java.util.Map<java.lang.String,java.lang.String> settings) Create an Environment for the command to use.
protected void	execute(Terminal terminal, joptsimple.OptionSet options) Executes this command.
protected abstract void	execute(Terminal terminal, joptsimple.OptionSet options, Environment env) Execute the command with the initialized Environment.
protected static void	putSystemPropertyIfSettingIsMissing(java.util.Map<java.lang.String,java.lang.String> settings, java.lang.String setting, java.lang.String key) Ensure the given setting exists, reading it from system properties if not already set.

Methods inherited from class org.elasticsearch.cli.Command

addShutdownHook, close, exit, main, printAdditionalHelp, shouldConfigureLoggingWithoutConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentAwareCommand

public EnvironmentAwareCommand(java.lang.String description)

Method Detail

execute

protected void execute(Terminal terminal,
                       joptsimple.OptionSet options)
                throws java.lang.Exception

Description copied from class: Command

Executes this command. Any runtime user errors (like an input file that does not exist), should throw a UserException.

Specified by:

execute in class Command

Throws:

java.lang.Exception

createEnv

protected Environment createEnv(Terminal terminal,
                                java.util.Map<java.lang.String,java.lang.String> settings)

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

putSystemPropertyIfSettingIsMissing

protected static void putSystemPropertyIfSettingIsMissing(java.util.Map<java.lang.String,java.lang.String> settings,
                                                          java.lang.String setting,
                                                          java.lang.String key)

Ensure the given setting exists, reading it from system properties if not already set.

execute

protected abstract void execute(Terminal terminal,
                                joptsimple.OptionSet options,
                                Environment env)
                         throws java.lang.Exception

Execute the command with the initialized Environment.

Throws:

java.lang.Exception