org.eclipse.rse.core.subsystems
Interface ISubSystemConfiguration

All Superinterfaces:

IAdaptable, org.eclipse.rse.core.persistance.IRSEPersistableContainer, ISystemFilterPoolManagerProvider

All Known Subinterfaces:

IFileServiceSubSystemConfiguration, IProcessServiceSubSystemConfiguration, IRemoteCmdSubSystemConfiguration, IRemoteFileSubSystemConfiguration, IRemoteProcessSubSystemConfiguration, IServiceSubSystemConfiguration, IShellServiceSubSystemConfiguration

All Known Implementing Classes:

FileServiceSubSystemConfiguration, ProcessServiceSubSystemConfiguration, org.eclipse.rse.internal.subsystems.shells.subsystems.RemoteCmdSubSystemConfiguration, RemoteFileSubSystemConfiguration, RemoteProcessSubSystemConfiguration, ServiceSubSystemConfiguration, ShellServiceSubSystemConfiguration, SubSystemConfiguration

public interface ISubSystemConfiguration

extends ISystemFilterPoolManagerProvider, org.eclipse.rse.core.persistance.IRSEPersistableContainer

Field Summary

static boolean	FORCE_INTO_MEMORY
static boolean	LAZILY

Method Summary

void	changingSystemProfileActiveStatus(ISystemProfile profile, boolean newStatus) Called by SystemRegistry when we have toggled the active-status of a profile
ISubSystem	cloneSubSystem(ISubSystem oldSubsystem, IHost newConnection, boolean copyProfileOperation) Clone a given subsystem into the given connection.
boolean	commit() Saves absolutely everything to disk.
ISystemFilterPoolManager	copyFilterPoolManager(ISystemProfile oldProfile, ISystemProfile newProfile) Copy the filter pool manager and return a new one.
IServerLauncherProperties	createServerLauncher(IConnectorService connectorService) Overridable entry for child classes to contribute a server launcher instance for a given subsystem.
ISubSystem	createSubSystem(IHost conn, boolean creatingConnection, ISystemNewConnectionWizardPage[] yourNewConnectionWizardPages) Creates a new subsystem instance that is associated with the given connection object.
ISubSystem	createSubSystemAfterTheFact(IHost conn)
ISubSystem	createSubSystemInternal(IHost conn)
boolean	deleteSubSystem(ISubSystem subsystem) Deletes a given subsystem instance from the list maintained by this factory.
void	deleteSubSystemsByConnection(IHost conn) Called by SystemRegistry's deleteConnection method to ensure we delete all our subsystems for a given connection.
void	deletingSystemProfile(ISystemProfile profile) Called by SystemRegistry when we are about to delete a profile.
void	disconnectAllSubSystems() Disconnect all subsystems currently connected.
String	getCategory() Return the category this subsystem factory subscribes to.
IConnectorService	getConnectorService(IHost host) Find or create a connector service for this host
ISystemFilterPool	getDefaultFilterPool(ISystemProfile profile, String oldProfileName)
ISystemFilterPool	getDefaultSystemFilterPool(ISubSystem subsys) Given a subsystem, return the first (hopefully only) default pool for this subsystem's profile.
String	getDescription() Return description of this factory.
ISystemFilterPoolManager	getFilterPoolManager(ISystemProfile profile) Get the filter pool manager for the given profile
List	getFilterPoolManagerList() Private.
String	getId() Return unique id of this factory.
String	getName() Return name of this factory.
ISubSystemConfigurationProxy	getSubSystemConfigurationProxy() Private method
List	getSubSystemList() Private.
ISubSystem[]	getSubSystems(boolean force) Returns a list of all subsystem objects for all connections.
ISubSystem[]	getSubSystems(IHost conn, boolean force) Returns a list of subsystem objects existing for the given connection.
ISystemProfile	getSystemProfile(ISystemFilterPool pool) Get owning profile object given a filter pool object
ISystemProfile	getSystemProfile(String name)
String[]	getSystemTypes() Return the system types this subsystem factory supports.
String	getTranslatedFilterTypeProperty(ISystemFilter selectedFilter) Return the translated string to show in the property sheet for the type property when a filter is selected.
String	getVendor() Return vendor of this factory.
boolean	isCaseSensitive() Tell us if filter strings are case sensitive.
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.
boolean	isPortEditable() Return true (default) or false to indicate if subsystems of this factory support user-editable port numbers.
boolean	isSubSystemsDeletable() Returns true if this factory allows users to delete instances of subsystem objects.
void	preTestRenameSubSystemProfile(String oldProfileName) Called by SystemRegistry's renameSystemProfile method to pre-test if we are going to run into errors on a profile rename, due to file or folder in use.
boolean	providesCustomDropInFilters() Return true if filters of this subsystem factory provide a custom implementation of drop support.
void	renameFilterPoolManager(ISystemProfile profile)
void	renameSubSystem(ISubSystem subsystem, String newName) Renames a subsystem.
void	renameSubSystemProfile(ISubSystem ss, String oldProfileName, String newProfileName) Called by SystemRegistry's renameSystemProfile method to ensure we update our subsystem names within each subsystem.
void	renameSubSystemsByConnection(IHost conn, String newConnectionName) Called by SystemRegistry's renameConnection method to ensure we update our connection names within each subsystem.
void	reset() Reset for a full refresh from disk, such as after a team synch.
void	saveSubSystem(ISubSystem subsys) Save one subsystem to disk.
void	setConnection(IHost connection) Called by adapters prior to asking for actions, in case the connection of the currently selected object is required by the action.
void	setCurrentSelection(Object[] selection) Called by adapters prior to asking for actions.
void	setShowFilterPools(boolean show) If we support filters, should we show filter pools in the remote system explorer?
void	setSubSystemConfigurationProxy(ISubSystemConfigurationProxy proxy) Private method called by RSEUIPlugin
void	setSubSystemPort(ISubSystem subsystem, int port) Update the port for the given subsystem instance.
void	setSubSystemUserId(ISubSystem subsystem, String userId) Update the user ID for the given subsystem instance.
boolean	showChangeFilterStringsPropertyPage(ISystemFilter filter) Given a filter, decide whether to show the Filter Strings property page for this filter.
boolean	showFilterPools() If we support filters, should we show filter pools in the remote system explorer?
boolean	showGenericShowInTableOnFilter() Return true if we should show the show in table action in the popup for the given element.
boolean	showRefreshOnFilter() Return true if we should show the refresh action in the popup for the given element.
boolean	supportsCommands() Return true if subsystem instances from this factory support remote command execution Returns false in default implementation, and is usually only true for command subsystems.
boolean	supportsCompileActions() Return true if you support compile actions for the remote system objects returned from expansion of subsystems created by this subsystem factory.
boolean	supportsDropInFilters() Return true if filters of this subsystem factory support dropping into.
boolean	supportsFileTypes() Return true if you support user-defined/managed named file types Returns false in default implementation.
boolean	supportsFilterCaching() Required method for subsystem factory child classes.
boolean	supportsFilterChildren() Indicates whether the subsystem supports displaying children under its filters.
boolean	supportsFilters() Required method for subsystem factory child classes.
boolean	supportsFilterStringExport() Return true if the subsystem supports the exporting of filter strings from it's filters RETURNS true BY DEFAULT
boolean	supportsMultipleFilterStrings() Required method for subsystem factory child classes.
boolean	supportsMultiStringFilters() Return true if the subsystem supports more than one filter string RETURNS true BY DEFAULT
boolean	supportsNestedFilters() Required method for subsystem factory child classes if returning true from supportsFilters.
boolean	supportsProperties() Return true if subsystem instances from this factory support getting and setting properties Returns false in default implementation, and not actually used yet.
boolean	supportsQuickFilters() Return true if you support quick filters.
boolean	supportsServerLaunchProperties(IHost host) Tell us if this subsystem factory supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started.
boolean	supportsServerLaunchType(ServerLaunchType serverLaunchType) If supportsServerLaunchProperties(IHost) returns true, this method may be called by the server launcher to decide if a given remote server launch type is supported or not.
boolean	supportsSubSystemConnect() Return true if subsystem instances from this factory support connect and disconnect actions Returns true in default implementation.
boolean	supportsTargets() Tell us if this subsystem factory supports targets, which are destinations for pushes and builds.
boolean	supportsUserDefinedActions() Return true if you support user-defined actions for the remote system objects returned from expansion of subsystems created by this subsystem factory
ISubSystem[]	testForActiveReferences(ISystemProfile profile) Test if any filter pools in the given profile are referenced by other profiles, which are active.
void	updateSubSystem(ISubSystem subsystem, boolean updateUserId, String userId, boolean updatePort, int port) Updates user-editable attributes of an existing subsystem instance.

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.persistance.IRSEPersistableContainer

