Eclipse RSE Development Guide (Galileo) - AbstractShellService (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.services.shells
Class AbstractShellService


java.lang.Object
  

org.eclipse.core.runtime.PlatformObject
      

org.eclipse.rse.services.AbstractService
          
org.eclipse.rse.services.shells.AbstractShellService

All Implemented Interfaces:: IAdaptable, IService, IShellService

public abstract class AbstractShellService
extends AbstractService
implements IShellService
extends AbstractService
implements IShellService

Abstract base class for RSE Shell Service implementations.

Since:: org.eclipse.rse.services 3.0

Constructor Summary

AbstractShellService ()


Method Summary

String[] getHostEnvironment ()
          Return an empty host environment.

IHostShell launchShell ( String initialWorkingDirectory, String[] environment, IProgressMonitor monitor)
          Launch a new shell in the specified directory with a default encoding.

IHostShell runCommand ( String initialWorkingDirectory, String command, String[] environment, IProgressMonitor monitor)
          Run a single command in it's own shell with a default encoding.

Methods inherited from class org.eclipse.rse.services. AbstractService

getDescription, getName, initService, uninitService

Methods inherited from class org.eclipse.core.runtime. PlatformObject

getAdapter

Methods inherited from class java.lang. Object

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

Methods inherited from interface org.eclipse.rse.services.shells. IShellService

launchShell, runCommand

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

getDescription, getName, initService, uninitService

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

Constructor Detail

AbstractShellService

public AbstractShellService()

Method Detail

getHostEnvironment

public 
String[] getHostEnvironment()
                            throws 
SystemMessageException

Return an empty host environment. Extenders should override this method if they are able to return environment on the remote side. If they do not implement this feature, they must not override this method.

Specified by:: getHostEnvironment in interface IShellService

Returns:: Array of environment variable Strings of the form "var=text" if supported by a shell service implementation. Should return an empty array in case environment variable retrieval is not supported on a particular shell service implementation.
Throws:: SystemMessageException - in case an error occurred or the user chose to cancel the operation via the progress monitor.
See Also:: IShellService.getHostEnvironment()

launchShell

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

Description copied from interface: IShellService

Launch a new shell in the specified directory with a default encoding. This is a convenience method, passing null as encoding into IShellService.launchShell(String, String, String[], IProgressMonitor).

Specified by:: launchShell in interface IShellService

Throws:: SystemMessageException - in case an error occurred or the user chose to cancel the operation via the progress monitor.

runCommand

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