org.eclipse.rse.core.subsystems
Class AbstractConnectorService

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DStoreConnectorService, FTPConnectorService, LocalConnectorService, SshConnectorService

public abstract class AbstractConnectorService

extends RSEModelObject

implements IConnectorService, ISystemUserIdConstants

This is a base class to make it easier to create connector service classes.

An IConnectorService object is returned from a subsystem object via getConnectorService(), and it is used to represent the live connection to a particular subsystem.

You must override/implement

• isConnected
• internalConnect
• internalDisconnect

You should override:

• reset
• getVersionReleaseModification
• getHomeDirectory
• getTempDirectory

You can override:

• supportsUserId
• requiresUserId
• supportsPassword
• requiresPassword

See Also:

AbstractConnectorServiceManager

Nested Class Summary

protected class

AbstractConnectorService.NewPasswordInfo

Field Summary

protected IServerLauncherProperties	_remoteServerLauncherProperties The cached value of the 'Remote Server Launcher' containment reference
protected Object	connectResult The result of calling connect in the server launcher object, in the connect method
protected Object	launchResult The result of calling launch in the server launcher object, in the connect method
protected Shell	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

AbstractConnectorService(String name, String description, IHost host, int port)

Method Summary

void	addCommunicationsListener(ICommunicationsListener listener) Fully implemented, no need to override.
protected void	clearCommunicationListeners() Private - used internally.
void	clearPasswordCache() Useful utility method.
void	clearPasswordCache(boolean onDisk) Useful utility method.
protected void	clearPasswordForOtherSystemsInConnection(String uid, boolean fromDisk)
void	clearUserIdCache() Useful utility method.
boolean	commit() Request a persistence manager to persist this object.
void	connect(IProgressMonitor monitor) This connection method wrappers the others (internal connect) so that registered subsystems can be notified and initialized after a connect Previous implementations that overrode this method should now change their connect() method to internalConnect()
void	deregisterSubSystem(ISubSystem ss) Removes the subsystem from teh list
void	disconnect(IProgressMonitor monitor) Disconnects from the remote system.
protected void	fireCommunicationsEvent(int eventType) Private - used internally.
protected boolean	forcePasswordToUpperCase() Useful utility method.
protected int	getCommunicationListenerCount() Private - used internally.
protected int	getConnectPort() Return the port to use for connecting to the remote server, once it is running.
String	getDescription()
String	getHomeDirectory() Not implemented, you should override if possible.
IHost	getHost() Return the host
String	getHostName() Useful utility method.
String	getHostType() Useful utility method.
protected String	getLocalUserId() Useful utility method.
String	getName() Return the name of this connector service
protected SystemSignonInformation	getPasswordInformation() Useful utility method.
protected ISystemPasswordPromptDialog	getPasswordPromptDialog(Shell shell) A default implementation is supplied, but can be overridden if desired.
ISystemValidator	getPasswordValidator() Useful utility method.
int	getPort() Return the port for this connector
ISubSystem	getPrimarySubSystem() Return the subsystem object this system is associated with
IServerLauncher	getRemoteServerLauncher() Return the remote server launcher, which implements IServerLauncher.
IServerLauncherProperties	getRemoteServerLauncherProperties() Returns the value of the 'Remote Server Launcher' containment reference.
ISignonValidator	getSignonValidator() Optionally overridable, not implemented by default.
ISubSystem[]	getSubSystems() Return all the subsystems that use this service
String	getTempDirectory() Not implemented, you should override if possible.
String	getUserId() Useful utility method.
ISystemValidator	getUserIdValidator() Useful utility method.
String	getVersionReleaseModification() Not implemented, you should override if possible.
boolean	hasRemoteSearchLauncherProperties()
boolean	hasRemoteServerLauncherProperties()
boolean	inheritConnectionUserPassword() Return true if this system can inherit the uid and password of other ISystems in this connection
protected void	internalConnect(IProgressMonitor monitor) You must override unless subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties returns true.
void	internalDisconnect(IProgressMonitor monitor)
protected void	intializeSubSystems(IProgressMonitor monitor)
protected boolean	isEnabledServerLaunchType(ISubSystem subsystem, ServerLaunchType serverLaunchType) This methods returns the enablement state per server launch type.
boolean	isPasswordCached() Useful utility method.
boolean	isPasswordCached(boolean onDisk) Useful utility method.
boolean	isSuppressSignonPrompt() Returns the suppressSignonPrompt flag.
boolean	isUsingSSL()
void	notifyConnection() Notifies all listeners of a connection through a communications event
void	notifyDisconnection() Notifies all listeners of a disconnection through a communications event
void	notifyError() Notifies all listeners of an error through a communications event
protected AbstractConnectorService.NewPasswordInfo	promptForNewPassword(SystemMessage prompt)
void	promptForPassword(boolean forcePrompt) Do not override.
void	registerSubSystem(ISubSystem ss) Set the subsystem, when its not known at constructor time
void	removeCommunicationsListener(ICommunicationsListener listener) Fully implemented, no need to override.
boolean	requiresPassword() If a password is supported this is used to determine if the password is required.
boolean	requiresUserId() Report if this connector service requires a user id.
void	reset() Optionally override if you add any instance variables.
void	setHost(IHost host)
void	setIsUsingSSL(boolean flag)
void	setPassword(String matchingUserId, String password) Useful utility method.
void	setPassword(String matchingUserId, String password, boolean persist) Useful utility method.
protected void	setPasswordInformation(SystemSignonInformation passwordInfo) Useful utility method.
void	setPort(int port) Set the port for this connector
void	setRemoteServerLauncherProperties(IServerLauncherProperties newRemoteServerLauncher) Sets the value of the 'Remote Server Launcher' containment reference
void	setSuppressSignonPrompt(boolean suppressSignonPrompt) Sets the suppressSignonPrompt flag.
void	setUserId(String newId) Set the user id for this connector
boolean	shareUserPasswordWithConnection() Return true if this connector service can share it's uid and password with other connector services in this host (connection).
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.
protected void	unintializeSubSystems(IProgressMonitor monitor)
protected void	updatePasswordForOtherSystemsInConnection(String uid, String password, boolean persistPassword)

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.subsystems.IConnectorService

