RSE
Release 2.0

org.eclipse.rse.subsystems.files.ssh
Class SftpFileSubSystemConfiguration

java.lang.Object
  extended by org.eclipse.rse.core.subsystems.SubSystemConfiguration
      extended by org.eclipse.rse.subsystems.files.core.subsystems.RemoteFileSubSystemConfiguration
          extended by org.eclipse.rse.subsystems.files.core.servicesubsystem.FileServiceSubSystemConfiguration
              extended by org.eclipse.rse.subsystems.files.ssh.SftpFileSubSystemConfiguration
All Implemented Interfaces:
IAdaptable, ISystemFilterPoolManagerProvider, IRSEPersistableContainer, IServiceSubSystemConfiguration, ISubSystemConfiguration, IFileServiceSubSystemConfiguration, IRemoteFileSubSystemConfiguration

public class SftpFileSubSystemConfiguration
extends FileServiceSubSystemConfiguration


Field Summary
protected  IHostFileToRemoteFileAdapter _hostFileAdapter
           
 
Fields inherited from class org.eclipse.rse.subsystems.files.core.subsystems.RemoteFileSubSystemConfiguration
translatedType, unixStyle
 
Fields inherited from class org.eclipse.rse.core.subsystems.SubSystemConfiguration
currentlyProcessingConnection, currentlyProcessingSubSystemConfiguration, currentlySelected, currentlySelectedConnection, filterNamingPolicy, 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
 
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
SftpFileSubSystemConfiguration()
           
 
Method Summary
 IFileService createFileService(IHost host)
           
 IHostSearchResultConfiguration createSearchConfiguration(IHost host, IHostSearchResultSet resultSet, Object searchTarget, SystemSearchString searchString)
           
 ISearchService createSearchService(IHost host)
           
 ISubSystem createSubSystemInternal(IHost host)
          Instantiate and return an instance of OUR subystem.
 IConnectorService getConnectorService(IHost host)
          Find or create a connector service for this host
 IHostFileToRemoteFileAdapter getHostFileAdapter()
           
 ILanguageUtilityFactory getLanguageUtilityFactory(IRemoteFileSubSystem ss)
           
 Class getServiceImplType()
           
 boolean isFactoryFor(Class subSystemType)
          Determines whether this factory is responsible for the creation of subsytems of the specified type Subsystem factories should override this to indicate which subsystems they support.
 void setConnectorService(IHost host, IConnectorService connectorService)
           
 boolean supportsArchiveManagement()
          Return true if subsystems for this configuration support archive management.
 boolean supportsEnvironmentVariablesPropertyPage()
          Return true if subsystems of this factory support the environment variables property.
 boolean supportsFileTypes()
          Return true if you support user-defined/managed named file types We return true
 boolean supportsFilters()
          Return true if you support filters, false otherwise.
 boolean supportsSearch()
          By default this returns true.
 
Methods inherited from class org.eclipse.rse.subsystems.files.core.servicesubsystem.FileServiceSubSystemConfiguration
getFileService, getSearchService, getService, getServiceType, supportsServerLaunchProperties
 
Methods inherited from class org.eclipse.rse.subsystems.files.core.subsystems.RemoteFileSubSystemConfiguration
createDefaultFilterPool, getEditorProfileID, getFileFilterStringValidator, getFileNameValidator, getFolderNameValidator, getLineSeparator, getPathSeparator, getPathSeparatorChar, getPathValidator, getSeparator, getSeparatorChar, getTranslatedFilterTypeProperty, initializeSubSystem, isCaseSensitive, isUnixStyle, providesCustomDropInFilters, recursivelyUpdateIFileProperties, renameSubSystemProfile, setIsUnixStyle, supportsCompileActions, supportsDropInFilters, supportsTargets, supportsUserDefinedActions
 
