org.apache.ambari.server.utils

Class ShellCommandUtil

java.lang.Object

org.apache.ambari.server.utils.ShellCommandUtil

public class ShellCommandUtil
extends Object

Logs OpenSsl command exit code with description

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShellCommandUtil.InteractiveHandler InteractiveHandler is a handler for interactive sessions with command line commands.
static class	ShellCommandUtil.Result

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	LINUX Set to true when run on Linux platforms
static boolean	MAC Set to true when run on Mac OS platforms
static String	MASK_EVERYBODY_RWX Permission mask 777 allows everybody to read/modify/execute file
static String	MASK_OWNER_ONLY_RW Permission mask 600 allows only owner to read and modify file.
static String	MASK_OWNER_ONLY_RWX Permission mask 700 allows only owner to read, modify and execute file.
static boolean	UNIX_LIKE Set to true when run if platform is detected to be UNIX compatible
static boolean	WINDOWS Set to true when run on Windows platforms

Constructor Summary

Constructors

Constructor and Description
ShellCommandUtil()

Method Summary

Modifier and Type	Method and Description
static ShellCommandUtil.Result	copyFile(String srcFile, String destFile, boolean force, boolean sudo) Copies a source file to the specified destination.
static ShellCommandUtil.Result	delete(String file, boolean force, boolean sudo) Deletes the file.
static String	getOpenSslCommandResult(String command, int exitCode)
static String	getUnixFilePermissions(String path) Gets file permissions on Linux systems.
static String	hideOpenSslPassword(String command)
static void	logOpenSslExitCode(String command, int exitCode)
static ShellCommandUtil.Result	mkdir(String directoryPath, boolean sudo) Creates the specified directory and any directories in the path
static ShellCommandUtil.Result	pathExists(String path, boolean sudo) Test if a file or directory exists
static ShellCommandUtil.Result	runCommand(List<String> args, Map<String,String> vars, ShellCommandUtil.InteractiveHandler interactiveHandler, boolean sudo)
static ShellCommandUtil.Result	runCommand(String[] args) Run a command
static ShellCommandUtil.Result	runCommand(String[] args, Map<String,String> vars) Runs a command with a given set of environment variables
static ShellCommandUtil.Result	runCommand(String[] args, Map<String,String> vars, ShellCommandUtil.InteractiveHandler interactiveHandler, boolean sudo) Runs a command with a given set of environment variables
static ShellCommandUtil.Result	setFileGroup(String path, String groupName) Sets the group for a file.
static ShellCommandUtil.Result	setFileMode(String path, boolean ownerReadable, boolean ownerWritable, boolean ownerExecutable, boolean groupReadable, boolean groupWritable, boolean groupExecutable, boolean otherReadable, boolean otherWritable, boolean otherExecutable) Set the access modes for a file
static ShellCommandUtil.Result	setFileOwner(String path, String ownerName) Sets the owner for a file.
static void	setUnixFilePermissions(String mode, String path) Sets file permissions to a given value on Linux systems.

Methods inherited from class java.lang.Object

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

Field Detail

WINDOWS

public static final boolean WINDOWS

Set to true when run on Windows platforms

LINUX

public static final boolean LINUX

Set to true when run on Linux platforms

MAC

public static final boolean MAC

Set to true when run on Mac OS platforms

UNIX_LIKE

public static final boolean UNIX_LIKE

Set to true when run if platform is detected to be UNIX compatible

MASK_OWNER_ONLY_RW

public static final String MASK_OWNER_ONLY_RW

Permission mask 600 allows only owner to read and modify file. Other users (except root) can't read/modify file

See Also:

Constant Field Values

MASK_OWNER_ONLY_RWX

public static final String MASK_OWNER_ONLY_RWX

Permission mask 700 allows only owner to read, modify and execute file. Other users (except root) can't read/modify/execute file

See Also:

Constant Field Values

MASK_EVERYBODY_RWX

public static final String MASK_EVERYBODY_RWX

Permission mask 777 allows everybody to read/modify/execute file

See Also:

Constant Field Values

Constructor Detail

ShellCommandUtil

public ShellCommandUtil()

Method Detail

logOpenSslExitCode

public static void logOpenSslExitCode(String command,
                                      int exitCode)

hideOpenSslPassword

public static String hideOpenSslPassword(String command)

getOpenSslCommandResult

public static String getOpenSslCommandResult(String command,
                                             int exitCode)

getUnixFilePermissions

public static String getUnixFilePermissions(String path)

Gets file permissions on Linux systems. Under Windows/Mac, command always returns MASK_EVERYBODY_RWX

Parameters:

path -

setUnixFilePermissions

public static void setUnixFilePermissions(String mode,
                                          String path)

Sets file permissions to a given value on Linux systems. On Windows/Mac, command is silently ignored

Parameters:

mode -

path -

setFileOwner