isConnected

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

Field Detail

_remoteServerLauncherProperties

protected IServerLauncherProperties _remoteServerLauncherProperties

The cached value of the 'Remote Server Launcher' containment reference.

See Also:

getRemoteServerLauncher()

shell

protected Shell shell

launchResult

protected Object launchResult

The result of calling launch in the server launcher object, in the connect method

connectResult

protected Object connectResult

The result of calling connect in the server launcher object, in the connect method

Constructor Detail

AbstractConnectorService

public AbstractConnectorService(String name,
                                String description,
                                IHost host,
                                int port)

Method Detail

getVersionReleaseModification

public String getVersionReleaseModification()

Not implemented, you should override if possible.
Return the version, release, modification of the remote system, if connected, if applicable and if available. Else return null. It is up to each subsystem to decide how to interpret what is returned.
This is used to show the VRM in the property sheet, when the subsystem is selected.

Up to each implementer to decide if this will be cached.

Returns an empty string by default, override if possible

Specified by:

getVersionReleaseModification in interface IConnectorService

getHomeDirectory

public String getHomeDirectory()

Not implemented, you should override if possible.
Return the home directory of the remote system for the current user, if available.

Up to each implementer to decide how to implement, and if this will be cached.

Returns an empty string by default, override if possible

Specified by:

getHomeDirectory in interface IConnectorService

getTempDirectory

public String getTempDirectory()

Not implemented, you should override if possible.
Return the temp directory of the remote system for the current user, if available.

Up to each implementer to decide how to implement, and if this will be cached.

Returns an empty string by default, override if possible

Specified by:

getTempDirectory in interface IConnectorService

registerSubSystem

public void registerSubSystem(ISubSystem ss)

Set the subsystem, when its not known at constructor time

Specified by:

registerSubSystem in interface IConnectorService

deregisterSubSystem

public void deregisterSubSystem(ISubSystem ss)

Removes the subsystem from teh list

Specified by:

deregisterSubSystem in interface IConnectorService

Parameters:

ss -

getSubSystems

public final ISubSystem[] getSubSystems()

Description copied from interface: IConnectorService

