csip.api.server

Interface Executable

public interface Executable

Interface to manage an executable.

Author:

od

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Executable.StdHandler Receives output for stderr or stdout.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TIMED_OUT Exit value if the execution timed out.

Method Summary

Modifier and Type	Method and Description
void	addArguments(java.lang.Object... args) Add additional arguments.
void	addOptions(java.lang.Object... opts) Add the executable options.
java.util.Map<java.lang.String,java.lang.String>	environment() Get the current environment map
int	exec() run the executable.
java.lang.Object[]	getArguments() Get the executables arguments
java.lang.String	getName() Get the name of the executable.
java.lang.Object[]	getOptions() Get the executable options.
void	redirectDefaults() redirect to default files and append.
void	redirectError(java.lang.String filename) Redirect stderr to a file in the workspace.
void	redirectError(java.io.StringWriter w) Redirect the error stream to a string writer
void	redirectOutput(java.lang.String filename) Redirect stdout to a file in the workspace.
void	redirectOutput(java.io.StringWriter w) Redirect the output to a string writer
void	setArguments(java.lang.Object... args) Set the executable arguments.
void	setOptions(java.lang.Object... opts) Set the executable options.
void	setStderrHandler(Executable.StdHandler handler) Handle the current output from stderr.
void	setStdoutHandler(Executable.StdHandler handler) Handle the current output from stdout.
void	setTimeout(long time, java.util.concurrent.TimeUnit unit) Set the timeout.
java.io.File	stderr() Get the File for stderr.
java.io.File	stdout() Get the File for stdio.

Field Detail

TIMED_OUT

static final int TIMED_OUT

Exit value if the execution timed out.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get the name of the executable.

Returns:

the name of the executable

addOptions

void addOptions(java.lang.Object... opts)

Add the executable options. Options usually go before arguments.

Parameters:

opts - the executable options

setOptions

void setOptions(java.lang.Object... opts)

Set the executable options. Options usually go before arguments.

Parameters:

opts - the executable options

getOptions

java.lang.Object[] getOptions()

Get the executable options.

Returns:

the executable options

setArguments

void setArguments(java.lang.Object... args)

Set the executable arguments.

Parameters:

args - the executable arguments

addArguments

void addArguments(java.lang.Object... args)

Add additional arguments.

Parameters:

args - the command line arguments.

getArguments

java.lang.Object[] getArguments()

Get the executables arguments

Returns:

the arguments

environment

java.util.Map<java.lang.String,java.lang.String> environment()

Get the current environment map

Returns:

the environment.

redirectOutput

void redirectOutput(java.lang.String filename)
             throws java.io.IOException

Redirect stdout to a file in the workspace.

Parameters:

filename - the filename to use relative to the workspace.

Throws:

java.io.IOException - if redirection fails.

redirectOutput

void redirectOutput(java.io.StringWriter w)
             throws java.io.IOException

Redirect the output to a string writer

Parameters:

w - the StringWriter

Throws:

java.io.IOException - if redirection fails.

redirectError

void redirectError(java.lang.String filename)
            throws java.io.IOException

Redirect stderr to a file in the workspace.

Parameters:

filename - the filename to use relative to the workspace.

Throws:

java.io.IOException - if redirection fails.

redirectError

void redirectError(java.io.StringWriter w)
            throws java.io.IOException

Redirect the error stream to a string writer

Parameters:

w - the StringWriter

Throws:

java.io.IOException - if redirection fails

redirectDefaults

void redirectDefaults()
               throws java.io.IOException

redirect to default files and append. Call this before repeated execution.

Throws:

java.io.IOException - if redirection fails

setTimeout

void setTimeout(long time,
                java.util.concurrent.TimeUnit unit)

Set the timeout.

Parameters:

time - the amount of the time unit.

unit - the TimeUnit

exec

int exec()
  throws java.io.IOException

run the executable.

Returns:

0 if successful, !=0 otherwise

Throws:

java.io.IOException - if an IO error occurs.

stdout

java.io.File stdout()

Get the File for stdio. The File is unique for each instance of this class. name : 'executable name'-'hash code'-stdout.exe

Returns:

The file with the output.

stderr

java.io.File stderr()

Get the File for stderr. The File is unique for each instance of this class. name : 'executable name'-'hash code'-stdout.exe

Returns:

The

setStdoutHandler

void setStdoutHandler(Executable.StdHandler handler)

Handle the current output from stdout.

Parameters:

handler - the handler object. Pass 'null' for removing an existing handler.

setStderrHandler

void setStderrHandler(Executable.StdHandler handler)

Handle the current output from stderr.

Parameters:

handler - the handler object. Pass 'null' for removing an existing handler.