RSE
Release 3.3

org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem
Class ShellServiceSubSystemConfiguration

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

public abstract class ShellServiceSubSystemConfiguration
extends RemoteCmdSubSystemConfiguration
implements IShellServiceSubSystemConfiguration


Field Summary
 
Fields inherited from class org.eclipse.rse.subsystems.shells.core.subsystems.RemoteCmdSubSystemConfiguration
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
protected ShellServiceSubSystemConfiguration()
           
 
Method Summary
 IServiceCommandShell createRemoteCommandShell(IRemoteCmdSubSystem cmdSS, IHostShell hostShell)
           
 IService getService(IHost host)
          Get the actual service associated with a particular host. This default implementation returns null.
 Class getServiceType()
          Get the service type associated with this subsystem configuration. This default implementation returns null.
 IShellService getShellService(IHost host)
           
 boolean supportsServerLaunchProperties(IHost host)
          Tell us if this subsystem configuration supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started.
 
Methods inherited from class org.eclipse.rse.subsystems.shells.core.subsystems.RemoteCmdSubSystemConfiguration
createDefaultFilterPool, getCommandSeparator, getTranslatedFilterTypeProperty, isCaseSensitive, supportsCommands, supportsDuplicateFilterStrings, supportsEnvironmentVariablesPropertyPage, supportsFilters, supportsFilterStringExport, supportsMultiStringFilters, supportsNestedFilters
 
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, getServiceImplType, 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, 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.subsystems.shells.core.subsystems.servicesubsystem.IShellServiceSubSystemConfiguration
createShellService
 
Methods inherited from interface org.eclipse.rse.subsystems.shells.core.subsystems.IRemoteCmdSubSystemConfiguration
getCommandSeparator, supportsEnvironmentVariablesPropertyPage
 
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, getServiceImplType, getSubSystemConfigurationProxy, getSubSystemList, getSubSystems, getSubSystems, getSystemProfile, getSystemProfile, getSystemTypes, getTranslatedFilterTypeProperty, getVendor, isCaseSensitive, isFactoryFor, isPortEditable, isSubSystemsDeletable, preTestRenameSubSystemProfile, providesCustomDropInFilters, renameFilterPoolManager, renameSubSystem, renameSubSystemProfile, renameSubSystemProfile, renameSubSystemsByConnection, reset, saveSubSystem, setConnection, setConnectorService, setCurrentSelection, setShowFilterPools, setSubSystemConfigurationProxy, setSubSystemPort, setSubSystemUserId, showChangeFilterStringsPropertyPage, showFilterPools, showGenericShowInTableOnFilter, showRefreshOnFilter, supportsCommands, supportsDeferredQueries, supportsDropInFilters, supportsEncoding, supportsFileTypes, supportsFilterCaching, supportsFilterChildren, supportsFilters, supportsFilterStringExport, supportsMultipleFilterStrings, supportsMultiStringFilters, supportsNestedFilters, supportsProperties, supportsQuickFilters, 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

ShellServiceSubSystemConfiguration

protected ShellServiceSubSystemConfiguration()
Method Detail

getServiceType

public final Class getServiceType()
Description copied from class: SubSystemConfiguration
Get the service type associated with this subsystem configuration. If the configuration is not a service subsystem configuration it must return null, otherwise it must return the interface class that the underlying service layer implements.

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

Specified by:
getServiceType in interface ISubSystemConfiguration
Overrides:
getServiceType in class SubSystemConfiguration
Returns:
an interface class that is implemented by the service layer used by subsystems that have this configuration, or null if this is not a service subsystem configuration.
See Also:
ISubSystemConfiguration.getServiceType()

getShellService

public final IShellService getShellService(IHost host)
Specified by:
getShellService in interface IShellServiceSubSystemConfiguration

getService

public final IService getService(IHost host)
Description copied from class: SubSystemConfiguration
Get the actual service associated with a particular host. If the configuration is not a service subsystem this must return null. Otherwise this must return the particular instance of the class returned by ISubSystemConfiguration.getServiceImplType() that is associated with this host instance.

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

Specified by:
getService in interface ISubSystemConfiguration
Overrides:
getService in class SubSystemConfiguration
Parameters:
host - The host for which to retrieve the service.
Returns:
The instance of IService which is associated with this host, or null if this is not a service subsystem configuration.
See Also:
ISubSystemConfiguration.getService(IHost)

supportsServerLaunchProperties

public boolean supportsServerLaunchProperties(IHost host)
Description copied from class: SubSystemConfiguration
Tell us if this subsystem configuration supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started. There is a Server Launch Setting property page, with a pluggable composite, where users can configure these properties.

If you return true here, you may also want to override SubSystemConfiguration.supportsServerLaunchType(ServerLaunchType).
By default we return false here. This is overridden in UniversalFileSubSystemConfiguration though.

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

createRemoteCommandShell

public IServiceCommandShell createRemoteCommandShell(IRemoteCmdSubSystem cmdSS,
                                                     IHostShell hostShell)
Specified by:
createRemoteCommandShell in interface IShellServiceSubSystemConfiguration

RSE
Release 3.3

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