Return all the subsystems that use this service

Specified by:

getSubSystems in interface IConnectorService

Returns:

the subsystems that use this service

getPrimarySubSystem

public final ISubSystem getPrimarySubSystem()

Description copied from interface: IConnectorService

Return the subsystem object this system is associated with

Specified by:

getPrimarySubSystem in interface IConnectorService

getHost

public final IHost getHost()

Description copied from interface: IConnectorService

Return the host

Specified by:

getHost in interface IConnectorService

Returns:

getHostType

public final String getHostType()

Useful utility method. Fully implemented, do not override.
Returns the system type for this connection:
getSubSystem().getSystemConnection().getSystemType()

Specified by:

getHostType in interface IConnectorService

getName

public final String getName()

Description copied from interface: IConnectorService

Return the name of this connector service

Specified by:

getName in interface IConnectorService

Returns:

the name of this connector service

getDescription

public final String getDescription()

Specified by:

getDescription in interface IRSEModelObject

Overrides:

getDescription in class RSEModelObject

getHostName

public final String getHostName()

Useful utility method. Fully implemented, do not override.
Returns the host name for the connection this system's subsystem is associated with:
getSubSystem().getSystemConnection().getHostName()

Specified by:

getHostName in interface IConnectorService

getUserId

public final String getUserId()

Useful utility method. Fully implemented, do not override.
Returns the active userId if we are connected. If not it returns the userId for the primary subsystem ignoring the cached userId.

Specified by:

getUserId in interface IConnectorService

getLocalUserId

protected final String getLocalUserId()

Useful utility method. Fully implemented, do not override.
Return the userId for this connector service. If there is none set for this service then it is retrieved from the primary subsystem.

setUserId

public final void setUserId(String newId)

Description copied from interface: IConnectorService

Set the user id for this connector

Specified by:

setUserId in interface IConnectorService

Parameters:

newId -

setHost

public final void setHost(IHost host)

Specified by:

setHost in interface IConnectorService

clearUserIdCache

public final void clearUserIdCache()

Useful utility method. Fully implemented, do not override.
Clear internal userId cache. Called when user uses the property dialog to change his userId. By default, sets internal userId value to null so that on the next call to getUserId() it is requeried from subsystem. Also calls clearPasswordCache().

Specified by:

clearUserIdCache in interface IConnectorService

clearPasswordCache

public final void clearPasswordCache()

Useful utility method. Fully implemented, do not override.
Clear internal password cache. Called when user uses the property dialog to change his userId. This method does not remove the password from the disk cache - only the memory cache.

Specified by:

clearPasswordCache in interface IConnectorService

See Also:

clearUserIdCache()

clearPasswordCache

public final void clearPasswordCache(boolean onDisk)

Useful utility method. Fully implemented, do not override.
Clear internal password cache. Called when user uses the property dialog to change his userId.

Specified by:

clearPasswordCache in interface IConnectorService

Parameters:

onDisk - if this is true, clear the password from the disk cache as well

See Also:

clearUserIdCache()

isPasswordCached

public final boolean isPasswordCached(boolean onDisk)

Useful utility method. Fully implemented, do not override.
Return true if password is currently saved either here or in its persisted form.

Specified by:

isPasswordCached in interface IConnectorService

Parameters:

onDisk - true if the check should be made for a persisted form as well, false if the check should be made for a password in memory only.

Returns:

true if the password is known, false otherwise.

isPasswordCached

public final boolean isPasswordCached()

Useful utility method. Fully implemented, do not override.
Return true if password is currently cached.

Specified by:

isPasswordCached in interface IConnectorService

inheritConnectionUserPassword

public final boolean inheritConnectionUserPassword()

Return true if this system can inherit the uid and password of other ISystems in this connection

Specified by:

inheritConnectionUserPassword in interface IConnectorService

Returns:

true if it can inherit the user/password

requiresPassword

public boolean requiresPassword()

Description copied from interface: IConnectorService

If a password is supported this is used to determine if the password is required. Must be ignored if supportsPassword() returns false. The default implementation of this interface should return true.

Specified by:

requiresPassword in interface IConnectorService

Returns:

true if the connector service requires a password, false if a password may be empty.

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

