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


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

All Implemented Interfaces:: IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer, IConnectorService

public abstract class BasicConnectorService
extends AbstractConnectorService
extends AbstractConnectorService

A basic connector service is one that does not require any type of authentication to connect to its target system. Since this is the case, many of the methods of IConnectorService are implemented only in skeletal form.

Field Summary

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

NO_CHILDREN

Constructor Summary

BasicConnectorService ( String name, String description, IHost host, int port)
          Constructs a basic connector service.

Method Summary

void acquireCredentials (boolean refresh)
          Acquires credentials.

void clearCredentials ()
          Clears credentials.

void clearPassword (boolean persist, boolean propagate)
          Clears a password.

String getUserId ()
          Gets the user id.

boolean hasPassword (boolean onDisk)
          Indicates the presence of a password.

boolean inheritsCredentials ()
          Indicates if this connector service can inherit its credentials from others.

boolean isSuppressed ()
          Indicates if this connector service is currently being suppressed.

void removePassword ()
          Removes the persistent form of a password.

void removeUserId ()
          Removes the persistent form of the default user id.

boolean requiresPassword ()
          Indicates if this connector service requires passwords.

boolean requiresUserId ()
          Indicates if this connector service requires a user id.

void savePassword ()
          Saves the remembered password persistently.

void saveUserId ()
          Saves the remembered user id persistently.

void setPassword ( String matchingUserId, String password, boolean persist, boolean propagate)
          Sets the password for a particular user id and optionally persists it.

void setSuppressed (boolean suppress)
          Sets the suppressed state of this connector service.

void setUserId ( String userId)
          Sets the user id for this connector service.

boolean sharesCredentials ()
          Indicates if credentials are shared with other connector services.

boolean supportsPassword ()
          Indicates if this connector service understands passwords.

boolean supportsUserId ()
          Indicates if this connector service understands user ids.

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

addCommunicationsListener, commit, connect, deregisterSubSystem, disconnect, fireCommunicationsEvent, getConnectPort, getDenyPasswordSave, getDescription, getHomeDirectory, getHost, getHostName, getName, getPersistableChildren, getPersistableParent, getPort, getPrimarySubSystem, getRemoteServerLauncher, getRemoteServerLauncherProperties, getSubSystems, getTempDirectory, getVersionReleaseModification, hasActiveCommunicationListeners, hasRemoteServerLauncherProperties, initializeSubSystems, internalConnect, internalDisconnect, isServerLaunchTypeEnabled, isUsingSSL, notifyConnection, notifyDisconnection, notifyError, postConnect, postDisconnect, preConnect, preDisconnect, registerSubSystem, removeCommunicationsListener, reset, setDenyPasswordSave, setHost, setIsUsingSSL, setPort, setRemoteServerLauncherProperties, supportsRemoteServerLaunching, supportsServerLaunchProperties, uninitializeSubSystems

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

isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Constructor Detail

BasicConnectorService

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

Constructs a basic connector service.

Parameters:: name - The name of the connector service; description - The description of the connector service; host - the host associated with this connector service; port - the port used by this connector service, if IP based

Method Detail

supportsPassword

public boolean supportsPassword()

Indicates if this connector service understands passwords. This implementation always returns false. Override if necessary.

Returns:: false
See Also:: IConnectorService.supportsPassword()

requiresPassword

public boolean requiresPassword()

Indicates if this connector service requires passwords. This implementation always returns false. Override if necessary.

Returns:: false
See Also:: IConnectorService.requiresPassword()

supportsUserId

public boolean supportsUserId()

Indicates if this connector service understands user ids. This implementation always returns false. Override if necessary.

Returns:: false
See Also:: IConnectorService.supportsUserId()

requiresUserId

public boolean requiresUserId()

Indicates if this connector service requires a user id. This implementation always returns false. Override if necessary.

Returns:: false
See Also:: IConnectorService.requiresUserId()

acquireCredentials

public void acquireCredentials(boolean refresh)
                        throws 
OperationCanceledException

Acquires credentials. This implementation does nothing.

Parameters:: refresh - if true will force the connector service to discard any remembered value and reacquire the credentials.
Throws:: OperationCanceledException - if acquisition of the credentials is cancelled or is being suppressed.
See Also:: IConnectorService.acquireCredentials(boolean)

clearCredentials

public void clearCredentials()

Clears credentials. This implementation does nothing.

See Also:: IConnectorService.clearCredentials()

clearPassword

public void clearPassword(boolean persist,
                          boolean propagate)

Clears a password. This implementation does nothing.

Parameters:: persist - if true, clears the persistent form of the password; propagate - true if this password should be cleared in related connector services.
See Also:: IConnectorService.clearPassword(boolean, boolean)

getUserId

public 
String getUserId()

Gets the user id. This implementation returns null.

Returns:: null
See Also:: IConnectorService.getUserId()

hasPassword

public boolean hasPassword(boolean onDisk)

Indicates the presence of a password. This implementation returns false.

Parameters:: onDisk - true if checking for a persistent form of a password
Returns:: false
See Also:: IConnectorService.hasPassword(boolean)

inheritsCredentials

public boolean inheritsCredentials()

Indicates if this connector service can inherit its credentials from others. This implementation returns false.

Returns:: false
See Also:: IConnectorService.inheritsCredentials()

isSuppressed

public boolean isSuppressed()

Indicates if this connector service is currently being suppressed. This implementation returns false.

Returns:: false
See Also:: IConnectorService.isSuppressed()

removePassword

public void removePassword()

Removes the persistent form of a password. This implementation does nothing.

See Also:: IConnectorService.removePassword()

removeUserId

public void removeUserId()

Removes the persistent form of the default user id. This implementation does nothing.

See Also:: IConnectorService.removeUserId()

savePassword

public void savePassword()

Saves the remembered password persistently. This implementation does nothing.

See Also:: IConnectorService.savePassword()

saveUserId

public void saveUserId()

Saves the remembered user id persistently. This implementation does nothing.

See Also:: IConnectorService.saveUserId()

setPassword

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

Sets the password for a particular user id and optionally persists it. This implementation does nothing.

Parameters:: matchingUserId - the user id to set the password for; password - the password to set.; persist - true if this is to be persisted.; propagate - true if this password should be propagated to other connector services.
See Also:: IConnectorService.setPassword(java.lang.String, java.lang.String, boolean, boolean)

sharesCredentials

public boolean sharesCredentials()

Indicates if credentials are shared with other connector services. This implementation returns false.

Returns:: true if it can share the credentials
See Also:: IConnectorService.sharesCredentials()

setSuppressed

public void setSuppressed(boolean suppress)

Sets the suppressed state of this connector service. This implementation does nothing.

Parameters:: suppress - true if this connector service should be suppressed.
See Also:: IConnectorService.setSuppressed(boolean)

setUserId

public void setUserId(
String userId)

Sets the user id for this connector service. This implementation does nothing.

Parameters:: userId - the user id to set for this service.
See Also:: IConnectorService.setUserId(java.lang.String)