Eclipse RSE Development Guide (Galileo) - ServerLauncher (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.core.subsystems
Class ServerLauncher


java.lang.Object
  

org.eclipse.rse.core.model.RSEPersistableObject
      

org.eclipse.rse.core.model.PropertySetContainer
          

org.eclipse.rse.core.model.RSEModelObject
              
org.eclipse.rse.core.subsystems.ServerLauncher

All Implemented Interfaces:: ILabeledObject, IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer, IServerLauncherProperties

Direct Known Subclasses:: RemoteServerLauncher

public abstract class ServerLauncher
extends RSEModelObject
implements IServerLauncherProperties, ILabeledObject
extends RSEModelObject
implements IServerLauncherProperties, ILabeledObject

Abstract class intended to be extended to provide a means for starting a remote server from the client. DStore-based connector services use this to determine whether to start a sever via daemon, REXEC, or some other mechanism. For systems that don't need to start remote servers from RSE, this is not needed.

Since:: 3.0 moved from non-API to API

Field Summary

protected IConnectorService _connectorService


protected String _name


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

NO_CHILDREN

Constructor Summary

protected ServerLauncher ( String name, IConnectorService service)
          Constructs a server launcher

Method Summary

IServerLauncherProperties cloneServerLauncher ( IServerLauncherProperties newOne)
          Clone the contents of this server launcher into the given server launcher Your sublcass must override this if you add additional attributes!

boolean commit ()
          Commits the associated connector service to be persisted

IConnectorService getConnectorService ()
          Returns the associated connector service

String getDescription ()
          Returns the description of the server launcher

String getLabel ()
          Returns the label to display in a ui for the server launcher

String getName ()
          Returns the name of the server launcher

IRSEPersistableContainer[] getPersistableChildren ()
          Retrieves the children of this object in the persistence containment hierarchy.

IRSEPersistableContainer getPersistableParent ()
          Retrieve the parent of this object in the persistence containment hierarchy.

void setLabel ( String label)
          Sets the label to use for display in a ui for the server launcher

Methods inherited from class org.eclipse.rse.core.model. PropertySetContainer

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

Methods inherited from class org.eclipse.rse.core.model. RSEPersistableObject

compareStrings, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

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.core.subsystems. IServerLauncherProperties

restoreFromProperties, saveToProperties

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

isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Field Detail

_name

protected 
String _name

_connectorService

protected 
IConnectorService _connectorService

Constructor Detail

ServerLauncher

protected ServerLauncher(
String name,
                         
IConnectorService service)

Constructs a server launcher

Parameters:: name - name of the server launcher; service - the associated connector service

Method Detail

getName

public 
String getName()

Returns the name of the server launcher

Specified by:: getName in interface IRSEModelObject

getLabel

public 
String getLabel()

Returns the label to display in a ui for the server launcher

Specified by:: getLabel in interface ILabeledObject

Returns:: the display label for the object. If this has not previously been set, this can return the name of object or some other generated or constant label. It may return null if no label can be determined.

setLabel

public void setLabel(
String label)

Sets the label to use for display in a ui for the server launcher

Specified by:: setLabel in interface ILabeledObject

Parameters:: label - A display label for this object.

getDescription

public 
String getDescription()

Returns the description of the server launcher

Specified by:: getDescription in interface IRSEModelObject
Overrides:: getDescription in class RSEModelObject

getConnectorService

public 
IConnectorService getConnectorService()

Returns the associated connector service

Specified by:: getConnectorService in interface IServerLauncherProperties

Returns:: the connector service

getPersistableParent

public 
IRSEPersistableContainer getPersistableParent()

Description copied from interface: IRSEPersistableContainer

Retrieve the parent of this object in the persistence containment hierarchy. This is related to, but not necessarily the same as, the model hierarchy.

Specified by:: getPersistableParent in interface IRSEPersistableContainer

Returns:: the parent persistent object. This is null if there is no parent.

getPersistableChildren

public 
IRSEPersistableContainer[] getPersistableChildren()