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


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
                  
org.eclipse.rse.core.subsystems.RemoteServerLauncher

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

public class RemoteServerLauncher
extends ServerLauncher
implements IRemoteServerLauncher
extends ServerLauncher
implements IRemoteServerLauncher

This subclass of IServerLauncherProperties is for use by some dstore-based subsystems, although is possibly of value to vendors as well. The dstore-based subsystems use server code written in Java, on top of the datastore technology. You can read about this in the developer guide for Remote System Explorer. The bottom line, however, is we offer the user a number of ways to start that remote server from the client, as well to connect to it if it is already running. This class encapsulates the properties to support that.

Create instances via ISubSystemConfiguration.createServerLauncher(IConnectorService)

The following features are implemented:

Field Summary

protected boolean _autoDetectSSL


protected int _daemonPort


protected boolean _hasSetServerLaunchType


protected int _rexecPort


protected IPropertyType _serverLauncherEnumType


protected ServerLaunchType _serverLaunchType


protected String _serverPath


protected String _serverScript


protected static boolean AUTODETECT_SSL_EDEFAULT


protected static int DAEMON_PORT_EDEFAULT


protected String KEY_AUTODETECT_SSL


protected String KEY_DAEMON_PORT


protected String KEY_REXEC_PORT


protected String KEY_SERVER_LAUNCH_TYPE_NAME


protected String KEY_SERVER_PATH


protected String KEY_SERVER_SCRIPT


protected String PROPERTY_SET_NAME


protected static String REMOTE_ATTRIBUTES_EDEFAULT


protected static String RESTRICTED_TYPES_EDEFAULT


protected static int REXEC_PORT_EDEFAULT


protected static ServerLaunchType SERVER_LAUNCH_TYPE_EDEFAULT


protected static String SERVER_PATH_EDEFAULT


protected static String SERVER_SCRIPT_EDEFAULT


Fields inherited from class org.eclipse.rse.core.subsystems. ServerLauncher

_connectorService, _name

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

NO_CHILDREN

Constructor Summary

RemoteServerLauncher ( String name, IConnectorService connectorService)


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!

void enableServerLaunchType ( ServerLaunchType serverLaunchType, boolean enable)


boolean getAutoDetectSSL ()
          Return the whether or not to auto-detect SSL

int getDaemonPort ()
          Return the port used for the DAEMON option, as an Integer

int getRexecPort ()
          Return the port used for the REXEC option, as an Integer

IPropertyType getServerLauncherPropertyType ()


ServerLaunchType getServerLaunchType ()
          This is the means by which to start the server-side code, as specified by the user, typically

ServerLaunchType getServerLaunchTypeGen ()
          Generated.

String getServerPath ()
          The path where the server lives on the remote system.

String getServerScript ()
          The script to run on the remote system, to start the server code

protected ServerLaunchType[] getSupportedLauncherEnumTypes ()


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

boolean isSetServerLaunchType ()


void restoreFromProperties ()
          Update cached values based on IPropertySets

void saveToProperties ()
          Store cached values based on IPropertySets

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 setRestrictedType ( String attributeName, String attributeValue)
          Deprecated.

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

void setServerLaunchType ( ServerLaunchType newServerLaunchType)
          This is the means by which to start the server-side code, as specified by the user, typically.

void setServerPath ( String newServerPath)
          The path where the server lives on the remote system.

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

Methods inherited from class org.eclipse.rse.core.subsystems. ServerLauncher

commit, getConnectorService, getDescription, getLabel, getName, getPersistableChildren, getPersistableParent, setLabel

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

getConnectorService

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

Field Detail

SERVER_LAUNCH_TYPE_EDEFAULT

protected static final 
ServerLaunchType SERVER_LAUNCH_TYPE_EDEFAULT

PROPERTY_SET_NAME

protected final 
String PROPERTY_SET_NAME

See Also:: Constant Field Values

KEY_DAEMON_PORT

protected final 
String KEY_DAEMON_PORT

See Also:: Constant Field Values

KEY_REXEC_PORT

protected final 
String KEY_REXEC_PORT

See Also:: Constant Field Values

KEY_SERVER_LAUNCH_TYPE_NAME

protected final 
String KEY_SERVER_LAUNCH_TYPE_NAME

See Also:: Constant Field Values

KEY_SERVER_PATH

protected final 
String KEY_SERVER_PATH

See Also:: Constant Field Values

KEY_SERVER_SCRIPT

protected final 
String KEY_SERVER_SCRIPT

See Also:: Constant Field Values

KEY_AUTODETECT_SSL

protected final 
String KEY_AUTODETECT_SSL

See Also:: Constant Field Values

_serverLaunchType

protected 
ServerLaunchType _serverLaunchType

_hasSetServerLaunchType

protected boolean _hasSetServerLaunchType

REXEC_PORT_EDEFAULT

protected static final int REXEC_PORT_EDEFAULT

