Eclipse RSE Development Guide (Galileo) - IRemoteServerLauncher (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
Interface IRemoteServerLauncher

All Superinterfaces:: IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer, IServerLauncherProperties

All Known Implementing Classes:: RemoteServerLauncher

public interface IRemoteServerLauncher
extends IServerLauncherProperties
extends IServerLauncherProperties

This is the implementation of IServerLauncherProperties. It basically allows for numerous types of server connecting, as identified in ServerLaunchType. It also captures the attributes needed to support these.

A server launcher is responsible for starting the server-side code needed for this client subsystem to access remote resources on the remote system. It starts the server half of the client/server code needed for this subsystem. It is consulted in the default implementation of connect() in IConnectorService, and the manages the properties in the Remote Server Launcher property page.

The following features are supported:

Field Summary

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

NO_CHILDREN

Method Summary

boolean getAutoDetectSSL ()


int getDaemonPort ()


int getRexecPort ()
          Returns the value of the ' Rexec Port ' attribute

ServerLaunchType getServerLaunchType ()
          Returns the value of the ' Server Launch Type ' attribute.

String getServerPath ()
          Returns the value of the ' Server Path ' attribute

String getServerScript ()
          Returns the value of the ' Server Script ' attribute

boolean isEnabledServerLaunchType ( ServerLaunchType serverLaunchType)
          This methods returns the enablement state per server launch type.

void setAutoDetectSSL (boolean auto)
          Sets whether or not to auto-detect SSL

void setDaemonPort (int newDaemonPort)
          Set the DAEMON port value, as an int

void setRexecPort (int newRexecPort)
          Set the REXEC port value, as an int

void setServerLaunchType ( ServerLaunchType value)
          Sets the value of the ' Server Launch Type' attribute

void setServerPath ( String value)
          Sets the value of the ' Server Path' attribute

void setServerScript ( String value)
          Sets the value of the ' Server Script' attribute

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

cloneServerLauncher, getConnectorService, restoreFromProperties, saveToProperties

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

getDescription, getName

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

getServerLaunchType

ServerLaunchType getServerLaunchType()

Returns the value of the ' Server Launch Type ' attribute. The literals are from the enumeration ServerLaunchType.

This is the means by which to start the server-side code, as specified by the user, typically. It is one of the constants in the enumeration class ServerLaunchType

Returns:: the value of the 'Server Launch Type' attribute.
See Also:: ServerLaunchType, setServerLaunchType(ServerLaunchType)

setServerLaunchType

void setServerLaunchType(
ServerLaunchType value)

Sets the value of the ' Server Launch Type' attribute. This is the means by which to start the server-side code, as specified by the user, typically. It is one of the constants in the enumeration class ServerLaunchType

Parameters:: value - the new value of the 'Server Launch Type' attribute.
See Also:: ServerLaunchType, getServerLaunchType()

getRexecPort

int getRexecPort()

Returns the value of the ' Rexec Port ' attribute.

If the meaning of the 'Rexec Port' attribute isn't clear, there really should be more of a description here...

Returns:: the value of the 'Rexec Port' attribute.
See Also:: setRexecPort(int)

setRexecPort

void setRexecPort(int newRexecPort)

Set the REXEC port value, as an int

setAutoDetectSSL

void setAutoDetectSSL(boolean auto)

Sets whether or not to auto-detect SSL

getAutoDetectSSL

boolean getAutoDetectSSL()

getDaemonPort

int getDaemonPort()

setDaemonPort

void setDaemonPort(int newDaemonPort)

Set the DAEMON port value, as an int

getServerPath

String getServerPath()

Returns the value of the ' Server Path ' attribute.

The path where the server lives on the remote system. Used by at least the REXEC server launch type. Will be null if not set.

Returns:: the value of the 'Server Path' attribute.
See Also:: setServerPath(String)

setServerPath

void setServerPath(
String value)

Sets the value of the ' Server Path' attribute. Set the path where the server lives on the remote system. Used by at least the REXEC server launch type.

Parameters:: value - the new value of the 'Server Path' attribute.
See Also:: getServerPath()

getServerScript

String getServerScript()

Returns the value of the ' Server Script ' attribute.

The script to run on the remote system, to start the server code.

Returns:: the value of the 'Server Script' attribute.
See Also:: setServerScript(String)

setServerScript

void setServerScript(
String value)

Sets the value of the ' Server Script' attribute. The script to run on the remote system, to start the server code.

Parameters:: value - the new value of the 'Server Script' attribute.
See Also:: getServerScript()

isEnabledServerLaunchType

boolean isEnabledServerLaunchType(
ServerLaunchType serverLaunchType)

This methods returns the enablement state per server launch type. If setServerLaunchType(ServerLaunchType) has not been called for this server launch type, then we defer to the subsystem factory's method: ISubSystemConfiguration.supportsServerLaunchType(ServerLaunchType).

See Also:: ServerLaunchType