org.eclipse.rse.connectorservice.local
Class LocalConnectorService

java.lang.Object
  org.eclipse.rse.core.model.PropertySetContainer
      org.eclipse.rse.core.model.RSEModelObject
          org.eclipse.rse.core.subsystems.AbstractConnectorService
              org.eclipse.rse.connectorservice.local.LocalConnectorService

All Implemented Interfaces:

IConnectorService, IPropertySetContainer, IRSEModelObject, org.eclipse.rse.core.persistance.IRSEPersistableContainer, ISystemUserIdConstants

public class LocalConnectorService

extends AbstractConnectorService

System class required by the remote systems framework. This represents the live connection at tool runtime. Since we don't really have such a thing for local files, this is pretty well empty.

Nested Class Summary

Nested classes inherited from class org.eclipse.rse.core.subsystems.AbstractConnectorService

AbstractConnectorService.NewPasswordInfo

Field Summary

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

_remoteServerLauncherProperties, connectResult, launchResult, shell

Fields inherited from class org.eclipse.rse.core.model.RSEModelObject

_isDirty, _wasRestored

Fields inherited from interface org.eclipse.rse.core.ISystemUserIdConstants

USERID_LOCATION_CONNECTION, USERID_LOCATION_DEFAULT_OVERALL, USERID_LOCATION_DEFAULT_SYSTEMTYPE, USERID_LOCATION_NOTSET, USERID_LOCATION_SUBSYSTEM

Constructor Summary

LocalConnectorService(IHost host)
Constructor when we don't have a subsystem yet.

Method Summary

String	getHomeDirectory() Return the home directory of the operating system for the current user, if available.
String	getTempDirectory() Return the temp directory of the operating system for the current user, if available.
String	getVersionReleaseModification() Return the version, release, modification of the operating system.
boolean	hasRemoteServerLauncherProperties()
protected void	internalConnect(IProgressMonitor monitor) You must override unless subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties returns true.
void	internalDisconnect(IProgressMonitor monitor)
boolean	isConnected() Return true if currently connected.
boolean	supportsPassword() Can be used to determine if a password field is present on a login dialog for this connector service.
boolean	supportsRemoteServerLaunching()
boolean	supportsServerLaunchProperties() Tell us if this subsystem factory supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started.
boolean	supportsUserId() Report if this connector service can use a user identifier.

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

addCommunicationsListener, clearCommunicationListeners, clearPasswordCache, clearPasswordCache, clearPasswordForOtherSystemsInConnection, clearUserIdCache, commit, connect, deregisterSubSystem, disconnect, fireCommunicationsEvent, forcePasswordToUpperCase, getCommunicationListenerCount, getConnectPort, getDescription, getHost, getHostName, getHostType, getLocalUserId, getName, getPasswordInformation, getPasswordPromptDialog, getPasswordValidator, getPort, getPrimarySubSystem, getRemoteServerLauncher, getRemoteServerLauncherProperties, getSignonValidator, getSubSystems, getUserId, getUserIdValidator, hasRemoteSearchLauncherProperties, inheritConnectionUserPassword, intializeSubSystems, isEnabledServerLaunchType, isPasswordCached, isPasswordCached, isSuppressSignonPrompt, isUsingSSL, notifyConnection, notifyDisconnection, notifyError, promptForNewPassword, promptForPassword, registerSubSystem, removeCommunicationsListener, requiresPassword, requiresUserId, reset, setHost, setIsUsingSSL, setPassword, setPassword, setPasswordInformation, setPort, setRemoteServerLauncherProperties, setSuppressSignonPrompt, setUserId, shareUserPasswordWithConnection, unintializeSubSystems, updatePasswordForOtherSystemsInConnection

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

compareStrings, isDirty, setDirty, setWasRestored, wasRestored

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

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

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.model.IPropertySetContainer

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

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

isDirty, setDirty, setWasRestored, wasRestored

Constructor Detail

LocalConnectorService

public LocalConnectorService(IHost host)

Constructor when we don't have a subsystem yet. Call setSubSystem after.

Method Detail

internalDisconnect

public void internalDisconnect(IProgressMonitor monitor)
                        throws Exception

Overrides:

internalDisconnect in class AbstractConnectorService

Throws:

Exception

See Also:

org.eclipse.rse.core.subsystems.AbstractConnectorService#disconnect()

internalConnect

protected void internalConnect(IProgressMonitor monitor)
                        throws Exception

Description copied from class: AbstractConnectorService

You must override unless subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties returns true.

Attempt to connect to the remote system.
If the subsystem supports server launch, the default behavior is to get the remote server launcher by AbstractConnectorService.getRemoteServerLauncher(), and if IServerLauncher.isLaunched() returns false, to call IServerLauncher.launch(IProgressMonitor).

This is called, by default, from the connect(...) methods of the subsystem.

Overrides:

internalConnect in class AbstractConnectorService

Throws:

Exception

See Also:

IConnectorService.connect(IProgressMonitor)

isConnected

public boolean isConnected()

Description copied from interface: IConnectorService

Return true if currently connected.

See Also:

IConnectorService.isConnected()

getVersionReleaseModification

public String getVersionReleaseModification()

Return the version, release, modification of the operating system.

Returns System.getProperty("os.version")

Specified by:

getVersionReleaseModification in interface IConnectorService

Overrides:

getVersionReleaseModification in class AbstractConnectorService

getHomeDirectory

public String getHomeDirectory()

Return the home directory of the operating system for the current user, if available.

Returns System.getProperty("user.home")

Specified by:

getHomeDirectory in interface IConnectorService

Overrides:

getHomeDirectory in class AbstractConnectorService

getTempDirectory

public String getTempDirectory()

Return the temp directory of the operating system for the current user, if available.

Returns System.getProperty("java.io.tmpdir")

Specified by:

getTempDirectory in interface IConnectorService

Overrides:

getTempDirectory in class AbstractConnectorService

hasRemoteServerLauncherProperties

public boolean hasRemoteServerLauncherProperties()

supportsRemoteServerLaunching

public boolean supportsRemoteServerLaunching()

supportsServerLaunchProperties

public boolean supportsServerLaunchProperties()

Description copied from interface: IConnectorService

Tell us if this subsystem factory supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started. There is a Server Launch Setting property page, with a pluggable composite, where users can configure these properties.

supportsPassword

public boolean supportsPassword()

Description copied from interface: IConnectorService

Can be used to determine if a password field is present on a login dialog for this connector service. The default implementation of this interface should return true.

Specified by:

supportsPassword in interface IConnectorService

Overrides:

supportsPassword in class AbstractConnectorService

Returns:

false

See Also:

AbstractConnectorService.supportsPassword()

supportsUserId

public boolean supportsUserId()

Description copied from interface: IConnectorService

Report if this connector service can use a user identifier. Returns true in default implementation. Typically used to indicate if a login dialog needs to be presented when connecting.

Specified by:

supportsUserId in interface IConnectorService

Overrides:

supportsUserId in class AbstractConnectorService

Returns:

false

See Also:

AbstractConnectorService.supportsUserId()