isDirty, setDirty, setWasRestored, wasRestored

Field Detail

FORCE_INTO_MEMORY

public static final boolean FORCE_INTO_MEMORY

See Also:

Constant Field Values

LAZILY

public static final boolean LAZILY

See Also:

Constant Field Values

Method Detail

reset

public void reset()

Reset for a full refresh from disk, such as after a team synch.

supportsMultiStringFilters

public boolean supportsMultiStringFilters()

Return true if the subsystem supports more than one filter string

RETURNS true BY DEFAULT

supportsFilterStringExport

public boolean supportsFilterStringExport()

Return true if the subsystem supports the exporting of filter strings from it's filters

RETURNS true BY DEFAULT

supportsSubSystemConnect

public boolean supportsSubSystemConnect()

Return true if subsystem instances from this factory support connect and disconnect actions

Returns true in default implementation.

isPortEditable

public boolean isPortEditable()

Return true (default) or false to indicate if subsystems of this factory support user-editable port numbers.

Returns true in default implementation.

supportsCommands

public boolean supportsCommands()

Return true if subsystem instances from this factory support remote command execution

Returns false in default implementation, and is usually only true for command subsystems.

supportsProperties

public boolean supportsProperties()

Return true if subsystem instances from this factory support getting and setting properties

Returns false in default implementation, and not actually used yet.

