org.eclipse.rse.subsystems.processes.core.subsystem
Interface IRemoteProcessSubSystem

All Superinterfaces:

IPropertySetContainer, IRemoteObjectResolver, IRSEModelObject, IRSEPersistableContainer, ISchedulingRule, ISubSystem, ISystemFilterPoolReferenceManagerProvider

All Known Subinterfaces:

IProcessServiceSubSystem

All Known Implementing Classes:

ProcessServiceSubSystem, RemoteProcessSubSystemImpl

public interface IRemoteProcessSubSystem

extends ISubSystem

The RSE subsystem for Remote Processes

Field Summary

Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer

NO_CHILDREN

Method Summary

IRemoteProcess	getParentProcess(IRemoteProcess process) Given a process, return its parent process object.
IRemoteProcessSubSystemConfiguration	getParentRemoteProcessSubSystemConfiguration() Return parent subsystem factory, cast to a RemoteProcessSubSystemConfiguration
IRemoteProcess	getRemoteProcessObject(long pid) Given a pid, return an IRemoteProcess object for it.
String[]	getSignalTypes() Returns a list of the types of signals that can be sent to a process on the remote system.
boolean	isCaseSensitive() Return true if names are case-sensitive.
boolean	kill(IRemoteProcess process, String signal) Kill the given process.
IRemoteProcess[]	listAllProcesses(IHostProcessFilter processNameFilter, IRemoteProcessContext context, IProgressMonitor monitor) Return a list of all processes on the remote system.
IRemoteProcess[]	listChildProcesses(IRemoteProcess parent, IHostProcessFilter processFilter, IRemoteProcessContext context, IProgressMonitor monitor) Return a list of remote child processes of the given process, which match the filter.
IRemoteProcess[]	listChildProcesses(IRemoteProcess parent, IRemoteProcessContext context, IProgressMonitor monitor) Return a list of all remote child processes of the given parent process on the remote system
IRemoteProcess[]	listRoots(IRemoteProcessContext context, IProgressMonitor monitor) Returns root processes

Methods inherited from interface org.eclipse.rse.core.subsystems.ISubSystem

canSwitchTo, checkIsConnected, clearLocalUserId, connect, connect, deletingConnection, disconnect, disconnect, doesFilterListContentsOf, doesFilterMatch, doesFilterStringListContentsOf, doesFilterStringMatch, forceUserIdToUpperCase, getCacheManager, getChildren, getConfigurationId, getConnectorService, getFilterPoolReferenceManager, getHost, getHostAliasName, getLocalUserId, getName, getPrimarySubSystem, getProperties, getProperty, getServiceType, getSubSystemConfiguration, getSystemFilterPoolReferenceManager, getSystemProfile, getSystemProfileName, getTargetForFilter, getUserId, getVendorAttribute, hasChildren, initializeSubSystem, isConnected, isConnectionError, isHidden, isOffline, isPrimarySubSystem, renamingConnection, renamingProfile, resolveFilterString, resolveFilterString, resolveFilterStrings, setConfigurationId, setConnectionError, setConnectorService, setFilterPoolReferenceManager, setHidden, setHost, setName, setProperties, setProperty, setSubSystemConfiguration, setVendorAttribute, supportsCaching, switchServiceFactory, uninitializeSubSystem

Methods inherited from interface org.eclipse.rse.core.filters.ISystemFilterPoolReferenceManagerProvider

filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool

Methods inherited from interface org.eclipse.rse.core.subsystems.IRemoteObjectResolver

getObjectWithAbsoluteName, getObjectWithAbsoluteName

Methods inherited from interface org.eclipse.core.runtime.jobs.ISchedulingRule

contains, isConflicting

Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject

getDescription

Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer

addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet

Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer

commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Method Detail

getParentRemoteProcessSubSystemConfiguration

public IRemoteProcessSubSystemConfiguration getParentRemoteProcessSubSystemConfiguration()

Return parent subsystem factory, cast to a RemoteProcessSubSystemConfiguration

isCaseSensitive

public boolean isCaseSensitive()

Return true if names are case-sensitive. Used when doing name or type filtering

listAllProcesses

public IRemoteProcess[] listAllProcesses(IHostProcessFilter processNameFilter,
                                         IRemoteProcessContext context,
                                         IProgressMonitor monitor)
                                  throws InterruptedException,
                                         SystemMessageException

Return a list of all processes on the remote system. This version is called directly by users.

Parameters:

processNameFilter - filter the results according to this object

context - A context object that will be associated with each returned process

monitor - the progress monitor

Returns:

the list of all processes running on the host machine that correspond to the filter, or null if there are none.

Throws:

InterruptedException

SystemMessageException

listRoots

public IRemoteProcess[] listRoots(IRemoteProcessContext context,
                                  IProgressMonitor monitor)

Returns root processes

Parameters:

context - A context object that will be associated with each returned process

monitor - the progress monitor

listChildProcesses

public IRemoteProcess[] listChildProcesses(IRemoteProcess parent,
                                           IRemoteProcessContext context,
                                           IProgressMonitor monitor)
                                    throws SystemMessageException

Return a list of all remote child processes of the given parent process on the remote system

Parameters:

parent - The parent process whose children to list

context - A context object that will be associated with each returned process

monitor - the progress monitor

Throws:

SystemMessageException

listChildProcesses

public IRemoteProcess[] listChildProcesses(IRemoteProcess parent,
                                           IHostProcessFilter processFilter,
                                           IRemoteProcessContext context,
                                           IProgressMonitor monitor)
                                    throws SystemMessageException

Return a list of remote child processes of the given process, which match the filter.

Parameters:

parent - The parent process whose children to list

processFilter - The process filter to subset the list by, or null to return all child processes.

context - A context object that will be associated with each returned process

monitor - the progress monitor

Throws:

SystemMessageException

getParentProcess

public IRemoteProcess getParentProcess(IRemoteProcess process)

Given a process, return its parent process object.

Parameters:

process - the process to return parent of.

getRemoteProcessObject

public IRemoteProcess getRemoteProcessObject(long pid)
                                      throws SystemMessageException

Given a pid, return an IRemoteProcess object for it.

Parameters:

pid - The pid of the desired process

Throws:

SystemMessageException

kill

public boolean kill(IRemoteProcess process,
                    String signal)
             throws SystemMessageException

Kill the given process.

Parameters:

process - represents the object to be killed.

Returns:

false if the given process doesn't exist, else true. Throws an exception if anything fails.

Throws:

SystemMessageException

getSignalTypes

public String[] getSignalTypes()
                        throws SystemMessageException

Returns a list of the types of signals that can be sent to a process on the remote system.

Returns:

the signal types, or null if there are none, or they cannot be found.

Throws:

SystemMessageException