org.eclipse.rse.subsystems.files.local
Class LocalFileSubSystemConfiguration

java.lang.Object
  org.eclipse.rse.core.subsystems.SubSystemConfiguration
      org.eclipse.rse.subsystems.files.core.subsystems.RemoteFileSubSystemConfiguration
          org.eclipse.rse.subsystems.files.core.servicesubsystem.FileServiceSubSystemConfiguration
              org.eclipse.rse.subsystems.files.local.LocalFileSubSystemConfiguration

All Implemented Interfaces:

IAdaptable, IFileServiceSubSystemConfiguration, IRemoteFileSubSystemConfiguration, IRSEPersistableContainer, ISubSystemConfiguration, ISystemFilterPoolManagerProvider

public class LocalFileSubSystemConfiguration

extends FileServiceSubSystemConfiguration

Provides a factory for generating instances of the class SampleFileSubSystem.

Field Summary

protected IHostFileToRemoteFileAdapter	_hostFileAdapter
protected boolean	_isWindows

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, 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

LocalFileSubSystemConfiguration()

Method Summary

protected ISystemFilterPool	createDefaultFilterPool(ISystemFilterPoolManager mgr) Override from parent.
IFileService	createFileService(IHost host)
IHostSearchResultConfiguration	createSearchConfiguration(IHost host, IHostSearchResultSet resultSet, Object searchTarget, SystemSearchString searchString) Creates a config and adds it to the result set.
ISearchService	createSearchService(IHost host)
ISubSystem	createSubSystemInternal(IHost host) Instantiate and return an instance of OUR subystem.
IConnectorService	getConnectorService(IHost host) Get the connector service for a particular host.
String	getEditorProfileID() Return the default remote systems editor profile ID for files on this subsystem
IHostFileToRemoteFileAdapter	getHostFileAdapter()
ILanguageUtilityFactory	getLanguageUtilityFactory(IRemoteFileSubSystem ss)
Class	getServiceImplType() Get the implementation type of the service associated with this subsystem configuration.
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) Set the connector service for a particular host.
boolean	supportsArchiveManagement() Return true if subsystems for this configuration support archive management.
boolean	supportsDeferredQueries() Return true if deferred queries are supported.
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 Returns false in default implementation.
boolean	supportsFilters() Required method for subsystem factory child classes.
boolean	supportsSearch() Return true if subsystems for this configuration support search functionality.
boolean	supportsSubSystemConnect() Returns false.

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

getFileFilterStringValidator, getFileNameValidator, getFolderNameValidator, getLineSeparator, getPathSeparator, getPathSeparatorChar, getPathValidator, getSeparator, getSeparatorChar, getTranslatedFilterTypeProperty, initializeSubSystem, isCaseSensitive, isUnixStyle, providesCustomDropInFilters, recursivelyUpdateIFileProperties, renameSubSystemProfile, setIsUnixStyle, supportsDropInFilters, supportsTargets

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, 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, supportsDuplicateFilterStrings, supportsEncoding, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchType, 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

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, 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, supportsDropInFilters, supportsEncoding, supportsFilterCaching, supportsFilterChildren, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, supportsServerLaunchType, 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

Field Detail

_isWindows

protected boolean _isWindows

_hostFileAdapter

protected IHostFileToRemoteFileAdapter _hostFileAdapter

Constructor Detail

LocalFileSubSystemConfiguration

public LocalFileSubSystemConfiguration()

Method Detail

isFactoryFor

public boolean isFactoryFor(Class subSystemType)

Description copied from interface: ISubSystemConfiguration

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

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

createDefaultFilterPool

protected ISystemFilterPool createDefaultFilterPool(ISystemFilterPoolManager mgr)

Override from parent. Create the default filter pool when this factory is first created, and populate it with default filters.

For local, what default filters we create we depends on the local operating system:

• _isWindows: "Drives" listing all the local drives
• Others: "Root files" listing all the contents of the root drive

Overrides:

createDefaultFilterPool in class RemoteFileSubSystemConfiguration

createSubSystemInternal

public ISubSystem createSubSystemInternal(IHost host)

Instantiate and return an instance of OUR subystem. Do not populate it yet though!

Specified by:

createSubSystemInternal in interface ISubSystemConfiguration

Overrides:

createSubSystemInternal in class RemoteFileSubSystemConfiguration

See Also:

SubSystemConfiguration.createSubSystemInternal(IHost)

supportsFileTypes

public boolean supportsFileTypes()

Description copied from interface: ISubSystemConfiguration

Return true if you support user-defined/managed named file types

