org.eclipse.remote.internal.jsch.core

Class JSchProcessBuilder

java.lang.Object

org.eclipse.remote.core.AbstractRemoteProcessBuilder

org.eclipse.remote.internal.jsch.core.JSchProcessBuilder

All Implemented Interfaces:

IRemoteProcessBuilder

public class JSchProcessBuilder
extends AbstractRemoteProcessBuilder

Field Summary

Fields inherited from interface org.eclipse.remote.core.IRemoteProcessBuilder

ALLOCATE_PTY, FORWARD_X11, NONE

Constructor Summary

Constructors

Constructor and Description
JSchProcessBuilder(IRemoteConnection connection)
JSchProcessBuilder(IRemoteConnection connection, java.util.List<java.lang.String> command)
JSchProcessBuilder(IRemoteConnection connection, java.lang.String... command)

Method Summary

Modifier and Type	Method and Description
org.eclipse.core.filesystem.IFileStore	directory() Returns this process builder's working directory.
java.util.Map<java.lang.String,java.lang.String>	environment() Returns a string map view of this process builder's environment.
com.jcraft.jsch.Channel	getChannel()
int	getSupportedFlags() Get the flags that are supported by this process builder.
void	setPreamble(boolean enable)
IRemoteProcess	start(int flags) Starts a new process using the attributes of this process builder.

Methods inherited from class org.eclipse.remote.core.AbstractRemoteProcessBuilder

command, command, command, directory, getRemoteConnection, redirectErrorStream, redirectErrorStream, start, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JSchProcessBuilder

public JSchProcessBuilder(IRemoteConnection connection,
                          java.util.List<java.lang.String> command)

JSchProcessBuilder

public JSchProcessBuilder(IRemoteConnection connection,
                          java.lang.String... command)

JSchProcessBuilder

public JSchProcessBuilder(IRemoteConnection connection)

Method Detail

directory

public org.eclipse.core.filesystem.IFileStore directory()

Description copied from interface: IRemoteProcessBuilder

Returns this process builder's working directory.

Specified by:

directory in interface IRemoteProcessBuilder

Overrides:

directory in class AbstractRemoteProcessBuilder

Returns:

an IFileStore reference to the working directory

environment

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

Description copied from interface: IRemoteProcessBuilder

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

Specified by:

environment in interface IRemoteProcessBuilder

Specified by:

environment in class AbstractRemoteProcessBuilder

Returns:

the process builder's environment

getSupportedFlags

public int getSupportedFlags()

Description copied from interface: IRemoteProcessBuilder

Get the flags that are supported by this process builder.

Specified by:

getSupportedFlags in interface IRemoteProcessBuilder

Specified by:

getSupportedFlags in class AbstractRemoteProcessBuilder

Returns:

bitwise-or of the supported flags

start

public IRemoteProcess start(int flags)
                     throws java.io.IOException

Description copied from interface: IRemoteProcessBuilder

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 IRemoteProcessBuilder.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)
 

Specified by:

start in interface IRemoteProcessBuilder

Specified by:

start in class AbstractRemoteProcessBuilder

Parameters:

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

Returns:

remote process object

Throws:

java.io.IOException

getChannel

public com.jcraft.jsch.Channel getChannel()

setPreamble

public void setPreamble(boolean enable)