public static ShellCommandUtil.Result setFileOwner(String path,
                                                   String ownerName)

Sets the owner for a file.

Parameters:

path - the path to the file

ownerName - the owner's local username

Returns:

the result of the operation

setFileGroup

public static ShellCommandUtil.Result setFileGroup(String path,
                                                   String groupName)

Sets the group for a file.

Parameters:

path - the path to the file

groupName - the group name

Returns:

the result of the operation

setFileMode

public static ShellCommandUtil.Result setFileMode(String path,
                                                  boolean ownerReadable,
                                                  boolean ownerWritable,
                                                  boolean ownerExecutable,
                                                  boolean groupReadable,
                                                  boolean groupWritable,
                                                  boolean groupExecutable,
                                                  boolean otherReadable,
                                                  boolean otherWritable,
                                                  boolean otherExecutable)

Set the access modes for a file

Parameters:

path - the path to the file

ownerWritable - true if the owner should be able to write to this file; otherwise false

ownerReadable - true if the owner should be able to read this file; otherwise false

ownerExecutable - true if the owner should be able to execute this file; otherwise false

groupWritable - true if the group should be able to write to this file; otherwise false

groupReadable - true if the group should be able to read this file; otherwise false

groupExecutable - true if the group should be able to execute this file; otherwise false

otherReadable - true if other users should be able to read this file; otherwise false

otherWritable - true if other users should be able to write to this file; otherwise false

otherExecutable - true if other users should be able to execute this file; otherwise false

Returns:

the result of the operation

pathExists

public static ShellCommandUtil.Result pathExists(String path,
                                                 boolean sudo)
                                          throws IOException,
                                                 InterruptedException

Test if a file or directory exists

Parameters:

path - the path to test

sudo - true to execute the command using sudo (ambari-sudo); otherwise false

Returns:

the shell command result, success indicates the file or directory exists

Throws:

IOException

InterruptedException

mkdir

public static ShellCommandUtil.Result mkdir(String directoryPath,
                                            boolean sudo)
                                     throws IOException,
                                            InterruptedException

Creates the specified directory and any directories in the path

Parameters:

directoryPath - the directory to create

sudo - true to execute the command using sudo (ambari-sudo); otherwise false

Returns:

the shell command result

Throws:

IOException

InterruptedException

copyFile

public static ShellCommandUtil.Result copyFile(String srcFile,
                                               String destFile,
                                               boolean force,
                                               boolean sudo)
                                        throws IOException,
                                               InterruptedException

Copies a source file to the specified destination.

Parameters:

srcFile - the path to the source file

destFile - the path to the destination file

force - true to force copy even if the file exists

sudo - true to execute the command using sudo (ambari-sudo); otherwise false

Returns:

the shell command result

Throws:

IOException

InterruptedException

delete

public static ShellCommandUtil.Result delete(String file,
                                             boolean force,
                                             boolean sudo)
                                      throws IOException,
                                             InterruptedException

Deletes the file.

Parameters:

file - the path to the file to be deleted

force - true to force copy even if the file exists

sudo - true to execute the command using sudo (ambari-sudo); otherwise false

Returns:

the shell command result

Throws:

IOException

InterruptedException

runCommand

public static ShellCommandUtil.Result runCommand(List<String> args,
                                                 Map<String,String> vars,
                                                 ShellCommandUtil.InteractiveHandler interactiveHandler,
                                                 boolean sudo)
                                          throws IOException,
                                                 InterruptedException

Throws:

IOException

InterruptedException

See Also:

runCommand(String[], Map, InteractiveHandler, boolean)

runCommand

public static ShellCommandUtil.Result runCommand(String[] args,
                                                 Map<String,String> vars,
                                                 ShellCommandUtil.InteractiveHandler interactiveHandler,
                                                 boolean sudo)
                                          throws IOException,
                                                 InterruptedException

Runs a command with a given set of environment variables

Parameters:

args - a String[] of the command and its arguments

vars - a Map of String,String setting an environment variable to run the command with

interactiveHandler - a handler to provide responses to queries from the command, or null if no queries are expected

sudo - true to execute the command using sudo (ambari-sudo); otherwise false

Returns:

Result

Throws:

IOException

InterruptedException

runCommand

public static ShellCommandUtil.Result runCommand(String[] args,
                                                 Map<String,String> vars)
                                          throws IOException,
                                                 InterruptedException

Runs a command with a given set of environment variables

Parameters:

args - a String[] of the command and its arguments

vars - a Map of String,String setting an environment variable to run the command with

Returns:

Result

Throws:

IOException

InterruptedException

runCommand

public static ShellCommandUtil.Result runCommand(String[] args)
                                          throws IOException,
                                                 InterruptedException

Run a command

Parameters:

args - A String[] of the command and its arguments

Returns:

Result

Throws:

IOException

InterruptedException