Rio Project 4.2 API Documentation

org.rioproject.exec
Class ExecDescriptor

java.lang.Object
  org.rioproject.exec.ExecDescriptor

All Implemented Interfaces:

Serializable

public class ExecDescriptor
extends Object
implements Serializable

Execution Attributes for an external service

Author:

Dennis Reedy

See Also:

Serialized Form

Constructor Summary

ExecDescriptor()
Create an ExecDescriptor

ExecDescriptor(String commandLine)
Create an ExecDescriptor

ExecDescriptor(String commandLine, String workingDirectory)
Create an ExecDescriptor

ExecDescriptor(String commandLine, String workingDirectory, String stdOutFileName, String stdErrFileName, String inputArgs)
Create an ExecDescriptor

Method Summary

String	getCommandLine() Get the command line
Map<String,String>	getEnvironment() Get the environment variable settings for the subprocess.
String	getInputArgs()
String	getPidFile() Optional path of the file that contains the pid of of the process
String	getStdErrFileName() Get the standard error file name
String	getStdOutFileName() Get the standard output file name
String	getWorkingDirectory() Get the working directory
void	setCommandLine(String commandLine)
void	setEnvironment(Map<String,String> env)
void	setEnvironment(String[] env)
void	setInputArgs(String inputArgs)
void	setPidFile(String pidFile) Set the pid file
void	setStdErrFileName(String stdErrFileName) A file name for the standard error stream.
void	setStdOutFileName(String stdOutFileName) A file name for the standard output stream.
void	setWorkingDirectory(String workingDirectory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecDescriptor

public ExecDescriptor()

Create an ExecDescriptor

ExecDescriptor

public ExecDescriptor(String commandLine)

Create an ExecDescriptor

Parameters:

commandLine - The commandLine

ExecDescriptor

public ExecDescriptor(String commandLine,
                      String workingDirectory)

Create an ExecDescriptor

Parameters:

commandLine - The commandLine

workingDirectory - The working directory

ExecDescriptor

public ExecDescriptor(String commandLine,
                      String workingDirectory,
                      String stdOutFileName,
                      String stdErrFileName,
                      String inputArgs)

Create an ExecDescriptor

Parameters:

commandLine - The commandLine

workingDirectory - The working directory

stdOutFileName - The file name to redirect standard output to

stdErrFileName - The file name to redirect standard error to

inputArgs - Input arguments

Method Detail

getCommandLine

public String getCommandLine()

Get the command line

Returns:

The command line. All system properties of the form ${property} will be expanded

setCommandLine

public void setCommandLine(String commandLine)

getWorkingDirectory

public String getWorkingDirectory()

Get the working directory

Returns:

The working directory. All system properties of the form ${property} will be expanded

setWorkingDirectory

public void setWorkingDirectory(String workingDirectory)

setEnvironment

public void setEnvironment(String[] env)

setEnvironment

public void setEnvironment(Map<String,String> env)

getEnvironment

public Map<String,String> getEnvironment()

Get the environment variable settings for the subprocess.

Returns:

The environment variable settings for the subprocess.

getStdOutFileName

public String getStdOutFileName()

Get the standard output file name

Returns:

The standard output file name. All system properties of the form ${property} will be expanded

setStdOutFileName

public void setStdOutFileName(String stdOutFileName)

A file name for the standard output stream. The file name is relative to the Cybernode's log directory.

Parameters:

stdOutFileName - The file name to redirect standard output stream to.

getStdErrFileName

public String getStdErrFileName()

Get the standard error file name

Returns:

The file name for standard error output. All system properties of the form ${property} will be expanded

setStdErrFileName

public void setStdErrFileName(String stdErrFileName)

A file name for the standard error stream. The file name is relative to the Cybernode's log directory

Parameters:

stdErrFileName - The file name to redirect standard error stream to.

getInputArgs

public String getInputArgs()

setInputArgs

public void setInputArgs(String inputArgs)

getPidFile

public String getPidFile()

Optional path of the file that contains the pid of of the process

Returns:

The path of the file that contains the pid of of the process. Maybe null if no

setPidFile

public void setPidFile(String pidFile)

Set the pid file

Parameters:

pidFile - The path of the file that contains the pid of of the process