RSE
Release 3.3

org.eclipse.rse.subsystems.shells.core.subsystems
Class RemoteCmdSubSystemConfiguration

java.lang.Object
  extended by org.eclipse.rse.core.subsystems.SubSystemConfiguration
      extended by org.eclipse.rse.subsystems.shells.core.subsystems.RemoteCmdSubSystemConfiguration
All Implemented Interfaces:
IAdaptable, ISystemFilterPoolManagerProvider, IRSEPersistableContainer, ISubSystemConfiguration, IRemoteCmdSubSystemConfiguration
Direct Known Subclasses:
ShellServiceSubSystemConfiguration

public abstract class RemoteCmdSubSystemConfiguration
extends SubSystemConfiguration
implements IRemoteCmdSubSystemConfiguration


Field Summary
protected  String translatedType
           
 
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
RemoteCmdSubSystemConfiguration()
          Default constructor.
 
Method Summary
protected  ISystemFilterPool createDefaultFilterPool(ISystemFilterPoolManager mgr)
          Overridable lifecycle method.
 String getCommandSeparator()
          Return in string format the character used to separate commands.
 String getTranslatedFilterTypeProperty(ISystemFilter selectedFilter)
          Return the translated string to show in the property sheet for the type property.
 boolean isCaseSensitive()
          Tell us if filter strings are case sensitive.
 boolean supportsCommands()
          We return true.
 boolean supportsDuplicateFilterStrings()
          Tell us if duplicate filter strings are supported.
 boolean supportsEnvironmentVariablesPropertyPage()
          Return true if subsystems of this configuration support the environment variables property.
 boolean supportsFilters()
          Test if filters are supported.
 boolean supportsFilterStringExport()
          Return true if the subsystem supports the exporting of filter strings from it's filters
 boolean supportsMultiStringFilters()
          Return true if the subsystem supports more than one filter string
 boolean supportsNestedFilters()
          Test if nested filters are supported.
 
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, createSubSystemInternal, 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, getConnectorService, getDefaultFilterPool, getDefaultFilterPoolName, getDefaultSystemFilterPool, getDefaultSystemFilterPool, getDescription, getDisconnectingMessage, getFilterPool, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManager, getFilterPoolManagerList, getFilterPoolManagerName, getFilterPoolManagers, getFilterPools, getId, getName, getNewFilterWizardPoolWrapperInformation, getPersistableChildren, getPersistableParent, getReferencableSystemFilterPoolManagers, getService, getServiceImplType, getServiceType, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSubSystems, getSubSystems, getSystemFilterPoolForBrokenReference, getSystemFilterPoolManager, getSystemFilterPoolManagers, getSystemProfile, getSystemProfile, getSystemProfile, getSystemProfile, getSystemProfileName, getSystemTypes, getVendor, handleException, initializeSubSystem, internalGetSubSystemName, internalGetSubSystems, invalidateFilterCache, invalidateSubSystemCache, isDirty, isFactoryFor, isPortEditable, isSubSystemsDeletable, isTainted, isUserPrivateProfile, needsUpdate, preTestRenameSubSystemProfile, providesCustomDropInFilters, removeSubSystem, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveFilterPools, saveFilterPools, saveSubSystem, saveSubSystems, saveSubSystems, setConnection, setConnectorService, setCurrentSelection, setDirty, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, setTainted, setWasRestored, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, subSystemsHaveBeenRestored, supportsDeferredQueries, supportsDropInFilters, supportsEncoding, supportsFileTypes, supportsFilterCaching, supportsFilterChildren, supportsMultipleFilterStrings, 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, createSubSystemInternal, deleteSubSystem, deleteSubSystemsByConnection, deletingSystemProfile, disconnectAllSubSystems, getAllSystemFilterPoolManagers, getCategory, getConnectorService, getDefaultFilterPool, getDefaultSystemFilterPool, getDescription, getFilterPoolManager, getFilterPoolManager, getFilterPoolManagerList, getId, getName, getService, getServiceImplType, getServiceType, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSystemProfile, getSystemProfile, getSystemTypes, getVendor, isFactoryFor, isPortEditable, isSubSystemsDeletable, preTestRenameSubSystemProfile, providesCustomDropInFilters, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveSubSystem, setConnection, setConnectorService, setCurrentSelection, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, supportsDeferredQueries, supportsDropInFilters, supportsEncoding, supportsFileTypes, supportsFilterCaching, supportsFilterChildren, supportsMultipleFilterStrings, 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
 