Returns:

true if the subsystem can use a password, false if a password is irrelevant.

requiresUserId

public boolean requiresUserId()

Description copied from interface: IConnectorService

Report if this connector service requires a user id. Returns true in default implementation. Typically used to indicate if a login dialog can allow an empty user id. Must be ignored if supportsUserId() is false.

Specified by:

requiresUserId in interface IConnectorService

Returns:

true or false to indicate if the connector service requires a user id.

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

Returns:

true if and only if the connector service can use a user id.

supportsRemoteServerLaunching

public boolean supportsRemoteServerLaunching()

Specified by:

supportsRemoteServerLaunching in interface IConnectorService

hasRemoteServerLauncherProperties

public boolean hasRemoteServerLauncherProperties()

Specified by:

hasRemoteServerLauncherProperties in interface IConnectorService

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.

Specified by:

supportsServerLaunchProperties in interface IConnectorService

shareUserPasswordWithConnection

public boolean shareUserPasswordWithConnection()

Return true if this connector service can share it's uid and password with other connector services in this host (connection).

Specified by:

shareUserPasswordWithConnection in interface IConnectorService

Returns:

true if it can share the user/password

promptForPassword

public void promptForPassword(boolean forcePrompt)
                       throws InterruptedException

Do not override. Sets the signon information for this connector service. The search order for the password is as follows:

1. First check if the password is already known by this connector service and that it is still valid.
2. If password not known then look in the password store and verify that it is still valid.
3. If a valid password is not found then prompt the user.

Must be run in the UI thread. Can be null if the password is known to exist in either this class or in the password store.

Specified by:

promptForPassword in interface IConnectorService

Parameters:

forcePrompt - if true then present the prompt even if the password was found and is valid.

Throws:

InterruptedException - if user is prompted and user cancels that prompt or if isSuppressSignonPrompt is true.

clearPasswordForOtherSystemsInConnection

protected void clearPasswordForOtherSystemsInConnection(String uid,
                                                        boolean fromDisk)

updatePasswordForOtherSystemsInConnection

protected void updatePasswordForOtherSystemsInConnection(String uid,
                                                         String password,
                                                         boolean persistPassword)

getPasswordPromptDialog

protected final ISystemPasswordPromptDialog getPasswordPromptDialog(Shell shell)

A default implementation is supplied, but can be overridden if desired.
Instantiates and returns the dialog to prompt for the userId and password.

By default returns an instance of SystemPasswordPromptDialog. Calls forcePasswordToUpperCase() to decide whether the user Id and password should be folded to uppercase.

Calls getUserIdValidator() and getPasswordValidator() to set the validators. These return null by default by you can override them.

Before calling open() on the dialog, the getPassword(Shell) method that calls this will call setSystemInput(this).

After return, it will call wasCancelled() and getUserId(), getIsUserIdChanged(), getIsUserIdChangePermanent() and getPassword().

Returns:

An instance of a dialog class that implements the ISystemPasswordPromptDialog interface

getPasswordInformation

protected SystemSignonInformation getPasswordInformation()

Useful utility method. Fully implemented, no need to override.

Returns:

the password information for the primary subsystem of this connector service. Assumes it has been set by the subsystem at the time the subsystem acquires the connector service.

setPasswordInformation

protected void setPasswordInformation(SystemSignonInformation passwordInfo)

Useful utility method. Fully implemented, no need to override.
Sets the password information for this system's subsystem.

Parameters:

passwordInfo - the password information object

setPassword

public void setPassword(String matchingUserId,
                        String password,
                        boolean persist)

Useful utility method. Fully implemented, no need to override.
Set the password if you got it from somewhere

Specified by:

setPassword in interface IConnectorService

Parameters:

matchingUserId - the user for which to set the password

password - the password to set for this userid

persist - true if the password is to be persisted as well

setPassword

public void setPassword(String matchingUserId,
                        String password)

Useful utility method. Fully implemented, no need to override.
A convenience method, fully equivalent to setPassword(matchingUserId, password, false)

Specified by:

setPassword in interface IConnectorService

Parameters:

matchingUserId - the user for which to set the password

password - the password to set for this userid

forcePasswordToUpperCase