supportsFilters

public boolean supportsFilters()

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.

supportsFilterChildren

public boolean supportsFilterChildren()

Indicates whether the subsystem supports displaying children under its filters. By default, this will return true, but if filters that can't be expanded are desired, this can be overridden to return false.

supportsFilterCaching

public boolean supportsFilterCaching()

Required method for subsystem factory child classes. Return true if you filter caching. If you support filter caching, then the views will always check the in-memory cache for filter results before attempting a query.

Returns true in default implementation.

supportsMultipleFilterStrings

public boolean supportsMultipleFilterStrings()

Required method for subsystem factory child classes. Return true if you support filters, and you support multiple filter strings per filter. Return false to restrict the user to one string per filter.

Returns true in default implementation.

supportsNestedFilters

public boolean supportsNestedFilters()

Required method for subsystem factory child classes if returning true from supportsFilters. Return true if you support filters within filters, false otherwise.

Returns false in default implementation.

supportsQuickFilters

public boolean supportsQuickFilters()

Return true if you support quick filters. These allow the user to subset a remote system object at the time they expand it in the remote system explorer tree view.

Not supported yet

supportsDropInFilters

public boolean supportsDropInFilters()

Return true if filters of this subsystem factory support dropping into.

providesCustomDropInFilters

public boolean providesCustomDropInFilters()

Return true if filters of this subsystem factory provide a custom implementation of drop support. By default, the filter reference adapter treats a drop on a filter as an update to the list of filter strings for a filter. For things like files, it is more desirable to treat the drop as a physical resource copy, so in that case, custom drop makes sense. By default this returns false.

supportsUserDefinedActions

public boolean supportsUserDefinedActions()