Methods inherited from class org.eclipse.rse.core.subsystems.SubSystemConfiguration
addFilterPoolManager, addSubSystem, beginRestore, changingSystemProfileActiveStatus, cloneEvent, cloneSubSystem, commit, copyFilterPoolManager, copySubSystemData, 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, 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, getVendor, handleException, internalGetSubSystemName, internalGetSubSystems, invalidateFilterCache, invalidateSubSystemCache, isDirty, isPortEditable, isSubSystemsDeletable, isTainted, isUserPrivateProfile, needsUpdate, preTestRenameSubSystemProfile, removeSubSystem, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveFilterPools, saveFilterPools, saveSubSystem, saveSubSystems, saveSubSystems, setConnection, setCurrentSelection, setDirty, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, setTainted, setWasRestored, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, subSystemsHaveBeenRestored, supportsCommands, supportsDeferredQueries, supportsDuplicateFilterStrings, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchType, supportsSubSystemConnect, 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.subsystems.files.core.subsystems.IRemoteFileSubSystemConfiguration
getEditorProfileID, getFileFilterStringValidator, getFileNameValidator, getFolderNameValidator, getLineSeparator, getPathSeparator, getPathSeparatorChar, getPathValidator, getSeparator, getSeparatorChar, isCaseSensitive, isUnixStyle
 
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, getFilterPoolManagerList, getId, getName, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSystemProfile, getSystemProfile, getSystemTypes, getTranslatedFilterTypeProperty, getVendor, isPortEditable, isSubSystemsDeletable, preTestRenameSubSystemProfile, providesCustomDropInFilters, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveSubSystem, setConnection, setCurrentSelection, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, supportsCommands, supportsCompileActions, supportsDeferredQueries, supportsDropInFilters, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchType, supportsSubSystemConnect, supportsTargets, supportsUserDefinedActions, 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
 
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, getFilterPoolManagerList, getId, getName, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSystemProfile, getSystemProfile, getSystemTypes, getTranslatedFilterTypeProperty, getVendor, isPortEditable, isSubSystemsDeletable, preTestRenameSubSystemProfile, providesCustomDropInFilters, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveSubSystem, setConnection, setCurrentSelection, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, supportsCommands, supportsCompileActions, supportsDeferredQueries, supportsDropInFilters, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchType, supportsSubSystemConnect, supportsTargets, supportsUserDefinedActions, 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
 

Field Detail

_hostFileAdapter

protected IHostFileToRemoteFileAdapter _hostFileAdapter
Constructor Detail

SftpFileSubSystemConfiguration

public SftpFileSubSystemConfiguration()
Method Detail

isFactoryFor

public boolean isFactoryFor(Class subSystemType)
Description copied from class: RemoteFileSubSystemConfiguration
Determines whether this factory is responsible for the creation of subsytems 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 RemoteFileSubSystemConfiguration
Parameters:
subSystemType - type of subsystem
Returns:
whether this factory is for the specified subsystemtype

createSubSystemInternal

public ISubSystem createSubSystemInternal(IHost host)
Description copied from class: RemoteFileSubSystemConfiguration
Instantiate and return an instance of OUR subystem. Do not populate it yet though! Eg:

        SubSystem subsys = ((AcmesubsysFactoryImpl)factory).createAcmeSubSystem();
        return subsys;
 
noteThis method should be abstract but MOF doesn't allow abstract impl classes at this point

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

getConnectorService

public IConnectorService getConnectorService(IHost host)
Description copied from interface: ISubSystemConfiguration
Find or create a connector service for this host


setConnectorService

public void setConnectorService(IHost host,
                                IConnectorService connectorService)

createFileService

public IFileService createFileService(IHost host)

createSearchService

public ISearchService createSearchService(IHost host)

getHostFileAdapter

public IHostFileToRemoteFileAdapter getHostFileAdapter()

getServiceImplType

public Class getServiceImplType()

createSearchConfiguration

public IHostSearchResultConfiguration createSearchConfiguration(IHost host,
                                                                IHostSearchResultSet resultSet,
                                                                Object searchTarget,
                                                                SystemSearchString searchString)

getLanguageUtilityFactory

public ILanguageUtilityFactory getLanguageUtilityFactory(IRemoteFileSubSystem ss)

supportsArchiveManagement

public boolean supportsArchiveManagement()
Description copied from interface: IRemoteFileSubSystemConfiguration
Return true if subsystems for this configuration support archive management.

Returns:
true if archive management is supported

supportsFileTypes

public boolean supportsFileTypes()
Description copied from class: RemoteFileSubSystemConfiguration
Return true if you support user-defined/managed named file types

We return true

Specified by:
supportsFileTypes in interface ISubSystemConfiguration
Overrides:
supportsFileTypes in class RemoteFileSubSystemConfiguration

supportsSearch

public boolean supportsSearch()
Description copied from class: RemoteFileSubSystemConfiguration
By default this returns true. Override if the file subsystem does not support search.

Specified by:
supportsSearch in interface IRemoteFileSubSystemConfiguration
Overrides:
supportsSearch in class RemoteFileSubSystemConfiguration
Returns:
true if search is supported

supportsEnvironmentVariablesPropertyPage

public boolean supportsEnvironmentVariablesPropertyPage()
Description copied from class: RemoteFileSubSystemConfiguration
Return true if subsystems of this factory support the environment variables property. Return true to show it, return false to hide it. We return true.

Specified by:
supportsEnvironmentVariablesPropertyPage in interface IRemoteFileSubSystemConfiguration
Overrides:
supportsEnvironmentVariablesPropertyPage in class RemoteFileSubSystemConfiguration

supportsFilters

public boolean supportsFilters()
Description copied from class: SubSystemConfiguration
Return true if you support filters, false otherwise. If you support filters, then some housekeeping will be done for you automatically. Specifically, they will be saved and restored for you automatically. The default is to support filters.

Specified by:
supportsFilters in interface ISubSystemConfiguration
Overrides:
supportsFilters in class SubSystemConfiguration
Returns:
true to indicate that Filters are supported by default.

RSE
Release 2.0

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