com.hortonworks.registries.auth.util

Class Shell

java.lang.Object

com.hortonworks.registries.auth.util.Shell

Direct Known Subclasses:

Shell.ShellCommandExecutor

public abstract class Shell
extends java.lang.Object

A base class for running a Unix command. Shell can be used to run unix commands like du or df.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shell.ExitCodeException This is an IOException with exit code added.
static class	Shell.ShellCommandExecutor A simple shell command executor.

Constructor Summary

Constructors

Constructor and Description
Shell(long timeout)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	execCommand(java.lang.String... cmd) Static method to execute a shell command.
static java.lang.String	execCommand(java.lang.String[] cmd, long timeout) Static method to execute a shell command.
protected abstract java.lang.String[]	execString() Return an array containing the command name and its parameters
int	exitCode() get the exit code
protected abstract void	parseExecResult(java.io.BufferedReader lines) Parse the execution result
java.lang.Process	process() get the current sub-process executing the given command
protected void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

Shell

public Shell(long timeout)

Parameters:

timeout - Specifies the time in milliseconds, after which the command will be killed. -1 means no timeout.

Method Detail

execString

protected abstract java.lang.String[] execString()

Return an array containing the command name and its parameters

parseExecResult

protected abstract void parseExecResult(java.io.BufferedReader lines)
                                 throws java.io.IOException

Parse the execution result

Throws:

java.io.IOException

exitCode

public int exitCode()

get the exit code

Returns:

the exit code of the process

process

public java.lang.Process process()

get the current sub-process executing the given command

Returns:

process executing the command

run

protected void run()
            throws java.io.IOException

Throws:

java.io.IOException

execCommand

public static java.lang.String execCommand(java.lang.String... cmd)
                                    throws java.io.IOException

Static method to execute a shell command. Covers most of the simple cases without requiring the user to implement the Shell interface.

Parameters:

cmd - shell command to execute.

Returns:

the output of the executed command.

Throws:

java.io.IOException

execCommand

public static java.lang.String execCommand(java.lang.String[] cmd,
                                           long timeout)
                                    throws java.io.IOException

Static method to execute a shell command. Covers most of the simple cases without requiring the user to implement the Shell interface.

Parameters:

cmd - shell command to execute.

timeout - time in milliseconds after which script should be killed. -1 means no timeout.

Returns:

the output of the executed command.

Throws:

java.io.IOException