alluxio.util

Class ShellUtils

java.lang.Object

alluxio.util.ShellUtils

@ThreadSafe
public final class ShellUtils
extends Object

A utility class for running Unix commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShellUtils.ExitCodeException This is an IOException with exit code added.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMON_SSH_OPTS Common shell OPTS to prevent stalling.
static String	MOUNT_COMMAND a Unix command for getting mount information.
static String	SET_PERMISSION_COMMAND a Unix command to set permission.
static String	TOKEN_SEPARATOR_REGEX Token separator regex used to parse Shell tool outputs.

Method Summary

Modifier and Type	Method and Description
static String	execCommand(String... cmd) Static method to execute a shell command.
static String[]	getGroupsForUserCommand(String user) Gets a Unix command to get a given user's groups list.
static String[]	getSetPermissionCommand(String perm, String filePath) Returns a Unix command to set permission.
static List<UnixMountInfo>	getUnixMountInfo() Gets system mount information.
static UnixMountInfo	parseMountInfo(String line)

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_SSH_OPTS

public static final String COMMON_SSH_OPTS

Common shell OPTS to prevent stalling. a. Disable StrictHostKeyChecking to prevent interactive prompt b. Set timeout for establishing connection with host

See Also:

Constant Field Values

SET_PERMISSION_COMMAND

public static final String SET_PERMISSION_COMMAND

a Unix command to set permission.

See Also:

Constant Field Values

MOUNT_COMMAND

public static final String MOUNT_COMMAND

a Unix command for getting mount information.

See Also:

Constant Field Values

TOKEN_SEPARATOR_REGEX

public static final String TOKEN_SEPARATOR_REGEX

Token separator regex used to parse Shell tool outputs.

See Also:

Constant Field Values

Method Detail

getGroupsForUserCommand

public static String[] getGroupsForUserCommand(String user)

Gets a Unix command to get a given user's groups list.

Parameters:

user - the user name

Returns:

the Unix command to get a given user's groups list

getSetPermissionCommand

public static String[] getSetPermissionCommand(String perm,
                                               String filePath)

Returns a Unix command to set permission.

Parameters:

perm - the permission of file

filePath - the file path

Returns:

the Unix command to set permission

getUnixMountInfo

public static List<UnixMountInfo> getUnixMountInfo()
                                            throws IOException

Gets system mount information. This method should only be attempted on Unix systems.

Returns:

system mount information

Throws:

IOException

parseMountInfo

public static UnixMountInfo parseMountInfo(String line)

Parameters:

line - the line to parse

Returns:

the parsed UnixMountInfo

execCommand

public static String execCommand(String... cmd)
                          throws IOException

Static method to execute a shell command.

Parameters:

cmd - shell command to execute

Returns:

the output of the executed command

Throws:

IOException