Return true if you support user-defined actions for the remote system objects returned from expansion of subsystems created by this subsystem factory

See Also:

#getActionSubSystem(ISubSystem),

Returns false in default implementation.

supportsCompileActions

public boolean supportsCompileActions()

Return true if you support compile actions for the remote system objects returned from expansion of subsystems created by this subsystem factory.

See Also:

Returns false in default implementation.

supportsFileTypes

public boolean supportsFileTypes()

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

Returns false in default implementation.

supportsTargets

public boolean supportsTargets()

Tell us if this subsystem factory supports targets, which are destinations for pushes and builds. Normally only true for file system factories.

supportsServerLaunchProperties

public boolean supportsServerLaunchProperties(IHost host)

Tell us if this subsystem factory 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.
By default we return false here. This is overridden in UniversalFileSubSystemConfiguration though.

supportsServerLaunchType

public boolean supportsServerLaunchType(ServerLaunchType serverLaunchType)

If supportsServerLaunchProperties(IHost) returns true, this method may be called by the server launcher to decide if a given remote server launch type is supported or not.
We return true by default.

See Also:

ServerLaunchType, #getServerLauncherForm(Shell, ISystemMessageLine)

isCaseSensitive

public boolean isCaseSensitive()

Tell us if filter strings are case sensitive.

Returns false in default implementation.

showFilterPools

public boolean showFilterPools()

If we support filters, should we show filter pools in the remote system explorer? Typically retrieved from user preferences.

setShowFilterPools

public void setShowFilterPools(boolean show)

If we support filters, should we show filter pools in the remote system explorer? This is to set it after the user changes it in the user preferences. It may require refreshing the current view.

setSubSystemConfigurationProxy

public void setSubSystemConfigurationProxy(ISubSystemConfigurationProxy proxy)

Private method called by RSEUIPlugin

getSubSystemConfigurationProxy

public ISubSystemConfigurationProxy getSubSystemConfigurationProxy()

Private method

getVendor

public String getVendor()

Return vendor of this factory. This comes from the xml "vendor" attribute of the extension point.

getName

public String getName()

Return name of this factory. Matches value in name attribute in extension point xml

getDescription

public String getDescription()

Return description of this factory. Comes from translated description string in extension point xml

getId

public String getId()

Return unique id of this factory. Matches value in id attribute in extension point xml

Specified by:

getId in interface ISystemFilterPoolManagerProvider

Returns:

getCategory

public String getCategory()

Return the category this subsystem factory subscribes to.

See Also:

org.eclipse.rse.model.ISubSystemConfigurationCategories

getSystemTypes

public String[] getSystemTypes()

Return the system types this subsystem factory supports.

deletingSystemProfile

public void deletingSystemProfile(ISystemProfile profile)

Called by SystemRegistry when we are about to delete a profile.

Our only mission is to delete the filter pool associated with it, because the registry has already called deleteSubSystemsByConnection for every subsystem of every connection owned by this profile.

changingSystemProfileActiveStatus

public void changingSystemProfileActiveStatus(ISystemProfile profile,
                                              boolean newStatus)

Called by SystemRegistry when we have toggled the active-status of a profile

getSystemProfile

public ISystemProfile getSystemProfile(ISystemFilterPool pool)

Get owning profile object given a filter pool object

renameSubSystemProfile

public void renameSubSystemProfile(ISubSystem ss,
                                   String oldProfileName,
                                   String newProfileName)

Called by SystemRegistry's renameSystemProfile method to ensure we update our subsystem names within each subsystem.

This is called AFTER changing the profile's name!!

preTestRenameSubSystemProfile

public void preTestRenameSubSystemProfile(String oldProfileName)
                                   throws Exception

Called by SystemRegistry's renameSystemProfile method to pre-test if we are going to run into errors on a profile rename, due to file or folder in use.

Throws:

Exception

renameSubSystemsByConnection

public void renameSubSystemsByConnection(IHost conn,
                                         String newConnectionName)

Called by SystemRegistry's renameConnection method to ensure we update our connection names within each subsystem.