Returns false in default implementation.

Specified by:

supportsFileTypes in interface ISubSystemConfiguration

Overrides:

supportsFileTypes in class RemoteFileSubSystemConfiguration

supportsSearch

public boolean supportsSearch()

Description copied from interface: IRemoteFileSubSystemConfiguration

Return true if subsystems for this configuration support search functionality.

Specified by:

supportsSearch in interface IRemoteFileSubSystemConfiguration

Overrides:

supportsSearch in class RemoteFileSubSystemConfiguration

supportsEnvironmentVariablesPropertyPage

public boolean supportsEnvironmentVariablesPropertyPage()

Description copied from interface: IRemoteFileSubSystemConfiguration

Return true if subsystems of this factory support the environment variables property. Return true to show it, return false to hide it.

Specified by:

supportsEnvironmentVariablesPropertyPage in interface IRemoteFileSubSystemConfiguration

Overrides:

supportsEnvironmentVariablesPropertyPage in class RemoteFileSubSystemConfiguration

supportsFilters

public boolean supportsFilters()

Description copied from interface: ISubSystemConfiguration

Required method for subsystem factory child classes. 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.

Returns true in default implementation.

Specified by:

supportsFilters in interface ISubSystemConfiguration

Overrides:

supportsFilters in class SubSystemConfiguration

Returns:

true to indicate that Filters are supported by default.

supportsSubSystemConnect

public boolean supportsSubSystemConnect()

Returns false.

Specified by:

supportsSubSystemConnect in interface ISubSystemConfiguration

Overrides:

supportsSubSystemConnect in class SubSystemConfiguration

See Also:

SubSystemConfiguration.supportsSubSystemConnect()

supportsDeferredQueries

public boolean supportsDeferredQueries()

Description copied from interface: ISubSystemConfiguration

Return true if deferred queries are supported. Deferred queries work such that when a filter or element children query is made, a WorkbenchJob is started to perform the query in a background thread. The query can take time to complete, but a negative side-effect of this is that it will always take time to complete. Alternative models can use asynchronous calls to populate their model with data from the remote side, and refresh the views when new data is in the model. Such subsystem configurations should return false here. The default implementation returns true, indicating that deferred queries are supported for filters, and delegates the check for model elements to the ISystemViewElementAdapter.

Specified by:

supportsDeferredQueries in interface ISubSystemConfiguration

Overrides:

supportsDeferredQueries in class SubSystemConfiguration

Returns:

true if deferred queries are supported.

See Also:

ISubSystemConfiguration.supportsDeferredQueries()

getConnectorService

public IConnectorService getConnectorService(IHost host)

Description copied from interface: ISubSystemConfiguration

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).

Specified by:

getConnectorService in interface ISubSystemConfiguration

Overrides:

getConnectorService in class SubSystemConfiguration

See Also:

ISubSystemConfiguration.getConnectorService(IHost)

setConnectorService

public void setConnectorService(IHost host,
                                IConnectorService connectorService)

Description copied from interface: ISubSystemConfiguration

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.

Specified by:

setConnectorService in interface ISubSystemConfiguration

Overrides:

setConnectorService in class SubSystemConfiguration

See Also:

ISubSystemConfiguration.setConnectorService(IHost, IConnectorService)

createFileService

public IFileService createFileService(IHost host)

createSearchService

public ISearchService createSearchService(IHost host)

createSearchConfiguration

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

Creates a config and adds it to the result set.

See Also:

IHostSearchResultConfigurationFactory.createSearchConfiguration(org.eclipse.rse.services.search.IHostSearchResultSet, java.lang.Object, org.eclipse.rse.services.clientserver.SystemSearchString)

getHostFileAdapter

public IHostFileToRemoteFileAdapter getHostFileAdapter()

getLanguageUtilityFactory

public ILanguageUtilityFactory getLanguageUtilityFactory(IRemoteFileSubSystem ss)

getServiceImplType

public Class getServiceImplType()

Description copied from interface: ISubSystemConfiguration

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().

Specified by:

getServiceImplType in interface ISubSystemConfiguration

Overrides:

getServiceImplType in class SubSystemConfiguration

See Also:

ISubSystemConfiguration.getServiceImplType()

getEditorProfileID

public String getEditorProfileID()

Description copied from interface: IRemoteFileSubSystemConfiguration

Return the default remote systems editor profile ID for files on this subsystem

Specified by:

getEditorProfileID in interface IRemoteFileSubSystemConfiguration

Overrides:

getEditorProfileID in class RemoteFileSubSystemConfiguration