protected boolean forcePasswordToUpperCase()

Useful utility method. Fully implemented, no need to override.
Should passwords be folded to uppercase? By default, returns:

getSubSystem().forceUserIdToUpperCase()

getUserIdValidator

public ISystemValidator getUserIdValidator()

Useful utility method. Fully implemented, no need to override.
Get the userId input validator to use in the password dialog prompt.

By default, returns

getSubSystem().getParentSubSystemConfiguration().getUserIdValidator()

getPasswordValidator

public ISystemValidator getPasswordValidator()

Useful utility method. Fully implemented, no need to override.
Get the password input validator to use in the password dialog prompt.

By default, returns:

getSubSystem().getParentSubSystemConfiguration().getPasswordValidator()

getSignonValidator

public ISignonValidator getSignonValidator()

Optionally overridable, not implemented by default.
Get the signon validator to use in the password dialog prompt. By default, returns null.

connect

public final void connect(IProgressMonitor monitor)
                   throws Exception

This connection method wrappers the others (internal connect) so that registered subsystems can be notified and initialized after a connect Previous implementations that overrode this method should now change their connect() method to internalConnect()

Specified by:

connect in interface IConnectorService

Throws:

Exception

intializeSubSystems

protected void intializeSubSystems(IProgressMonitor monitor)

unintializeSubSystems

protected void unintializeSubSystems(IProgressMonitor monitor)

internalConnect

protected void internalConnect(IProgressMonitor monitor)
                        throws Exception

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 getRemoteServerLauncher(), and if IServerLauncher.isLaunched() returns false, to call IServerLauncher.launch(IProgressMonitor).

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

Throws:

Exception

getConnectPort

protected int getConnectPort()

Return the port to use for connecting to the remote server, once it is running. By default, this is the subsystem's port property, via getPort(). Override if appropriate.
This is called by the default implementation of connect(IProgressMonitor), if subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties() is true.

disconnect

public final void disconnect(IProgressMonitor monitor)
                      throws Exception

Disconnects from the remote system.

You must override if subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties returns false.

If the subsystem supports server launch the default behavior is to use the same remote server launcher created in connect() and call disconnect().

This is called, by default, from the disconnect() method of the subsystem.

Specified by:

disconnect in interface IConnectorService

Throws:

Exception

See Also:

IServerLauncher.disconnect()

internalDisconnect

public void internalDisconnect(IProgressMonitor monitor)
                        throws Exception

Throws:

Exception

getRemoteServerLauncher

public IServerLauncher getRemoteServerLauncher()

Return the remote server launcher, which implements IServerLauncher. This is called by the default implementation of connect() and disconnect(), if subsystem.getParentSubSystemConfiguration().supportsServerLaunchProperties returns true.

This returns null be default!

reset

public void reset()

Optionally override if you add any instance variables.
The following is called whenever a system is redefined or disconnected. Each subsystem needs to be informed so it can clear out any expansions, etc. By default it does nothing. Override if you have an internal object that must be nulled out.

Specified by:

reset in interface IConnectorService

addCommunicationsListener

public void addCommunicationsListener(ICommunicationsListener listener)

Fully implemented, no need to override.

Specified by:

addCommunicationsListener in interface IConnectorService

See Also:

IConnectorService.addCommunicationsListener(ICommunicationsListener)

removeCommunicationsListener

public void removeCommunicationsListener(ICommunicationsListener listener)

Fully implemented, no need to override.

Specified by:

removeCommunicationsListener in interface IConnectorService

See Also:

IConnectorService.removeCommunicationsListener(ICommunicationsListener)

fireCommunicationsEvent

protected void fireCommunicationsEvent(int eventType)

Private - used internally.
Helper method for firing communication events

getCommunicationListenerCount

protected int getCommunicationListenerCount()

Private - used internally.
Returns the count of active communication listeners (i.e. excludes passive listeners.)

clearCommunicationListeners

protected void clearCommunicationListeners()

Private - used internally.

isSuppressSignonPrompt

public boolean isSuppressSignonPrompt()

Returns the suppressSignonPrompt flag. If this is set to true then the user will not be prompted to signon, instead an InterruptedException will be thrown by the promptForPassword method.

