org.elasticsearch.common.cli

Class CheckFileCommand

java.lang.Object

org.elasticsearch.common.cli.CliTool.Command

org.elasticsearch.common.cli.CheckFileCommand

public abstract class CheckFileCommand
extends CliTool.Command

A helper command that checks if configured paths have been changed when running a CLI command. It is only executed in case of specified paths by the command and if the paths underlying filesystem supports posix permissions. If this is the case, a warn message is issued whenever an owner, a group or the file permissions is changed by the command being executed and not configured back to its prior state, which should be the task of the command being executed.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.common.cli.CliTool.Command

CliTool.Command.Exit, CliTool.Command.Help

Field Summary

Fields inherited from class org.elasticsearch.common.cli.CliTool.Command

terminal

Constructor Summary

Constructors

Constructor and Description
CheckFileCommand(Terminal terminal)

Method Summary

Methods

Modifier and Type	Method and Description
abstract CliTool.ExitStatus	doExecute(Settings settings, Environment env) abstract method, which should implement the same logic as CliTool.Command.execute(), but is wrapped
CliTool.ExitStatus	execute(Settings settings, Environment env)
protected abstract Path[]	pathsForPermissionsCheck(Settings settings, Environment env) Returns the array of paths, that should be checked if the permissions, user or groups have changed before and after execution of the command

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckFileCommand

public CheckFileCommand(Terminal terminal)

Method Detail

doExecute

public abstract CliTool.ExitStatus doExecute(Settings settings,
                           Environment env)
                                      throws Exception

abstract method, which should implement the same logic as CliTool.Command.execute(), but is wrapped

Throws:

Exception

pathsForPermissionsCheck

protected abstract Path[] pathsForPermissionsCheck(Settings settings,
                              Environment env)
                                            throws Exception

Returns the array of paths, that should be checked if the permissions, user or groups have changed before and after execution of the command

Throws:

Exception

execute

public CliTool.ExitStatus execute(Settings settings,
                         Environment env)
                           throws Exception

Specified by:

execute in class CliTool.Command

Throws:

Exception