org.eclipse.rse.services.shells
Interface IShellService

All Superinterfaces:

IService

All Known Implementing Classes:

DStoreShellService, LocalShellService, SshShellService

public interface IShellService

extends IService

IShellService is an abstraction for running shells and shell commands

Method Summary

String[]	getHostEnvironment() Return an array of environment variables that describe the environment on the host.
IHostShell	launchShell(IProgressMonitor monitor, String initialWorkingDirectory, String[] environment) Launch a new shell in the specified directory
IHostShell	launchShell(IProgressMonitor monitor, String initialWorkingDirectory, String encoding, String[] environment) Launch a new shell in the specified directory
IHostShell	runCommand(IProgressMonitor monitor, String initialWorkingDirectory, String command, String[] environment) Run a command in it's own shell
IHostShell	runCommand(IProgressMonitor monitor, String initialWorkingDirectory, String command, String encoding, String[] environment) Run a command in it's own shell

Methods inherited from interface org.eclipse.rse.services.IService

getDescription, getMessage, getName, initService, uninitService

Method Detail

launchShell

public IHostShell launchShell(IProgressMonitor monitor,
                              String initialWorkingDirectory,
                              String[] environment)

Launch a new shell in the specified directory

Parameters:

monitor -

initialWorkingDirectory -

environment - Array of environment variable Strings of the form "var=text"

Returns:

the shell object

launchShell

public IHostShell launchShell(IProgressMonitor monitor,
                              String initialWorkingDirectory,
                              String encoding,
                              String[] environment)

Launch a new shell in the specified directory

Parameters:

monitor -

initialWorkingDirectory -

encoding -

environment - Array of environment variable Strings of the form "var=text"

Returns:

the shell object

runCommand

public IHostShell runCommand(IProgressMonitor monitor,
                             String initialWorkingDirectory,
                             String command,
                             String[] environment)

Run a command in it's own shell

Parameters:

monitor -

initialWorkingDirectory -

command -

environment - Array of environment variable Strings of the form "var=text"

Returns:

the shell object for getting output and error streams

runCommand

public IHostShell runCommand(IProgressMonitor monitor,
                             String initialWorkingDirectory,
                             String command,
                             String encoding,
                             String[] environment)

Run a command in it's own shell

Parameters:

monitor -

initialWorkingDirectory -

command -

encoding -

environment - Array of environment variable Strings of the form "var=text"

Returns:

the shell object for getting output and error streams

getHostEnvironment

public String[] getHostEnvironment()

Return an array of environment variables that describe the environment on the host. Each String returned is of the format "var=text": Everything up to the first equals sign is the name of the given environment variable, everything after the equals sign is its contents.

Returns:

Array of environment variable Strings of the form "var=text"