Specified by:

isSuppressSignonPrompt in interface IConnectorService

Returns:

boolean

setSuppressSignonPrompt

public void setSuppressSignonPrompt(boolean suppressSignonPrompt)

Sets the suppressSignonPrompt flag. Tool writers can use this to temporarily disable the user from being prompted to signon. This would cause the promptForPassword method to throw an InterruptedException instead of prompting. The intent of this method is to allow tool writeres to prevent multiple signon prompts during a set period of time (such as a series of related communication calls) if the user cancels the first prompt. It is the callers responsability to set this value back to false when the tool no longer needs to suppress the signon prompt or all other tools sharing this connection will be affected.

Specified by:

setSuppressSignonPrompt in interface IConnectorService

Parameters:

suppressSignonPrompt -

isEnabledServerLaunchType

protected boolean isEnabledServerLaunchType(ISubSystem subsystem,
                                            ServerLaunchType serverLaunchType)

This methods returns the enablement state per server launch type. If RemoteServerLauncher.enableServerLaunchType(ServerLaunchType, boolean) has not been called for this server launch type, then it is enabled by default.

See Also:

ServerLaunchType

notifyDisconnection

public void notifyDisconnection()

Description copied from interface: IConnectorService

Notifies all listeners of a disconnection through a communications event

Specified by:

notifyDisconnection in interface IConnectorService

notifyConnection

public void notifyConnection()

Description copied from interface: IConnectorService

Notifies all listeners of a connection through a communications event

Specified by:

notifyConnection in interface IConnectorService

notifyError

public void notifyError()

Description copied from interface: IConnectorService

Notifies all listeners of an error through a communications event

Specified by:

notifyError in interface IConnectorService

setPort

public void setPort(int port)

Description copied from interface: IConnectorService

Set the port for this connector

Specified by:

setPort in interface IConnectorService

Parameters:

port -

getPort

public int getPort()

Description copied from interface: IConnectorService

Return the port for this connector

Specified by:

getPort in interface IConnectorService

isUsingSSL

public boolean isUsingSSL()

Specified by:

isUsingSSL in interface IConnectorService

setIsUsingSSL

public void setIsUsingSSL(boolean flag)

Specified by:

setIsUsingSSL in interface IConnectorService

getRemoteServerLauncherProperties

public IServerLauncherProperties getRemoteServerLauncherProperties()

Description copied from interface: IConnectorService

Returns the value of the 'Remote Server Launcher' containment reference. It is bidirectional and its opposite is 'Parent Sub System'.

Get the remote server launcher, which may be null. This an optional object containing properties used to launch the remote server that communicates with this subsystem.

Specified by:

getRemoteServerLauncherProperties in interface IConnectorService

Returns:

the value of the 'Remote Server Launcher' containment reference.

See Also:

#setRemoteServerLauncher(IServerLauncherProperties), org.eclipse.rse.core.subsystems.SubsystemsPackage#getSubSystem_RemoteServerLauncher(), org.eclipse.rse.core.subsystems.IServerLauncherProperties#getParentSubSystem

setRemoteServerLauncherProperties

public void setRemoteServerLauncherProperties(IServerLauncherProperties newRemoteServerLauncher)

Description copied from interface: IConnectorService

Sets the value of the 'Remote Server Launcher' containment reference. Set the remote server launcher, which is an optional object containing properties used to launch the remote server that communicates with this subsystem.

Specified by:

setRemoteServerLauncherProperties in interface IConnectorService

Parameters:

newRemoteServerLauncher - the new value of the 'Remote Server Launcher' containment reference.

See Also:

#getRemoteServerLauncher()

hasRemoteSearchLauncherProperties

public boolean hasRemoteSearchLauncherProperties()

commit

public boolean commit()

Description copied from interface: org.eclipse.rse.core.persistance.IRSEPersistableContainer

Request a persistence manager to persist this object.

Specified by:

commit in interface org.eclipse.rse.core.persistance.IRSEPersistableContainer

Returns:

true if the object was persisted.

promptForNewPassword

protected AbstractConnectorService.NewPasswordInfo promptForNewPassword(SystemMessage prompt)
                                                                 throws InterruptedException

Throws:

InterruptedException