Field Detail

translatedType

protected String translatedType
Constructor Detail

RemoteCmdSubSystemConfiguration

public RemoteCmdSubSystemConfiguration()
Default constructor.

Method Detail

supportsMultiStringFilters

public boolean supportsMultiStringFilters()
Return true if the subsystem supports more than one filter string

Specified by:
supportsMultiStringFilters in interface ISubSystemConfiguration
Overrides:
supportsMultiStringFilters in class SubSystemConfiguration

supportsFilterStringExport

public boolean supportsFilterStringExport()
Return true if the subsystem supports the exporting of filter strings from it's filters

Specified by:
supportsFilterStringExport in interface ISubSystemConfiguration
Overrides:
supportsFilterStringExport in class SubSystemConfiguration

supportsEnvironmentVariablesPropertyPage

public boolean supportsEnvironmentVariablesPropertyPage()
Return true if subsystems of this configuration support the environment variables property. For default remote command subsystems, we return true.

Specified by:
supportsEnvironmentVariablesPropertyPage in interface IRemoteCmdSubSystemConfiguration
Returns:
true if environment variables are fully supported
See Also:
IRemoteCmdSubSystemConfiguration.supportsEnvironmentVariablesPropertyPage()

supportsCommands

public boolean supportsCommands()
We return true.

Specified by:
supportsCommands in interface ISubSystemConfiguration
Overrides:
supportsCommands in class SubSystemConfiguration
See Also:
SubSystemConfiguration.supportsCommands()

supportsFilters

public boolean supportsFilters()
Test if filters are supported. We return false.

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

supportsNestedFilters

public boolean supportsNestedFilters()
Test if nested filters are supported. We return false.

Specified by:
supportsNestedFilters in interface ISubSystemConfiguration
Overrides:
supportsNestedFilters in class SubSystemConfiguration
See Also:
SubSystemConfiguration.supportsNestedFilters()

isCaseSensitive

public boolean isCaseSensitive()
Tell us if filter strings are case sensitive. The default is false.

Specified by:
isCaseSensitive in interface ISubSystemConfiguration
Overrides:
isCaseSensitive in class SubSystemConfiguration

supportsDuplicateFilterStrings

public boolean supportsDuplicateFilterStrings()
Tell us if duplicate filter strings are supported. The default is true for command subsystem factories!

Overrides:
supportsDuplicateFilterStrings in class SubSystemConfiguration

createDefaultFilterPool

protected ISystemFilterPool createDefaultFilterPool(ISystemFilterPoolManager mgr)
Description copied from class: SubSystemConfiguration
Overridable lifecycle method. Typically overridden to supply a default filter.
When the user creates a new profile in the RSE (which is mapped to a SystemFilterPoolManager by our parent class), each subsystem configuration that supports filters is asked if it wants to create a default system filter pool in that profile.
This is the method that is called to do that default filter pool creation in the new profile.

By default we create an empty filter pool with a generated name, and no pre-defined filters. If you don't want that behaviour, override this method and do one of the following:

Overrides:
createDefaultFilterPool in class SubSystemConfiguration
See Also:
SubSystemConfiguration.createDefaultFilterPool(ISystemFilterPoolManager)

getTranslatedFilterTypeProperty

public String getTranslatedFilterTypeProperty(ISystemFilter selectedFilter)
Return the translated string to show in the property sheet for the type property.

Specified by:
getTranslatedFilterTypeProperty in interface ISubSystemConfiguration
Overrides:
getTranslatedFilterTypeProperty in class SubSystemConfiguration

getCommandSeparator

public String getCommandSeparator()
Description copied from interface: IRemoteCmdSubSystemConfiguration
Return in string format the character used to separate commands. Eg, ";" or "&"

Specified by:
getCommandSeparator in interface IRemoteCmdSubSystemConfiguration
Returns:
command separator String

RSE
Release 3.3

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