org.eclipse.ptp.remote.core
Interface IRemoteProcessBuilder

All Known Implementing Classes:

AbstractRemoteProcessBuilder

public interface IRemoteProcessBuilder

Abstraction of a process builder for remote processes. This interface behaves in the same manner as ProcessBuilder.

Field Summary

static int	ALLOCATE_PTY Flag to request allocation of a pseudo-terminal for the process (RFC-4254 Sec. 6.2)
static int	FORWARD_X11 Flag to request X11 forwarding (RFC-4254 Sec. 6.3)
static int	NONE

Method Summary

List<String>	command() Returns this process builder's operating system program and arguments.
IRemoteProcessBuilder	command(List<String> command) Sets this process builder's operating system program and arguments.
IRemoteProcessBuilder	command(String... command) Sets this process builder's operating system program and arguments.
IRemoteConnection	connection() Returns this process builder's connection.
IRemoteProcessBuilder	connection(IRemoteConnection conn) Sets this process builder's connection.
IFileStore	directory() Returns this process builder's working directory.
IRemoteProcessBuilder	directory(IFileStore directory) Sets this process builder's working directory.
Map<String,String>	environment() Returns a string map view of this process builder's environment.
int	getSupportedFlags() Get the flags that are supported by this process builder.
boolean	redirectErrorStream() Tells whether this process builder merges standard error and standard output.
IRemoteProcessBuilder	redirectErrorStream(boolean redirectErrorStream) Sets this process builder's redirectErrorStream property.
IRemoteProcess	start() Starts a new process using the attributes of this process builder.
IRemoteProcess	start(int flags) Starts a new process using the attributes of this process builder.

Field Detail

NONE

static final int NONE

Since:

5.0

See Also:

Constant Field Values

ALLOCATE_PTY

static final int ALLOCATE_PTY

Flag to request allocation of a pseudo-terminal for the process (RFC-4254 Sec. 6.2)

Since:

5.0

See Also:

Constant Field Values

FORWARD_X11

static final int FORWARD_X11

Flag to request X11 forwarding (RFC-4254 Sec. 6.3)

Since:

5.0

See Also:

Constant Field Values

Method Detail

command

List<String> command()

Returns this process builder's operating system program and arguments.

Returns:

a list containing the program and arguments

command

IRemoteProcessBuilder command(List<String> command)

Sets this process builder's operating system program and arguments.

Parameters:

command -

Returns:

This process builder

command

IRemoteProcessBuilder command(String... command)

Sets this process builder's operating system program and arguments.

Parameters:

command -

Returns:

this process builder

connection

IRemoteConnection connection()

Returns this process builder's connection.

Returns:

the connection used by this process builder

connection

IRemoteProcessBuilder connection(IRemoteConnection conn)

Sets this process builder's connection.

Returns:

This process builder

directory

IFileStore directory()

Returns this process builder's working directory.

Returns:

an IFileStore reference to the working directory

directory

IRemoteProcessBuilder directory(IFileStore directory)

Sets this process builder's working directory.

Parameters:

directory -

Returns:

This process builder

environment

Map<String,String> environment()

Returns a string map view of this process builder's environment. The returned map behaves in the same manner as described in ProcessBuilder.environment().

Returns:

the process builder's environment

getSupportedFlags

int getSupportedFlags()

Get the flags that are supported by this process builder.

Returns:

bitwise-or of the supported flags

Since:

5.0

redirectErrorStream

boolean redirectErrorStream()

Tells whether this process builder merges standard error and standard output.

Returns:

true if standard error and standard output will be merged

redirectErrorStream

IRemoteProcessBuilder redirectErrorStream(boolean redirectErrorStream)

Sets this process builder's redirectErrorStream property.

Parameters:

redirectErrorStream -

Returns:

This process builder

start

IRemoteProcess start()
                     throws IOException

Starts a new process using the attributes of this process builder.

Returns:

remote process object

Throws:

IOException

start

IRemoteProcess start(int flags)
                     throws IOException

Starts a new process using the attributes of this process builder. The flags may be used to modify behavior of the remote process. These flags may only be supported by specific types of remote service providers. Clients can use getSupportedFlags() to find out the flags supported by the service provider.

 Current flags are:
   NONE                 - disable any flags
   ALLOCATE_PTY - allocate a pseudo-terminal for the process (RFC-4254 Sec. 6.2)
   FORWARD_X11  - enable X11 forwarding (RFC-4254 Sec. 6.3)
 

Parameters:

flags - bitwise-or of flags to use when starting process

Returns:

remote process object

Throws:

IOException

Since:

5.0