See Also:: Constant Field Values

_rexecPort

protected int _rexecPort

DAEMON_PORT_EDEFAULT

protected static final int DAEMON_PORT_EDEFAULT

See Also:: Constant Field Values

_daemonPort

protected int _daemonPort

SERVER_PATH_EDEFAULT

protected static final 
String SERVER_PATH_EDEFAULT

_serverPath

protected 
String _serverPath

SERVER_SCRIPT_EDEFAULT

protected static final 
String SERVER_SCRIPT_EDEFAULT

_serverScript

protected 
String _serverScript

REMOTE_ATTRIBUTES_EDEFAULT

protected static final 
String REMOTE_ATTRIBUTES_EDEFAULT

RESTRICTED_TYPES_EDEFAULT

protected static final 
String RESTRICTED_TYPES_EDEFAULT

AUTODETECT_SSL_EDEFAULT

protected static final boolean AUTODETECT_SSL_EDEFAULT

See Also:: Constant Field Values

_autoDetectSSL

protected boolean _autoDetectSSL

_serverLauncherEnumType

protected 
IPropertyType _serverLauncherEnumType

Constructor Detail

RemoteServerLauncher

public RemoteServerLauncher(
String name,
                            
IConnectorService connectorService)

Method Detail

getServerLauncherPropertyType

public 
IPropertyType getServerLauncherPropertyType()

getSupportedLauncherEnumTypes

protected 
ServerLaunchType[] getSupportedLauncherEnumTypes()

restoreFromProperties

public void restoreFromProperties()

Description copied from interface: IServerLauncherProperties

Update cached values based on IPropertySets

Specified by:: restoreFromProperties in interface IServerLauncherProperties

saveToProperties

public void saveToProperties()

Description copied from interface: IServerLauncherProperties

Store cached values based on IPropertySets

Specified by:: saveToProperties in interface IServerLauncherProperties

cloneServerLauncher

public 
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! Be sure to call super.cloneServerLauncher(newOne) first.

Specified by:: cloneServerLauncher in interface IServerLauncherProperties
Overrides:: cloneServerLauncher in class ServerLauncher

Returns:: the given new server launcher, for convenience.

getServerLaunchType

public 
ServerLaunchType getServerLaunchType()

This is the means by which to start the server-side code, as specified by the user, typically.

Specified by:: getServerLaunchType in interface IRemoteServerLauncher

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

getServerLaunchTypeGen

public 
ServerLaunchType getServerLaunchTypeGen()

Generated. Do not call or use.

setServerLaunchType

public void setServerLaunchType(
ServerLaunchType newServerLaunchType)

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

Specified by:: setServerLaunchType in interface IRemoteServerLauncher

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

isSetServerLaunchType

public boolean isSetServerLaunchType()

getRexecPort

public int getRexecPort()

Return the port used for the REXEC option, as an Integer

Specified by:: getRexecPort in interface IRemoteServerLauncher

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

setRexecPort

public void setRexecPort(int newRexecPort)

Set the REXEC port value, as an int

Specified by:: setRexecPort in interface IRemoteServerLauncher

getAutoDetectSSL

public boolean getAutoDetectSSL()

Return the whether or not to auto-detect SSL

Specified by:: getAutoDetectSSL in interface IRemoteServerLauncher

setAutoDetectSSL

public void setAutoDetectSSL(boolean auto)

Sets whether or not to auto-detect SSL

Specified by:: setAutoDetectSSL in interface IRemoteServerLauncher

getDaemonPort

public int getDaemonPort()

Return the port used for the DAEMON option, as an Integer

Specified by:: getDaemonPort in interface IRemoteServerLauncher

setDaemonPort

public void setDaemonPort(int newDaemonPort)

Set the DAEMON port value, as an int

Specified by:: setDaemonPort in interface IRemoteServerLauncher

getServerPath

public 
String getServerPath()

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.

Specified by:: getServerPath in interface IRemoteServerLauncher

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

setServerPath

public void setServerPath(
String newServerPath)

The path where the server lives on the remote system. Used by at least the REXEC server launch type.

Specified by:: setServerPath in interface IRemoteServerLauncher

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

getServerScript

public 
String getServerScript()

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

Specified by:: getServerScript in interface IRemoteServerLauncher

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

setServerScript

public void setServerScript(
String newServerScript)

Description copied from interface: IRemoteServerLauncher

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

Specified by:: setServerScript in interface IRemoteServerLauncher

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

isEnabledServerLaunchType

public boolean isEnabledServerLaunchType(
ServerLaunchType serverLaunchType)

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

Specified by:: isEnabledServerLaunchType in interface IRemoteServerLauncher

See Also:: ServerLaunchType

setRestrictedType

public void setRestrictedType(
String attributeName,
                              
String attributeValue)

Deprecated.

enableServerLaunchType

public void enableServerLaunchType(
ServerLaunchType serverLaunchType,
                                   boolean enable)