RSE
Release 3.3

org.eclipse.rse.subsystems.terminals.ssh
Class SshTerminalSubSystemConfiguration

java.lang.Object
  extended by org.eclipse.rse.core.subsystems.SubSystemConfiguration
      extended by org.eclipse.rse.subsystems.terminals.core.TerminalServiceSubSystemConfiguration
          extended by org.eclipse.rse.subsystems.terminals.ssh.SshTerminalSubSystemConfiguration
All Implemented Interfaces:
IAdaptable, ISystemFilterPoolManagerProvider, IRSEPersistableContainer, ISubSystemConfiguration, ITerminalServiceSubSystemConfiguration

public class SshTerminalSubSystemConfiguration
extends TerminalServiceSubSystemConfiguration

An SSH Terminal Subsystem Factory.


Field Summary
 
Fields inherited from class org.eclipse.rse.core.subsystems.SubSystemConfiguration
currentlyProcessingConnection, currentlyProcessingSubSystemConfiguration, currentlySelected, currentlySelectedConnection, filterPoolManagerList, filterPoolManagers, filterPoolManagersPerProfile, subSystemList
 
Fields inherited from interface org.eclipse.rse.core.subsystems.ISubSystemConfiguration
FORCE_INTO_MEMORY, LAZILY
 
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer
NO_CHILDREN
 
Constructor Summary
SshTerminalSubSystemConfiguration()
           
 
Method Summary
 ISubSystem createSubSystemInternal(IHost host)
          Instantiate and return an instance of OUR subsystem.
 ITerminalService createTerminalService(IHost host)
          Create the terminal service.
 IConnectorService getConnectorService(IHost host)
          Get the connector service for a particular host. This default implementation returns null.
 Class getServiceImplType()
          Get the implementation type of the service associated with this subsystem configuration. This default implementation returns null.
 boolean isFactoryFor(Class subSystemType)
          Determines whether this subsystem configuration is responsible for the creation of subsystems of the specified type Subsystem factories should override this to indicate which subsystems they support.
 void setConnectorService(IHost host, IConnectorService connectorService)
          Set the connector service for a particular host. This default implementation does nothing.
 
Methods inherited from class org.eclipse.rse.subsystems.terminals.core.TerminalServiceSubSystemConfiguration
getService, getServiceType, getTerminalService, supportsFilters
 
Methods inherited from class org.eclipse.rse.core.subsystems.SubSystemConfiguration
addFilterPoolManager, addSubSystem, beginRestore, changingSystemProfileActiveStatus, cloneEvent, cloneSubSystem, commit, copyFilterPoolManager, copySubSystemData, createDefaultFilterPool, createEvent, createEvent, createEvent, createServerLauncher, createSubSystem, createSubSystemAfterTheFact, deleteFilterPoolManager, deleteSubSystem, deleteSubSystemsByConnection, deletingSystemProfile, disconnectAllSubSystems, doPostRestoreProcessing, endRestore, filterEventFilterCreated, filterEventFilterDeleted, filterEventFilterPoolCreated, filterEventFilterPoolDeleted, filterEventFilterPoolRenamed, filterEventFilterPoolsRePositioned, filterEventFilterRenamed, filterEventFiltersRePositioned, filterEventFilterStringCreated, filterEventFilterStringDeleted, filterEventFilterStringsRePositioned, filterEventFilterStringUpdated, filterEventFilterUpdated, fireEvent, fireEvent, fireEvent, fireSubSystemEvent, fireSubSystemEvent, fireSubSystemEvent, fireSubSystemFilterEvent, fireSubSystemFilterEvent, fireSubSystemFilterEvent, fireSubSystemFilterEvent, fireSubSystemFilterEvent, fireSubSystemFilterEvent, getActiveFilterPoolManagers, getAdapter, getAllSystemFilterPoolManagers, getCategory, getConnectingMessage, getDefaultFilterPool, getDefaultFilterPoolName, getDefaultSystemFilterPool, getDefaultSystemFilterPool, getDescription, getDisconnectingMessage, getFilterPool, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManagerList, getFilterPoolManagerName, getFilterPoolManagers, getFilterPools, getId, getName, getNewFilterWizardPoolWrapperInformation, getPersistableChildren, getPersistableParent, getReferencableSystemFilterPoolManagers, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSubSystems, getSubSystems, getSystemFilterPoolForBrokenReference, getSystemFilterPoolManager, getSystemFilterPoolManagers, getSystemProfile, getSystemProfile, getSystemProfile, getSystemProfile, getSystemProfileName, getSystemTypes, getTranslatedFilterTypeProperty, getVendor, handleException, initializeSubSystem, internalGetSubSystemName, internalGetSubSystems, invalidateFilterCache, invalidateSubSystemCache, isCaseSensitive, isDirty, isPortEditable, isSubSystemsDeletable, isTainted, isUserPrivateProfile, needsUpdate, preTestRenameSubSystemProfile, providesCustomDropInFilters, removeSubSystem, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveFilterPools, saveFilterPools, saveSubSystem, saveSubSystems, saveSubSystems, setConnection, setCurrentSelection, setDirty, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, setTainted, setWasRestored, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, subSystemsHaveBeenRestored, supportsCommands, supportsDeferredQueries, supportsDropInFilters, supportsDuplicateFilterStrings, supportsEncoding, supportsFileTypes, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchProperties, supportsServerLaunchType, supportsSubSystemConnect, supportsTargets, testForActiveReferences, toString, updateSubSystem, wasRestored
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.rse.core.subsystems.ISubSystemConfiguration
changingSystemProfileActiveStatus, cloneSubSystem, commit, copyFilterPoolManager, createServerLauncher, createSubSystem, createSubSystemAfterTheFact, deleteSubSystem, deleteSubSystemsByConnection, deletingSystemProfile, disconnectAllSubSystems, getAllSystemFilterPoolManagers, getCategory, getDefaultFilterPool, getDefaultSystemFilterPool, getDescription, getFilterPoolManager, getFilterPoolManager, getFilterPoolManagerList, getId, getName, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSystemProfile, getSystemProfile, getSystemTypes, getTranslatedFilterTypeProperty, getVendor, isCaseSensitive, isPortEditable, isSubSystemsDeletable, preTestRenameSubSystemProfile, providesCustomDropInFilters, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveSubSystem, setConnection, setCurrentSelection, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, supportsCommands, supportsDeferredQueries, supportsDropInFilters, supportsEncoding, supportsFileTypes, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchProperties, supportsServerLaunchType, supportsSubSystemConnect, supportsTargets, testForActiveReferences, updateSubSystem
 