Must be called prior to changing the connection's name!!

deleteSubSystemsByConnection

public void deleteSubSystemsByConnection(IHost conn)

Called by SystemRegistry's deleteConnection method to ensure we delete all our subsystems for a given connection.

createSubSystem

public ISubSystem createSubSystem(IHost conn,
                                  boolean creatingConnection,
                                  ISystemNewConnectionWizardPage[] yourNewConnectionWizardPages)

Creates a new subsystem instance that is associated with the given connection object. SystemRegistryImpl calls this when a new connection is created, and appliesToSystemType returns true.

Parameters:

conn - The connection to create a subsystem for

creatingConnection - true if we are creating a connection, false if just creating another subsystem for an existing connection.

yourNewConnectionWizardPages - The wizard pages you supplied to the New Connection wizard, via the ISubSystemConfigurationAdapter.getNewConnectionWizardPages(ISubSystemConfiguration, org.eclipse.jface.wizard.IWizard) method or null if you didn't override this method.

createSubSystemAfterTheFact

public ISubSystem createSubSystemAfterTheFact(IHost conn)

createSubSystemInternal

public ISubSystem createSubSystemInternal(IHost conn)

getConnectorService

public IConnectorService getConnectorService(IHost host)

Find or create a connector service for this host

createServerLauncher

public IServerLauncherProperties createServerLauncher(IConnectorService connectorService)

Overridable entry for child classes to contribute a server launcher instance for a given subsystem.

Create an instance of ServerLauncher, and add it to the given subsystem. When a subsystem is created, and supportsServerLaunchProperties(IHost) returns true, this method is called to create the server launcher instance associated with the subsystem. The default implementation is to create an instance of IRemoteServerLauncher, but override to create your own ServerLauncher instance if you have your own class.

updateSubSystem

public void updateSubSystem(ISubSystem subsystem,
                            boolean updateUserId,
                            String userId,
                            boolean updatePort,
                            int port)

Updates user-editable attributes of an existing subsystem instance. These attributes typically affect the live connection, so the subsystem will be forced to disconnect.

The subsystem will be saved to disk.

Parameters:

subsystem - target of the update action

updateUserId - true if we are updating the userId, else false to ignore userId

userId - new local user Id. Ignored if updateUserId is false

updatePort - true if we are updating the port, else false to ignore port

port - new local port value. Ignored if updatePort is false

setSubSystemPort

public void setSubSystemPort(ISubSystem subsystem,
                             int port)

Update the port for the given subsystem instance. Shortcut to #updateSubSystem(Shell, ISubSystem, boolean, String, boolean, int)

setSubSystemUserId

public void setSubSystemUserId(ISubSystem subsystem,
                               String userId)

Update the user ID for the given subsystem instance. Shortcut to #updateSubSystem(Shell, ISubSystem, boolean, String, boolean, int)

isSubSystemsDeletable

public boolean isSubSystemsDeletable()

Returns true if this factory allows users to delete instances of subsystem objects. Would only be true if users are allowed to create multiple instances of subsystem objects per connection.

deleteSubSystem

public boolean deleteSubSystem(ISubSystem subsystem)

Deletes a given subsystem instance from the list maintained by this factory. SystemRegistryImpl calls this when the user selects to delete a subsystem object, or delete the parent connection this subsystem is associated with. In former case, this is only called if the factory supports user-deletable subsystems.

cloneSubSystem

public ISubSystem cloneSubSystem(ISubSystem oldSubsystem,
                                 IHost newConnection,
                                 boolean copyProfileOperation)
                          throws Exception

Clone a given subsystem into the given connection. Called when user does a copy-connection action.

Parameters:

oldSubsystem - The subsystem to be cloned

newConnection - The connection into which to create and clone the old subsystem

copyProfileOperation - Pass true if this is an profile-copy operation versus a connection-copy operation

Returns:

New subsystem within the new connection

Throws:

Exception

getSubSystems

