|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISubSystemConfiguration
Subsystem Configuration interface.
Field Summary | |
---|---|
static boolean |
FORCE_INTO_MEMORY
|
static boolean |
LAZILY
|
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
NO_CHILDREN |
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,
ISubSystemConfigurator[] configurators)
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. |
ISystemFilterPoolManager[] |
getAllSystemFilterPoolManagers()
Retrieves all the filter pool managers for all the profiles, active or not. |
String |
getCategory()
Return the category this subsystem factory subscribes to. |
IConnectorService |
getConnectorService(IHost host)
Get the connector service for a particular 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. |
ISystemFilterPoolManager |
getFilterPoolManager(ISystemProfile profile,
boolean force)
Get the filter pool manager for the given profile. |
List |
getFilterPoolManagerList()
Return the internal list of filter pool managers associated with this configuration. |
String |
getId()
Return unique id of this factory. |
String |
getName()
Return name of this factory. |
IService |
getService(IHost host)
Get the actual service associated with a particular host. |
Class |
getServiceImplType()
Get the implementation type of the service associated with this subsystem configuration. |
Class |
getServiceType()
Get the service type associated with this subsystem configuration. |
ISubSystemConfigurationProxy |
getSubSystemConfigurationProxy()
Private method |
List |
getSubSystemList()
Return the internal list of subsystems instantiated for this configuration. |
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)
|
IRSESystemType[] |
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 subsystem,
String oldProfileName,
String newProfileName)
Called by SystemRegistry's renameSystemProfile method to ensure we update our subsystem names within each subsystem. |
void |
renameSubSystemProfile(String oldProfileName,
String newProfileName)
Callback method called after renaming a subsystem profile. |
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 |
setConnectorService(IHost host,
IConnectorService connectorService)
Set the connector service for a particular host. |
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 |
supportsDeferredQueries()
Return true if deferred queries are supported. |
boolean |
supportsDropInFilters()
Return true if filters of this subsystem factory support dropping into. |
boolean |
supportsEncoding(IHost host)
Test whether subsystems managed by this configuration support custom encodings. |
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. |
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.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
Field Detail |
---|
static final boolean FORCE_INTO_MEMORY
static final boolean LAZILY
Method Detail |
---|
void reset()
ISystemFilterPoolManager[] getAllSystemFilterPoolManagers()
boolean supportsEncoding(IHost host)
IHost.getDefaultEncoding(boolean)
.
It's possible, however, that a particular subsystem "knows" that its
resources are always encoded in a particular way, and there is no
possibility to ever change that. The Subsystem Configuration would return
false
here in this case. Another possibility is that
encodings for a particular subsystem can be changed, but in a way that's
different than what RSE usually does. The default case, however, should
be that subsystems fall back to the setting specified by the host or its
underlying system type such that existing subsystem configurations can be
re-used in an environment where the encoding to use is pre-defined by the
system type or host connection.
If no subsystem registered against a given host supports encodings, the
corresponding UI controls on the IHost level are disabled in order to
avoid confusion to the user.
true if the RSE mechanisms for specifying custom
encodings are observed and supported by the subsystems managed
by this configuration for the given host.- Since:
- org.eclipse.rse.core 3.0
- See Also:
IRSESystemType.PROPERTY_SUPPORTS_ENCODING
boolean supportsMultiStringFilters()
RETURNS true BY DEFAULT
boolean supportsFilterStringExport()
RETURNS true BY DEFAULT
boolean supportsSubSystemConnect()
Returns true in default implementation.
boolean isPortEditable()
Returns true in default implementation.
boolean supportsCommands()
Returns false in default implementation, and is usually only true for command subsystems. NOTE: command subsystems are special because their filters don't yield children or allow drilling into them via Show In Table, Open In New Window or Go Into. See bug 249245 and bug 254605 for further explanation.
boolean supportsProperties()
Returns false in default implementation, and not actually used yet.
boolean supportsFilters()
Returns true in default implementation.
boolean supportsFilterChildren()
boolean supportsFilterCaching()
Returns true in default implementation.
boolean supportsMultipleFilterStrings()
Returns true in default implementation.
boolean supportsNestedFilters()
Returns false in default implementation.
boolean supportsQuickFilters()
Not supported yet
boolean supportsDropInFilters()
boolean supportsDeferredQueries()
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.
true
if deferred queries are supported.boolean providesCustomDropInFilters()
boolean supportsFileTypes()
Returns false in default implementation.
boolean supportsTargets()
boolean supportsServerLaunchProperties(IHost host)
boolean supportsServerLaunchType(ServerLaunchType serverLaunchType)
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.
ServerLaunchType
boolean isCaseSensitive()
Returns false in default implementation.
boolean showFilterPools()
void setShowFilterPools(boolean show)
void setSubSystemConfigurationProxy(ISubSystemConfigurationProxy proxy)
ISubSystemConfigurationProxy getSubSystemConfigurationProxy()
String getVendor()
String getName()
String getDescription()
String getId()
getId
in interface ISystemFilterPoolManagerProvider
String getCategory()
ISubSystemConfigurationCategories
IRSESystemType[] getSystemTypes()
void deletingSystemProfile(ISystemProfile 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.
void changingSystemProfileActiveStatus(ISystemProfile profile, boolean newStatus)
ISystemProfile getSystemProfile(ISystemFilterPool pool)
void renameSubSystemProfile(String oldProfileName, String newProfileName)
This is called by SystemRegistry's renameSystemProfile method after it is complete, , in order to allow the subsystem configuration perform any required cleanup. For instance, subsystem configurations must ensure that they update their filter pool manager names (and their folders).
Must be called AFTER changing the profile's name!!
oldProfileName
- the old profile name.newProfileName
- the new profile name.void renameSubSystemProfile(ISubSystem subsystem, String oldProfileName, String newProfileName)
subsystem
- the subsystem to be updatedoldProfileName
- the old profile namenewProfileName
- the new profile namevoid preTestRenameSubSystemProfile(String oldProfileName) throws Exception
Exception
void renameSubSystemsByConnection(IHost conn, String newConnectionName)
Must be called prior to changing the connection's name!!
void deleteSubSystemsByConnection(IHost conn)
ISubSystem createSubSystem(IHost conn, boolean creatingConnection, ISubSystemConfigurator[] configurators)
conn
- The connection to create a subsystem forcreatingConnection
- true if we are creating a connection, false if just creating
another subsystem for an existing connection.configurators
- The configurators that will be applied to a new subsystem or null if there are none.ISubSystem createSubSystemAfterTheFact(IHost conn)
ISubSystem createSubSystemInternal(IHost conn)
IConnectorService getConnectorService(IHost host)
setConnectorService(IHost, IConnectorService)
.
host
- the host for which to create or retrieve the connector service
supportsSubSystemConnect()
is true.void setConnectorService(IHost host, IConnectorService connectorService)
host
- the host for which to set this connector service.connectorService
- the connector service associated with this host.Class getServiceType()
null
, otherwise it must return the interface class that
the underlying service layer implements.
null
if this is not a service subsystem configuration.Class getServiceImplType()
null
, otherwise it
must return the class that implements the interface specified in
getServiceType()
.
getServiceType()
, or null
if this is
not a service subsystem configuration.IService getService(IHost host)
getServiceImplType()
that is associated with this host instance.
host
- The host for which to retrieve the service.
IService
which is associated with this
host, or null
if this is not a service subsystem
configuration.IServerLauncherProperties createServerLauncher(IConnectorService connectorService)
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.
void updateSubSystem(ISubSystem subsystem, boolean updateUserId, String userId, boolean updatePort, int port)
The subsystem will be saved to disk.
subsystem
- target of the update actionupdateUserId
- true if we are updating the userId, else false to ignore userIduserId
- new local user Id. Ignored if updateUserId is falseupdatePort
- true if we are updating the port, else false to ignore portport
- new local port value. Ignored if updatePort is falsevoid setSubSystemPort(ISubSystem subsystem, int port)
void setSubSystemUserId(ISubSystem subsystem, String userId)
boolean isSubSystemsDeletable()
boolean deleteSubSystem(ISubSystem subsystem)
ISubSystem cloneSubSystem(ISubSystem oldSubsystem, IHost newConnection, boolean copyProfileOperation) throws Exception
oldSubsystem
- The subsystem to be clonednewConnection
- The connection into which to create and clone the old subsystemcopyProfileOperation
- Pass true if this is an profile-copy operation versus a connection-copy operation
Exception
ISubSystem[] getSubSystems(IHost conn, boolean force)
conn
- System connection to retrieve subsystems forforce
- true if we should force all the subsystems to be restored from disk if not alreadyISubSystem[] getSubSystems(boolean force)
void renameSubSystem(ISubSystem subsystem, String newName)
void disconnectAllSubSystems() throws Exception
Exception
ISystemFilterPoolManager getFilterPoolManager(ISystemProfile profile, boolean force)
profile
- The system profile for which to get the manager.force
- if true then create the default filters for this subsystem
configuration in this profile. This should only be done during
initial subsystem creation, not during subsystem restore.
ISystemFilterPoolManager getFilterPoolManager(ISystemProfile profile)
profile
- The system profile for which to get the manager.
ISystemFilterPoolManager copyFilterPoolManager(ISystemProfile oldProfile, ISystemProfile newProfile) throws Exception
Exception
ISystemFilterPool getDefaultSystemFilterPool(ISubSystem subsys)
ISubSystem[] testForActiveReferences(ISystemProfile profile)
Called when user tries to make a profile inactive. We prevent this if there exists active references.
profile
- The profile being tested
String getTranslatedFilterTypeProperty(ISystemFilter selectedFilter)
boolean showRefreshOnFilter()
boolean showGenericShowInTableOnFilter()
boolean showChangeFilterStringsPropertyPage(ISystemFilter filter)
boolean isFactoryFor(Class subSystemType)
subSystemType
- type of subsystem
void setConnection(IHost connection)
void setCurrentSelection(Object[] selection)
boolean commit()
Totally handled for you!
Calls saveSubSystems() and saveFilterPools()
Exceptions are swallowed since we cannot deal with them on shutdown anyway!
commit
in interface IRSEPersistableContainer
void saveSubSystem(ISubSystem subsys) throws Exception
Exception
List getSubSystemList()
getSubSystems(boolean)
with a false
argument
instead.
List getFilterPoolManagerList()
ISystemFilterPool getDefaultFilterPool(ISystemProfile profile, String oldProfileName)
ISystemProfile getSystemProfile(String name)
void renameFilterPoolManager(ISystemProfile profile)
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |