|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.rse.core.subsystems.AbstractDelegatingConnectorService
public abstract class AbstractDelegatingConnectorService
| Field Summary | |
|---|---|
protected IHost |
_host
|
| Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
|---|
NO_CHILDREN |
| Constructor Summary | |
|---|---|
AbstractDelegatingConnectorService(IHost host)
Creates a new delegating connector service for a particular host. |
|
| Method Summary | |
|---|---|
void |
acquireCredentials(boolean forcePrompt)
Acquire the credentials for this connector service. |
void |
addCommunicationsListener(ICommunicationsListener listener)
Register a communications listener. |
boolean |
addPropertySet(IPropertySet set)
Adds an existing property set to this container. |
boolean |
addPropertySets(IPropertySet[] sets)
Adds a number of existing property sets to this container. |
void |
clearCredentials()
Clears the credentials held by this service. |
void |
clearPassword(boolean clearDiskCache,
boolean propagate)
Clear password held by this service and optionally clear its persistent form. |
void |
clonePropertySets(IPropertySetContainer targetContainer)
Make copies of a list of property sets and add them to the specified container. |
boolean |
commit()
Request a persistence manager to persist this object. |
void |
connect(IProgressMonitor monitor)
Connect to the remote system. |
IPropertySet |
createPropertySet(String name)
Creates a new property set of a particular name in this container. |
IPropertySet |
createPropertySet(String name,
String description)
Creates a new property set of a particular name and description in this container. |
void |
deregisterSubSystem(ISubSystem ss)
Deregister the subsystem. |
void |
disconnect(IProgressMonitor monitor)
Disconnect from the remote system. |
boolean |
getDenyPasswordSave()
Retrieves the value of the "DENY_PASSWORD_SAVE" property of this connector service. |
String |
getDescription()
|
String |
getHomeDirectory()
|
IHost |
getHost()
|
String |
getHostName()
|
String |
getName()
|
IRSEPersistableContainer[] |
getPersistableChildren()
Retrieves the children of this object in the persistence containment hierarchy. |
IRSEPersistableContainer |
getPersistableParent()
Retrieve the parent of this object in the persistence containment hierarchy. |
int |
getPort()
|
ISubSystem |
getPrimarySubSystem()
|
IPropertySet |
getPropertySet(String name)
Retrieves a particular property set by its name. |
IPropertySet[] |
getPropertySets()
Retrieves an array all property sets known to this container. |
abstract IConnectorService |
getRealConnectorService()
|
IServerLauncher |
getRemoteServerLauncher()
|
IServerLauncherProperties |
getRemoteServerLauncherProperties()
Gets the properties associated with a remote server launcher. |
ISubSystem[] |
getSubSystems()
Return all the subsystems that use this connector service |
String |
getTempDirectory()
|
String |
getUserId()
|
String |
getVersionReleaseModification()
|
boolean |
hasPassword(boolean onDisk)
|
boolean |
hasRemoteServerLauncherProperties()
|
boolean |
inheritsCredentials()
Returns true if this system can inherit the credentials of from the other connector services in this host. |
boolean |
isConnected()
|
boolean |
isDirty()
An object is dirty if a change has been made to it that requires it to be persisted. |
boolean |
isServerLaunchTypeEnabled(ISubSystem subsystem,
ServerLaunchType serverLaunchType)
This methods returns the enablement state of a server launch type. |
boolean |
isSuppressed()
|
boolean |
isTainted()
An object is tainted if it contains an object that is dirty somewhere in its containment hierarchy. |
boolean |
isUsingSSL()
|
void |
registerSubSystem(ISubSystem ss)
Adds a subsystem to this connector service. |
void |
removeCommunicationsListener(ICommunicationsListener listener)
Remove a communications listener. |
void |
removePassword()
Causes the persisted password known to this connector service, if any, to be forgotten. |
boolean |
removePropertySet(String name)
Removes a particular property set from this container. |
void |
removeUserId()
Causes the persisted (default) user id known to this connector service, if any, to be forgotten. |
boolean |
requiresPassword()
Test if this connector service requires a password. |
boolean |
requiresUserId()
Test if this connector service requires a user id. |
void |
reset()
Reset after some fundamental change, such as a hostname change. |
void |
savePassword()
Causes the password known to this connector service, if any, to be persisted. |
void |
saveUserId()
Causes the user id known to the connector service, if any, to be persisted. |
int |
setDenyPasswordSave(boolean deny)
Sets the attribute for this connector service instance that denies a password to be saved. |
void |
setDirty(boolean flag)
An object is dirty if a change has been made to it that requires it to be persisted. |
void |
setHost(IHost host)
Sets the host used by this connector service. |
void |
setIsUsingSSL(boolean flag)
|
void |
setPassword(String matchingUserId,
String password,
boolean persist,
boolean propagate)
Sets the password used by this connector service. |
void |
setPort(int port)
Set the port for this connector. |
void |
setRemoteServerLauncherProperties(IServerLauncherProperties value)
Set the properties for the remote server launcher This is an object containing properties used to launch a remote server that communicates with this client. |
void |
setSuppressed(boolean suppressSignonPrompt)
Suppresses the acquisition of a credentials by the connector service. |
void |
setTainted(boolean flag)
Sets the tainted attribute for this object. |
void |
setUserId(String userId)
Set the user id this connector service will use when establishing its connection. |
void |
setWasRestored(boolean flag)
Sets the restored state of the object. |
boolean |
sharesCredentials()
Return true if this system can share it's credentials with other connector services in this host. |
boolean |
supportsPassword()
Determines if this connector service understand the concept of a password. |
boolean |
supportsRemoteServerLaunching()
|
boolean |
supportsServerLaunchProperties()
|
boolean |
supportsUserId()
Reports if this connector service can use a user identifier. |
boolean |
wasRestored()
An object was restored if it originated from a persistent form. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected IHost _host
| Constructor Detail |
|---|
public AbstractDelegatingConnectorService(IHost host)
host - The host associated with this connector service.| Method Detail |
|---|
public abstract IConnectorService getRealConnectorService()
getRealConnectorService in interface IDelegatingConnectorServicepublic void addCommunicationsListener(ICommunicationsListener listener)
IConnectorService
addCommunicationsListener in interface IConnectorServicelistener - a listener for the communications event.public boolean addPropertySet(IPropertySet set)
IPropertySetContainer
addPropertySet in interface IPropertySetContainerset - the property set to be added.
public boolean addPropertySets(IPropertySet[] sets)
IPropertySetContainer
addPropertySets in interface IPropertySetContainersets - the sets to be added
IPropertySetContainer.addPropertySet(IPropertySet)
public void clearPassword(boolean clearDiskCache,
boolean propagate)
IConnectorService
clearPassword in interface IConnectorServiceclearDiskCache - if true, clears the persistent form of the passwordpropagate - true if this password should be cleared in related connector services.public void clearCredentials()
IConnectorService
clearCredentials in interface IConnectorServicepublic boolean commit()
IRSEPersistableContainer
commit in interface IRSEPersistableContainer
public void connect(IProgressMonitor monitor)
throws Exception
IConnectorService
connect in interface IConnectorServicemonitor - a monitor for tracking the progress and canceling a
connect operation.
OperationCanceledException - if the connect was cancelled by the
user
Exception - if there is a failure connecting. Typically, this will
be a SystemMessageException.public IPropertySet createPropertySet(String name)
IPropertySetContainerIRSEPersistableContainer. The
IRSEPersistableContainer.commit() method must then be used to
commit any changes into persistent storage.
createPropertySet in interface IPropertySetContainername - the name of the property set.
public IPropertySet createPropertySet(String name,
String description)
IPropertySetContainerIRSEPersistableContainer. The
IRSEPersistableContainer.commit() method must then be used to
commit any changes into persistent storage.
createPropertySet in interface IPropertySetContainername - the name of the property set.description - the description (usually already localized) for this
property set.
public void deregisterSubSystem(ISubSystem ss)
IConnectorService
deregisterSubSystem in interface IConnectorServicess - the subsystem to remove from this connector service.
public void disconnect(IProgressMonitor monitor)
throws Exception
IConnectorService
disconnect in interface IConnectorServicemonitor - a monitor for tracking the progress and canceling a
disconnect operation.
Exception - an exception of the disconnect fails. Typically, this
will be a SystemMessageException.public String getDescription()
getDescription in interface IRSEModelObjectpublic String getHomeDirectory()
getHomeDirectory in interface IConnectorServicepublic IHost getHost()
getHost in interface IConnectorServicepublic String getHostName()
getHostName in interface IConnectorServicepublic String getName()
getName in interface IRSEModelObjectpublic int getPort()
getPort in interface IConnectorServicepublic ISubSystem getPrimarySubSystem()
getPrimarySubSystem in interface IConnectorServicepublic IPropertySet getPropertySet(String name)
IPropertySetContainer
getPropertySet in interface IPropertySetContainername - the name of the property set.
public IPropertySet[] getPropertySets()
IPropertySetContainer
getPropertySets in interface IPropertySetContainerpublic IServerLauncher getRemoteServerLauncher()
getRemoteServerLauncher in interface IConnectorServiceIConnectorService.supportsRemoteServerLaunching() is true.public IServerLauncherProperties getRemoteServerLauncherProperties()
IConnectorService
getRemoteServerLauncherProperties in interface IConnectorServicepublic ISubSystem[] getSubSystems()
IConnectorService
getSubSystems in interface IConnectorServicepublic String getTempDirectory()
getTempDirectory in interface IConnectorServicepublic String getUserId()
getUserId in interface IConnectorServicepublic String getVersionReleaseModification()
getVersionReleaseModification in interface IConnectorServicepublic boolean hasPassword(boolean onDisk)
hasPassword in interface IConnectorServiceonDisk - also check for the persistent form of the password.
public boolean hasRemoteServerLauncherProperties()
hasRemoteServerLauncherProperties in interface IConnectorServicepublic boolean inheritsCredentials()
IConnectorService
inheritsCredentials in interface IConnectorServicepublic boolean isConnected()
isConnected in interface IConnectorServicepublic boolean isDirty()
IRSEPersistableContainer
isDirty in interface IRSEPersistableContainer
public boolean isServerLaunchTypeEnabled(ISubSystem subsystem,
ServerLaunchType serverLaunchType)
IConnectorServiceRemoteServerLauncher.enableServerLaunchType(ServerLaunchType, boolean) has not been
called for this server launch type, then it is enabled by default.
isServerLaunchTypeEnabled in interface IConnectorServicesubsystem - the subystem for which this may be enabled.serverLaunchType - the type to check for enabledment.
ServerLaunchTypepublic boolean isSuppressed()
isSuppressed in interface IConnectorServicepublic boolean isUsingSSL()
isUsingSSL in interface IConnectorService
public void acquireCredentials(boolean forcePrompt)
throws OperationCanceledException
IConnectorServiceIConnectorService.setSuppressed(boolean).
Implementations may retain a remembered credentials or use this to acquire the credentials using some implementation defined means.
acquireCredentials in interface IConnectorServiceforcePrompt - if true will force the connector service to discard any
remembered value and reacquire the credentials.
OperationCanceledException - if acquisition of the credentials is
cancelled or is being suppressed.public void registerSubSystem(ISubSystem ss)
IConnectorService
registerSubSystem in interface IConnectorServicess - a subsystem that is using this connector service.public void removeCommunicationsListener(ICommunicationsListener listener)
IConnectorService
removeCommunicationsListener in interface IConnectorServicelistener - a listener for the communications event.public boolean removePropertySet(String name)
IPropertySetContainer
removePropertySet in interface IPropertySetContainername - the name of the property set to be removed
public void reset()
IConnectorService
reset in interface IConnectorServicepublic void setDirty(boolean flag)
IRSEPersistableContainerAn object is dirty if a change has been made to it that requires it to be persisted. Objects should usually mark themselves dirty when a persistable change is made. However, there may be a need to mark related objects dirty as well.
Persistable changes are:
A rename may also cause a parent to be marked dirty if the parent refers to the child by name.
Setting this value to false should be done only in the persistence manager after the object has been written to the DOM.
Marking an object as dirty must cause it and all of its ancestors in the persistence hierarchy to be marked as tainted.
setDirty in interface IRSEPersistableContainerflag - true if the object must be persisted.public void setHost(IHost host)
IConnectorService
setHost in interface IConnectorServicehost - the host to be used for this connector servicepublic void setIsUsingSSL(boolean flag)
setIsUsingSSL in interface IConnectorServiceflag - true if the connector service should attempt to use SSL when
establishing the connection.
public void setPassword(String matchingUserId,
String password,
boolean persist,
boolean propagate)
IConnectorService
setPassword in interface IConnectorServicematchingUserId - The user id to be associated with this password.password - the passwordpersist - true if the password is to be persisted for later use.propagate - true if this password should be propagated to related connector services.public void setPort(int port)
IConnectorService
setPort in interface IConnectorServiceport - the IP port used by this connector service.public void setRemoteServerLauncherProperties(IServerLauncherProperties value)
IConnectorService
setRemoteServerLauncherProperties in interface IConnectorServicevalue - the new value of the 'Remote Server Launcher' containment reference.public void setSuppressed(boolean suppressSignonPrompt)
IConnectorServiceIConnectorService.acquireCredentials(boolean) to immediately
throw an InterruptedException.
The intent is to allow tool writers to prevent multiple attempts to acquire credentials during a set period of time. It is the responsibility of the caller to set this value back to false when the tool no longer needs to suppress acquisition credentials.
setSuppressed in interface IConnectorServicesuppressSignonPrompt - true if acquisition is to be suppressed.
false if acquisition is to be allowed.public void setUserId(String userId)
IConnectorService
setUserId in interface IConnectorServiceuserId - the user id string for this connector service.public void setWasRestored(boolean flag)
IRSEPersistableContainer
setWasRestored in interface IRSEPersistableContainerflag - true if the object was restored.public boolean sharesCredentials()
IConnectorService
sharesCredentials in interface IConnectorServicepublic boolean supportsPassword()
IConnectorService
supportsPassword in interface IConnectorServicepublic boolean supportsRemoteServerLaunching()
supportsRemoteServerLaunching in interface IConnectorServicepublic boolean supportsServerLaunchProperties()
supportsServerLaunchProperties in interface IConnectorServiceIConnectorService.supportsRemoteServerLaunching()
is false.public boolean supportsUserId()
IConnectorService
supportsUserId in interface IConnectorServicepublic void saveUserId()
IConnectorService
saveUserId in interface IConnectorServicepublic void removeUserId()
IConnectorService
removeUserId in interface IConnectorServicepublic void savePassword()
IConnectorService
savePassword in interface IConnectorServicepublic void removePassword()
IConnectorService
removePassword in interface IConnectorServicepublic boolean wasRestored()
IRSEPersistableContainer
wasRestored in interface IRSEPersistableContainerpublic boolean requiresPassword()
IConnectorService
requiresPassword in interface IConnectorServicepublic boolean requiresUserId()
IConnectorService
requiresUserId in interface IConnectorServicepublic boolean isTainted()
IRSEPersistableContainer
isTainted in interface IRSEPersistableContainerpublic void setTainted(boolean flag)
IRSEPersistableContainer
setTainted in interface IRSEPersistableContainerflag - the tainted state of the object.public IRSEPersistableContainer getPersistableParent()
IRSEPersistableContainer
getPersistableParent in interface IRSEPersistableContainerpublic IRSEPersistableContainer[] getPersistableChildren()
IRSEPersistableContainer
getPersistableChildren in interface IRSEPersistableContainerIRSEPersistableContainer.NO_CHILDREN.public int setDenyPasswordSave(boolean deny)
setDenyPasswordSave in interface IConnectorServicedeny - If true, forget any saved passwords and do not allow any
others to be saved. If false, allow passwords to be saved in
the keyring.
public boolean getDenyPasswordSave()
getDenyPasswordSave in interface IConnectorServicepublic void clonePropertySets(IPropertySetContainer targetContainer)
IPropertySetContainer
clonePropertySets in interface IPropertySetContainertargetContainer - new container to copy property sets into
|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||