Methods inherited from interface org.eclipse.rse.core.filters.ISystemFilterPoolManagerProvider
filterEventFilterCreated, filterEventFilterDeleted, filterEventFilterPoolCreated, filterEventFilterPoolDeleted, filterEventFilterPoolRenamed, filterEventFilterPoolsRePositioned, filterEventFilterRenamed, filterEventFiltersRePositioned, filterEventFilterStringCreated, filterEventFilterStringDeleted, filterEventFilterStringsRePositioned, filterEventFilterStringUpdated, filterEventFilterUpdated, getReferencableSystemFilterPoolManagers, getSystemFilterPoolForBrokenReference, getSystemFilterPoolManager, getSystemFilterPoolManagers
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer
getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored
 

Constructor Detail

SshTerminalSubSystemConfiguration

public SshTerminalSubSystemConfiguration()
Method Detail

isFactoryFor

public boolean isFactoryFor(Class subSystemType)
Description copied from class: SubSystemConfiguration
Determines whether this subsystem configuration is responsible for the creation of subsystems of the specified type Subsystem factories should override this to indicate which subsystems they support.

Specified by:
isFactoryFor in interface ISubSystemConfiguration
Overrides:
isFactoryFor in class TerminalServiceSubSystemConfiguration
Parameters:
subSystemType - type of subsystem
Returns:
whether this subsystem configuration is for the specified subsystem type

createSubSystemInternal

public ISubSystem createSubSystemInternal(IHost host)
Instantiate and return an instance of OUR subsystem. Do not populate it yet though!

Specified by:
createSubSystemInternal in interface ISubSystemConfiguration
Specified by:
createSubSystemInternal in class SubSystemConfiguration
See Also:
SubSystemConfiguration.createSubSystemInternal(IHost)

createTerminalService

public ITerminalService createTerminalService(IHost host)
Description copied from interface: ITerminalServiceSubSystemConfiguration
Create the terminal service.

Parameters:
host - connection
Returns:
the new terminal service interface.
Since:
1.0

getConnectorService

public IConnectorService getConnectorService(IHost host)
Description copied from class: SubSystemConfiguration
Get the connector service for a particular host. This may create the connector service if necessary. If the configuration is a service subsystem configuration, this should return the connector service specified in ISubSystemConfiguration.setConnectorService(IHost, IConnectorService).

This default implementation returns null. Service subsystem configurations must override as defined in the interface.

Specified by:
getConnectorService in interface ISubSystemConfiguration
Overrides:
getConnectorService in class SubSystemConfiguration
Parameters:
host - the host for which to create or retrieve the connector service
Returns:
the connector service associated with this host. This can return null if there is no connector service associated with this configuration. It is recommended that there be a connector service if ISubSystemConfiguration.supportsSubSystemConnect() is true.
See Also:
ISubSystemConfiguration.getConnectorService(IHost)

setConnectorService

public void setConnectorService(IHost host,
                                IConnectorService connectorService)
Description copied from class: SubSystemConfiguration
Set the connector service for a particular host. This is usually managed by a connector service manager known to this configuration. This must be implemented by service subsystem configurations. Service subsystems allow a connector service to be changed.

This default implementation does nothing. Service subsystems must override as defined in the interface.

Specified by:
setConnectorService in interface ISubSystemConfiguration
Overrides:
setConnectorService in class SubSystemConfiguration
Parameters:
host - the host for which to set this connector service.
connectorService - the connector service associated with this host.
See Also:
ISubSystemConfiguration.setConnectorService(IHost, IConnectorService)

getServiceImplType

public Class getServiceImplType()
Description copied from class: SubSystemConfiguration
Get the implementation type of the service associated with this subsystem configuration. If the configuration is not a service subsystem configuration then this must return null, otherwise it must return the class that implements the interface specified in ISubSystemConfiguration.getServiceType().

This default implementation returns null. Service subsystem configurations must override as defined in the interface.

Specified by:
getServiceImplType in interface ISubSystemConfiguration
Overrides:
getServiceImplType in class SubSystemConfiguration
Returns:
an implementation class that implements the interface specified in ISubSystemConfiguration.getServiceType(), or null if this is not a service subsystem configuration.
See Also:
ISubSystemConfiguration.getServiceImplType()

RSE
Release 3.3

Copyright (c) IBM Corporation and others 2000, 2011. All Rights Reserved.