org.eclipse.rse.core.subsystems.util
Interface ISubSystemConfigurationAdapter

All Known Implementing Classes:

SubSystemConfigurationAdapter

public interface ISubSystemConfigurationAdapter

Defines the interface that must be implemented for adapters of for subsystem configurations. This adapter is used when creating wizard pages for new connections.

Method Summary

void	addCommonRemoteActions(ISubSystemConfiguration factory, SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, ISubSystem subsystem) Returns any framework-supplied actions remote objects that should be contributed to the popup menu for the given selection list.
void	configureNewFilterAction(ISubSystemConfiguration factory, SystemNewFilterAction newFilterAction, Object callerData) There is a reasonable amount of processing needed to configure filter wizards.
ISystemFilter	createFilterByPrompting(ISubSystemConfiguration factory, ISystemFilterReference referenceToPromptableFilter, Shell shell) Prompt the user to create a new filter as a result of the user expanding a promptable filter.
void	customizeChangeFilterPropertyPage(ISubSystemConfiguration factory, SystemChangeFilterPropertyPage page, ISystemFilter selectedFilter, Shell shell) In addition to a change filter action, we now also support the same functionality via a Properties page for filters.
void	customizeFilterStringPropertyPage(ISubSystemConfiguration factory, SystemFilterStringPropertyPage page, ISystemFilterString selectedFilterString, Shell shell) In addition to a change filter action, we now also support the same functionality via a Properties page for filter strings, in the Team View.
IAction[]	getFilterActions(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) Returns a list of actions for the popup menu when user right clicks on a filter object.
IAction[]	getFilterPoolActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Returns a list of actions for the popup menu when user right clicks on a filter pool object within a subsystem of this factory.
IAction[]	getFilterPoolReferenceActions(ISubSystemConfiguration factory, ISystemFilterPoolReference selectedPoolReference, Shell shell) Returns a list of actions for the popup menu when user right clicks on a filter pool reference object within a subsystem of this factory.
IAction[]	getFilterReferenceActions(ISubSystemConfiguration factory, ISystemFilterReference selectedFilterRef, Shell shell) Returns a list of actions for the popup menu when user right clicks on a filter reference object within a subsystem of this factory.
Image	getGraphicsImage(ISubSystemConfiguration factory) Return actual graphics Image of this factory.
Image	getGraphicsLiveImage(ISubSystemConfiguration factory) Return actual graphics LiveImage of this factory.
ImageDescriptor	getImage(ISubSystemConfiguration factory) Return image descriptor for subsystems created by this factory.
ImageDescriptor	getLiveImage(ISubSystemConfiguration factory) Return image to use when this susystem is connection.
ISystemNewConnectionWizardPage[]	getNewConnectionWizardPages(ISubSystemConfiguration factory, IWizard wizard) Optionally return one or more wizard pages to append to the New Connection Wizard if the user selects a system type that this subsystem factory supports.
ISystemValidator	getPasswordValidator(ISubSystemConfiguration confi) Return the validator for the password which is prompted for at runtime.
ISystemValidator	getPortValidator(ISubSystemConfiguration confi) Return the validator for the port.
PropertyPage	getPropertyPage(ISubSystem subsystem, Composite parent) Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection.
IServerLauncherForm	getServerLauncherForm(ISubSystemConfiguration factory, Shell shell, ISystemMessageLine msgLine) Return the form used in the property page, etc for this server launcher.
IAction[]	getSubSystemActions(ISubSystemConfiguration factory, ISubSystem selectedSubSystem, Shell shell) Returns a list of actions for the popup menu when user right clicks on a subsystem object from this factory.
ISystemSubSystemPropertyPageCoreForm	getSubSystemPropertyPageCoreFrom(ISubSystemConfiguration factory, ISystemMessageLine msgLine, Object caller)
ImageDescriptor	getSystemFilterImage(ISystemFilter filter) Supply the image to be used for filters, within actions.
ImageDescriptor	getSystemFilterPoolImage(ISystemFilterPool filterPool) Supply the image to be used for filter pools, within actions.
ImageDescriptor	getSystemFilterPoolManagerImage() Supply the image to be used for filter pool managers, within actions.
ImageDescriptor	getSystemFilterStringImage(ISystemFilterString filterString)
ImageDescriptor	getSystemFilterStringImage(String filterStringString)
ISystemValidator	getUserIdValidator(ISubSystemConfiguration config) Return the validator for the userId.
void	renameSubSystemProfile(ISubSystemConfiguration factory, String oldProfileName, String newProfileName)

