com.norconex.jef4.exec

Class SystemCommand

java.lang.Object

com.norconex.jef4.exec.SystemCommand

Deprecated.

Since 4.1.0, this class can be found in Norconex Commons Lang

@Deprecated
public class SystemCommand
extends Object

Represents a program to be executed by the underlying system (on the "command line"). This class attempts to be system-independent, which means given an executable path should be sufficient to run programs on any systems (e.g. it handles prefixing an executable with OS specific commands as well as preventing process hanging on some OS when there is nowhere to display the output).

Since:

1.1

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
SystemCommand(File workdir, String... command) Deprecated. Creates a command.
SystemCommand(String... command) Deprecated. Creates a command for which the execution will be in the working directory of the current process.

Method Summary

Modifier and Type	Method and Description
void	abort() Deprecated. Aborts the running command.
void	addErrorListener(com.norconex.commons.lang.io.IStreamListener listener) Deprecated. Adds an error (STDERR) listener to this system command.
void	addOutputListener(com.norconex.commons.lang.io.IStreamListener listener) Deprecated. Adds an output (STDOUT) listener to this system command.
int	execute() Deprecated. Executes the given command and returns only when the underlying process stopped running.
int	execute(boolean runInBackground) Deprecated. Executes the given system command.
String[]	getCommand() Deprecated. Gets the command to be run.
String	getDescription() Deprecated. Gets the description for this command.
File	getWorkdir() Deprecated. Gets the command working directory.
boolean	isRunning() Deprecated. Returns whether the command is currently running.
void	removeErrorListener(com.norconex.commons.lang.io.IStreamListener listener) Deprecated. Removes an error (STDERR) listener.
void	removeOutputListener(com.norconex.commons.lang.io.IStreamListener listener) Deprecated. Removes an output (STDOUT) listener.
void	setDescription(String description) Deprecated. Sets the description for this command.
String	toString() Deprecated. Returns the command to be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemCommand

public SystemCommand(String... command)

Deprecated.

Creates a command for which the execution will be in the working directory of the current process. If more than one command values are passed, the first element of the array is the command and subsequent elements are arguments.

Parameters:

command - the command to run

SystemCommand

public SystemCommand(File workdir,
                     String... command)

Deprecated.

Creates a command. If more than one command values are passed, the first element of the array is the command and subsequent elements are arguments.

Parameters:

command - the command to run

workdir - specifies a working directory (default inherits the working directory of the current process.

Method Detail

getCommand

public String[] getCommand()

Deprecated.

Gets the command to be run.

Returns:

the command

getDescription

public String getDescription()

Deprecated.

Gets the description for this command.

Returns:

command description

setDescription

public void setDescription(String description)

Deprecated.

Sets the description for this command.

Parameters:

description - command description

getWorkdir

public File getWorkdir()

Deprecated.

Gets the command working directory.

Returns:

command working directory.

addErrorListener

public void addErrorListener(com.norconex.commons.lang.io.IStreamListener listener)

Deprecated.

Adds an error (STDERR) listener to this system command.

Parameters:

listener - command error listener

removeErrorListener

public void removeErrorListener(com.norconex.commons.lang.io.IStreamListener listener)

Deprecated.

Removes an error (STDERR) listener.

Parameters:

listener - command error listener

addOutputListener

public void addOutputListener(com.norconex.commons.lang.io.IStreamListener listener)

Deprecated.

Adds an output (STDOUT) listener to this system command.

Parameters:

listener - command output listener

removeOutputListener

public void removeOutputListener(com.norconex.commons.lang.io.IStreamListener listener)

Deprecated.

Removes an output (STDOUT) listener.

Parameters:

listener - command output listener

isRunning

public boolean isRunning()

Deprecated.

Returns whether the command is currently running.

Returns:

true if running

abort

public void abort()

Deprecated.

Aborts the running command. If the command is not currently running, aborting it will have no effect.

execute

public int execute()
            throws InterruptedException,
                   IOException

Deprecated.

Executes the given command and returns only when the underlying process stopped running.

Returns:

process exit value

Throws:

InterruptedException - problem executing command

IOException - problem executing command

execute

public int execute(boolean runInBackground)
            throws InterruptedException,
                   IOException

Deprecated.

Executes the given system command. When run in the background, this method will return quickly, with a status code of 0. The status will not reflect the sub-process termination status. When NOT run in the background, this method waits and returns only when the underlying process stopped running. Alternatively, to run a command asynchronously, you can wrap it in its own thread (e.g. wrapping it in a AsyncJobGroup).

Parameters:

runInBackground - true to runs the system command in background.

Returns:

process exit value

Throws:

InterruptedException - problem executing command

IOException - problem executing command

Since:

2.0

toString

public String toString()

Deprecated.

Returns the command to be executed.

Overrides:

toString in class Object