public ISubSystem[] getSubSystems(IHost conn,
                                  boolean force)

Returns a list of subsystem objects existing for the given connection.

Parameters:

conn - System connection to retrieve subsystems for

force - true if we should force all the subsystems to be restored from disk if not already

getSubSystems

public ISubSystem[] getSubSystems(boolean force)

Returns a list of all subsystem objects for all connections.

renameSubSystem

public void renameSubSystem(ISubSystem subsystem,
                            String newName)

Renames a subsystem. This is better than ss.setName(String newName) as it saves the subsystem to disk.

disconnectAllSubSystems

public void disconnectAllSubSystems()
                             throws Exception

Disconnect all subsystems currently connected. Called by shutdown() of RSEUIPlugin.

Throws:

Exception

getFilterPoolManager

public ISystemFilterPoolManager getFilterPoolManager(ISystemProfile profile)

Get the filter pool manager for the given profile

copyFilterPoolManager

public ISystemFilterPoolManager copyFilterPoolManager(ISystemProfile oldProfile,
                                                      ISystemProfile newProfile)
                                               throws Exception

Copy the filter pool manager and return a new one. Called during profile-copy operations. Will also copy all of the filter pools and their respective data.

Throws:

Exception

getDefaultSystemFilterPool

public ISystemFilterPool getDefaultSystemFilterPool(ISubSystem subsys)

Given a subsystem, return the first (hopefully only) default pool for this subsystem's profile.

testForActiveReferences

public ISubSystem[] testForActiveReferences(ISystemProfile profile)

Test if any filter pools in the given profile are referenced by other profiles, which are active.

Called when user tries to make a profile inactive. We prevent this if there exists active references.

Parameters:

profile - The profile being tested

Returns:

An array of the active subsystems which reference filter pools in this profile, or null if none are found.

getTranslatedFilterTypeProperty

public String getTranslatedFilterTypeProperty(ISystemFilter selectedFilter)

Return the translated string to show in the property sheet for the type property when a filter is selected.

showRefreshOnFilter

public boolean showRefreshOnFilter()

Return true if we should show the refresh action in the popup for the given element.

showGenericShowInTableOnFilter

public boolean showGenericShowInTableOnFilter()

Return true if we should show the show in table action in the popup for the given element.

showChangeFilterStringsPropertyPage

public boolean showChangeFilterStringsPropertyPage(ISystemFilter filter)

Given a filter, decide whether to show the Filter Strings property page for this filter. Default is true.

isFactoryFor

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

Parameters:

subSystemType - type of subsystem

Returns:

whether this factory is for the specified subsystemtype

setConnection

public void setConnection(IHost connection)

Called by adapters prior to asking for actions, in case the connection of the currently selected object is required by the action.

setCurrentSelection

public void setCurrentSelection(Object[] selection)

Called by adapters prior to asking for actions. For cases when current selection is needed.

commit

public boolean commit()

Saves absolutely everything to disk. This is called as a safety measure when the workbench shuts down.

Totally handled for you!

Calls saveSubSystems() and saveFilterPools()

Exceptions are swallowed since we cannot deal with them on shutdown anyway!

Specified by:

commit in interface org.eclipse.rse.core.persistance.IRSEPersistableContainer

Returns:

true if the object was persisted.

saveSubSystem

public void saveSubSystem(ISubSystem subsys)
                   throws Exception

Save one subsystem to disk. Called by each subsystem when their data changes.

Throws:

Exception

getSubSystemList

public List getSubSystemList()

Private. Do not call or use.

Returns:

The list of SubSystemList references

getFilterPoolManagerList

public List getFilterPoolManagerList()

Private. Do not call or use.

Returns:

The list of FilterPoolManagerList references

getDefaultFilterPool

public ISystemFilterPool getDefaultFilterPool(ISystemProfile profile,
                                              String oldProfileName)

getSystemProfile

public ISystemProfile getSystemProfile(String name)

renameFilterPoolManager

public void renameFilterPoolManager(ISystemProfile profile)