Method Detail

configureNewFilterAction

public void configureNewFilterAction(ISubSystemConfiguration factory,
                                     SystemNewFilterAction newFilterAction,
                                     Object callerData)

There is a reasonable amount of processing needed to configure filter wizards. To aid in performance and memory usage, we extract that processing into this method, and then use a callback contract with the filter wizard to call us back to do this processing only at the time the action is actually selected to be run.

The processing we do here is to specify the filter pools to prompt the user for, in the second page of the New Filter wizards.

This method is from the ISystemNewFilterActionConfigurator interface

getNewConnectionWizardPages

public ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(ISubSystemConfiguration factory,
                                                                    IWizard wizard)

Optionally return one or more wizard pages to append to the New Connection Wizard if the user selects a system type that this subsystem factory supports.

Some details:

• The wizard pages must implement ISystemNewConnectionWizardPage, so as to fit into the wizard's framework
• When the user successfully presses Finish, the createConnection method in the SystemRegistry will call your #createSubSystem(IHost,boolean, ISystemNewConnectionWizardPage[]) method to create the your subsystem for the connection. The same pages you return here are passed back to you so you can interrogate them for the user-entered data and use it when creating the default subsystem instance.

Tip: consider extending AbstractSystemNewConnectionWizardPage for your wizard page class.

addCommonRemoteActions

public void addCommonRemoteActions(ISubSystemConfiguration factory,
                                   SystemMenuManager menu,
                                   IStructuredSelection selection,
                                   Shell shell,
                                   String menuGroup,
                                   ISubSystem subsystem)

Returns any framework-supplied actions remote objects that should be contributed to the popup menu for the given selection list. This does nothing if this adapter does not implement ISystemViewRemoteElementAdapter, else it potentially adds menu items for "User Actions" and Compile", for example. It queries the subsystem factory of the selected objects to determine if these actions are appropriate to add.

Parameters:

menu - The menu to contribute actions to

selection - The window's current selection.

shell - of viewer calling this. Most dialogs require a shell.

menuGroup - recommended menu group to add actions to. If added to another group, you must be sure to create that group first.

subsystem - the subsystem of the selection

getFilterPoolActions

public IAction[] getFilterPoolActions(ISubSystemConfiguration factory,
                                      ISystemFilterPool selectedPool,
                                      Shell shell)

Returns a list of actions for the popup menu when user right clicks on a filter pool object within a subsystem of this factory. Only supported by subsystems that support filters.

getFilterPoolReferenceActions

public IAction[] getFilterPoolReferenceActions(ISubSystemConfiguration factory,
                                               ISystemFilterPoolReference selectedPoolReference,
                                               Shell shell)

Returns a list of actions for the popup menu when user right clicks on a filter pool reference object within a subsystem of this factory. Note, these are added to the list returned by getFilterPoolActions().

Only supported by subsystems that support filters.

getFilterActions

public IAction[] getFilterActions(ISubSystemConfiguration factory,
                                  ISystemFilter selectedFilter,
                                  Shell shell)

Returns a list of actions for the popup menu when user right clicks on a filter object.

Only supported and used by subsystems that support filters.

Most actions are handled in this base, except if you have your own action for creating a new nested filter. In this case, override getNewFilterAction()

customizeChangeFilterPropertyPage

public void customizeChangeFilterPropertyPage(ISubSystemConfiguration factory,
                                              SystemChangeFilterPropertyPage page,
                                              ISystemFilter selectedFilter,
                                              Shell shell)

In addition to a change filter action, we now also support the same functionality via a Properties page for filters. When this page is activated, this method is called to enable customization of the page, given the selected filter.

customizeFilterStringPropertyPage

public void customizeFilterStringPropertyPage(ISubSystemConfiguration factory,
                                              SystemFilterStringPropertyPage page,
                                              ISystemFilterString selectedFilterString,
                                              Shell shell)

In addition to a change filter action, we now also support the same functionality via a Properties page for filter strings, in the Team View. When this page is activated, this method is called to enable customization of the page, given the selected filter string.

createFilterByPrompting

