RSE
Release 3.0

org.eclipse.rse.services
Interface IService

All Superinterfaces:
IAdaptable
All Known Subinterfaces:
IFileService, IProcessService, IShellService, ITerminalService
All Known Implementing Classes:
AbstractDelegatingTerminalService, AbstractDStoreService, AbstractFileService, AbstractProcessService, AbstractSearchService, AbstractService, AbstractShellService, AbstractTerminalService

public interface IService
extends IAdaptable

IService is the base interface for any non-UI service contributions to RSE. An actual Service is free to perform any operations at all - the only commonality between services is that they have a name, can be initialized, and are adaptable for future extension.


Method Summary
 String getDescription()
          Get the description of this Service as a translated, UI-visible String.
 String getName()
          Get the name of this Service as a translated, UI-visible String.
 void initService(IProgressMonitor monitor)
          Initialize this Service to make it ready for operation.
 void uninitService(IProgressMonitor monitor)
          Clean up this Service.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getName

String getName()
Get the name of this Service as a translated, UI-visible String. Extenders are expected to override this method.

Returns:
the name of this Service.

getDescription

String getDescription()
Get the description of this Service as a translated, UI-visible String. Extenders are expected to override this method.

Returns:
the description of this Service.

initService

void initService(IProgressMonitor monitor)
                 throws SystemMessageException
Initialize this Service to make it ready for operation. This method may be long-running and normally gets called after a connection has been established. Extenders are expected to override this method.

Parameters:
monitor - A progress monitor to provide progress of long-running operation. There is no guarantee that cancellation is actually supported by a Service since it would leave the service in a potentially inconsistent, partially initialized state.
Throws:
SystemMessageException - if an error occurs during initialization.

uninitService

void uninitService(IProgressMonitor monitor)
Clean up this Service. This method is called by clients as part of a disconnect operation and should clean up any local status that the Service might have. Extenders are expected to override this method.

Parameters:
monitor - A progress monitor to provide progress of long-running operation. There is no guarantee that cancellation is actually supported by a Service since it would leave the service in a potentially inconsistent, partially initialized state.

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.