public ISystemFilter createFilterByPrompting(ISubSystemConfiguration factory,
                                             ISystemFilterReference referenceToPromptableFilter,
                                             Shell shell)
                                      throws Exception

Prompt the user to create a new filter as a result of the user expanding a promptable filter.

Returns:

the filter created by the user or null if they cancelled the prompting

Throws:

Exception

getFilterReferenceActions

public IAction[] getFilterReferenceActions(ISubSystemConfiguration factory,
                                           ISystemFilterReference selectedFilterRef,
                                           Shell shell)

Returns a list of actions for the popup menu when user right clicks on a filter reference object within a subsystem of this factory. Only supported and used by subsystems that support filters.

Most actions are handled in this base, except if you have your own action for creating a new filter. In this case, override getNewFilterAction() To add additional actions, override #getFilterReferenceActions(ISystemFilterReference, Shell).

Parameters:

selectedFilterRef - the currently selected filter reference

shell - parent shell of viewer where the popup menu is being constructed

getSubSystemActions

public IAction[] getSubSystemActions(ISubSystemConfiguration factory,
                                     ISubSystem selectedSubSystem,
                                     Shell shell)

Returns a list of actions for the popup menu when user right clicks on a subsystem object from this factory.

getServerLauncherForm

public IServerLauncherForm getServerLauncherForm(ISubSystemConfiguration factory,
                                                 Shell shell,
                                                 ISystemMessageLine msgLine)

Return the form used in the property page, etc for this server launcher. Only called if #supportsServerLaunchProperties() returns true.

getSubSystemPropertyPageCoreFrom

public ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom(ISubSystemConfiguration factory,
                                                                             ISystemMessageLine msgLine,
                                                                             Object caller)

getImage

public ImageDescriptor getImage(ISubSystemConfiguration factory)

Return image descriptor for subsystems created by this factory. Comes from icon attribute in extension point xml

getGraphicsImage

public Image getGraphicsImage(ISubSystemConfiguration factory)

Return actual graphics Image of this factory. This is the same as calling getImage().createImage() but the resulting image is cached

getLiveImage

public ImageDescriptor getLiveImage(ISubSystemConfiguration factory)

Return image to use when this susystem is connection. Comes from icon attribute in extension point xml

getGraphicsLiveImage

public Image getGraphicsLiveImage(ISubSystemConfiguration factory)

Return actual graphics LiveImage of this factory. This is the same as calling getLiveImage().createImage() but the resulting image is cached

getSystemFilterPoolManagerImage

public ImageDescriptor getSystemFilterPoolManagerImage()

Supply the image to be used for filter pool managers, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

getSystemFilterPoolImage

public ImageDescriptor getSystemFilterPoolImage(ISystemFilterPool filterPool)

Supply the image to be used for filter pools, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

getSystemFilterImage

public ImageDescriptor getSystemFilterImage(ISystemFilter filter)

Supply the image to be used for filters, within actions. REQUIRED BY SYSTEMFILTERPOOLMANAGERPROVIDER INTERFACE

getSystemFilterStringImage

public ImageDescriptor getSystemFilterStringImage(ISystemFilterString filterString)

getSystemFilterStringImage

public ImageDescriptor getSystemFilterStringImage(String filterStringString)

renameSubSystemProfile

public void renameSubSystemProfile(ISubSystemConfiguration factory,
                                   String oldProfileName,
                                   String newProfileName)

getPropertyPage

public PropertyPage getPropertyPage(ISubSystem subsystem,
                                    Composite parent)

Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection. Return null if no page is to be contributed for this. You are limited to a single page, so you may have to compress. It is recommended you prompt for the port if applicable since the common base subsystem property page is not shown To help with this you can use the SystemPortPrompt widget.

getUserIdValidator

public ISystemValidator getUserIdValidator(ISubSystemConfiguration config)

Return the validator for the userId. A default is supplied. Note this is only used for the subsystem's properties, so will not be used by the connection's default. Thus, is only of limited value.

This must be castable to ICellEditorValidator for the property sheet support.

getPasswordValidator

public ISystemValidator getPasswordValidator(ISubSystemConfiguration confi)

Return the validator for the password which is prompted for at runtime. No default is supplied.

getPortValidator

public ISystemValidator getPortValidator(ISubSystemConfiguration confi)

Return the validator for the port. A default is supplied. This must be castable to ICellEditorValidator for the property sheet support.