org.eclipse.rse.ui.view
Class SubSystemConfigurationAdapter

java.lang.Object
  org.eclipse.rse.ui.view.SubSystemConfigurationAdapter

All Implemented Interfaces:

ISubSystemConfigurationAdapter, ISystemNewFilterActionConfigurator

Direct Known Subclasses:

RemoteFileSubSystemConfigurationAdapter, RemoteProcessSubSystemConfigurationAdapter, ShellServiceSubSystemConfigurationAdapter

public class SubSystemConfigurationAdapter

extends Object

implements ISubSystemConfigurationAdapter, ISystemNewFilterActionConfigurator

Field Summary

protected Hashtable

imageTable

Constructor Summary

SubSystemConfigurationAdapter()

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.
protected Vector	getAdditionalFilterActions(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) Overridable entry for child classes to contribute filter actions beyond the default supplied actions.
protected Vector	getAdditionalFilterPoolActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Overridable entry for child classes to contribute filter pool actions beyond the default supplied actions.
protected Vector	getAdditionalFilterPoolReferenceActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Overridable entry for child classes to contribute filter pool reference actions beyond the default supplied actions.
protected Vector	getAdditionalFilterReferenceActions(ISubSystemConfiguration factory, ISystemFilterReference selectedFilterRef, Shell shell) Overridable entry for child classes to contribute filter reference actions beyond the default supplied actions.
protected Vector	getAdditionalSubSystemActions(ISubSystemConfiguration factory, ISubSystem selectedSubSystem, Shell shell) Overridable entry for child classes to contribute subsystem actions beyond the default supplied actions.
protected IAction	getChangeFilterAction(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) Overridable method to return the action for changing an existing filter.
ISystemFilterPool	getDefaultSystemFilterPool(ISubSystemConfiguration factory, ISystemProfile profile) Given a profile, return the first (hopefully only) default pool for this profile.
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 selectedPoolRef, 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 of 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 Wizard connection if the user selects a system type that this subsystem factory supports.
protected IAction	getNewFilterPoolFilterAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Overridable method to return the single action for creating a new filter in a filter pool.
protected IAction[]	getNewFilterPoolFilterActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Overridable method to return the actions for creating a new filter in a filter pool.
protected SystemFilterPoolWrapperInformation	getNewFilterWizardPoolWrapperInformation() Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for the new filter wizards.
protected IAction	getNewNestedFilterAction(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) Overridable method to return the action for creating a new nested filter inside another filter.
ISystemValidator	getPasswordValidator(ISubSystemConfiguration configuration) Return the validator for the password which is prompted for at runtime.
ISystemValidator	getPortValidator(ISubSystemConfiguration configuration) 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.
protected IAction	getRemoveFilterPoolReferenceAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) Overridable method to return the action for removing a filter pool reference.
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.
protected IAction[]	getSubSystemNewFilterPoolActions(ISubSystemConfiguration factory, ISubSystem selectedSubSystem, Shell shell) Overridable entry for child classes to supply their own "new" action(s) for creating a filter pool.
ISystemSubSystemPropertyPageCoreForm	getSubSystemPropertyPageCoreFrom(ISubSystemConfiguration factory, ISystemMessageLine msgLine, Object caller)
protected List	getSubSystemPropertyPages(ISubSystemConfiguration factory) Gets the list of property pages applicable for a subsystem associated with this factory
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) Called by SystemRegistry's renameSystemProfile method to ensure we update our filter pool manager names (and their folders) Must be called AFTER changing the profile's name!!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

imageTable

protected Hashtable imageTable

Constructor Detail

SubSystemConfigurationAdapter

public SubSystemConfigurationAdapter()

Method Detail

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 ISystemRemoteElementAdapter, 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.

No need to override.

Specified by:

addCommonRemoteActions in interface ISubSystemConfigurationAdapter

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

getNewConnectionWizardPages

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

Optionally return one or more wizard pages to append to the New Wizard connection 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(org.eclipse.rse.model.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.

Specified by:

getNewConnectionWizardPages in interface ISubSystemConfigurationAdapter

getSubSystemPropertyPageCoreFrom

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

Specified by:

getSubSystemPropertyPageCoreFrom in interface ISubSystemConfigurationAdapter

getSubSystemPropertyPages

protected List getSubSystemPropertyPages(ISubSystemConfiguration factory)

Gets the list of property pages applicable for a subsystem associated with this factory

Returns:

the list of subsystem property pages

getImage

public ImageDescriptor getImage(ISubSystemConfiguration factory)

Return image descriptor of this factory. This comes from the xml "icon" attribute of the extension point.

Specified by:

getImage in interface ISubSystemConfigurationAdapter

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.

Specified by:

getGraphicsImage in interface ISubSystemConfigurationAdapter

getLiveImage

public ImageDescriptor getLiveImage(ISubSystemConfiguration factory)

Return image to use when this susystem is connection. This comes from the xml "iconlive" attribute of the extension point.

Specified by:

getLiveImage in interface ISubSystemConfigurationAdapter

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.

Specified by:

getGraphicsLiveImage in interface ISubSystemConfigurationAdapter

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. By default returns a single item array with a SystemNewFilterPoolAction object and calls overridable method getAdditionalSubSystemActions.

If you wish to support more actions, override getAdditionalSubSystemActions to return a Vector of IAction objects.

Specified by:

getSubSystemActions in interface ISubSystemConfigurationAdapter

Parameters:

selectedSubSystem - the currently selected subsystem

shell - The Shell of the view where this action was launched from

Returns:

array of IAction objects to contribute to the popup menu

See Also:

#getSubSystemNewFilterPoolActions(ISubSystem, Shell), #getAdditionalSubSystemActions(ISubSystem, Shell)

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

Specified by:

configureNewFilterAction in interface ISubSystemConfigurationAdapter

getDefaultSystemFilterPool

public ISystemFilterPool getDefaultSystemFilterPool(ISubSystemConfiguration factory,
                                                    ISystemProfile profile)

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

getNewFilterWizardPoolWrapperInformation

protected SystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation()

Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for the new filter wizards.

getSubSystemNewFilterPoolActions

protected IAction[] getSubSystemNewFilterPoolActions(ISubSystemConfiguration factory,
                                                     ISubSystem selectedSubSystem,
                                                     Shell shell)

Overridable entry for child classes to supply their own "new" action(s) for creating a filter pool. By default, this creates an action for creating a new filter pool and a new filter pool reference.

Parameters:

selectedSubSystem - the currently selected subsystem

shell - The Shell of the view where this action was launched from

Returns:

array of IAction objects to contribute to the popup menu

getAdditionalSubSystemActions

protected Vector getAdditionalSubSystemActions(ISubSystemConfiguration factory,
                                               ISubSystem selectedSubSystem,
                                               Shell shell)

Overridable entry for child classes to contribute subsystem actions beyond the default supplied actions.

By default, returns null.

Returns:

Vector of IAction objects.

See Also:

#getSubSystemActions(ISubSystem,Shell)

getSystemFilterPoolManagerImage

public ImageDescriptor getSystemFilterPoolManagerImage()

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

Specified by:

getSystemFilterPoolManagerImage in interface ISubSystemConfigurationAdapter

getSystemFilterPoolImage

public ImageDescriptor getSystemFilterPoolImage(ISystemFilterPool filterPool)

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

Specified by:

getSystemFilterPoolImage in interface ISubSystemConfigurationAdapter

getSystemFilterImage

public ImageDescriptor getSystemFilterImage(ISystemFilter filter)

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

Specified by:

getSystemFilterImage in interface ISubSystemConfigurationAdapter

getSystemFilterStringImage

public ImageDescriptor getSystemFilterStringImage(ISystemFilterString filterString)

Specified by:

getSystemFilterStringImage in interface ISubSystemConfigurationAdapter

getSystemFilterStringImage

public ImageDescriptor getSystemFilterStringImage(String filterStringString)

Specified by:

getSystemFilterStringImage in interface ISubSystemConfigurationAdapter

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 and used by subsystems that support filters.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

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 #getAdditionalFilterPoolActions(ISystemFilterPool selectedPool, Shell shell).

Specified by:

getFilterPoolActions in interface ISubSystemConfigurationAdapter

Parameters:

selectedPool - the currently selected pool

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

getAdditionalFilterPoolActions

protected Vector getAdditionalFilterPoolActions(ISubSystemConfiguration factory,
                                                ISystemFilterPool selectedPool,
                                                Shell shell)

Overridable entry for child classes to contribute filter pool actions beyond the default supplied actions.

By default, this returns null.

Parameters:

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

Returns:

Vector of IAction objects.

See Also:

#getFilterPoolActions(ISystemFilterPool,Shell)

getNewFilterPoolFilterActions

protected IAction[] getNewFilterPoolFilterActions(ISubSystemConfiguration factory,
                                                  ISystemFilterPool selectedPool,
                                                  Shell shell)

Overridable method to return the actions for creating a new filter in a filter pool. By default returns one action created by calling #getNewFilterPoolFilterAction(ISystemFilterPool, Shell).

If you have multiple actions for creating new filters, override this.

If you have only a single action for creating new filters, override getNewFilterPoolFilterAction (without the 's').

Parameters:

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

getNewFilterPoolFilterAction

protected IAction getNewFilterPoolFilterAction(ISubSystemConfiguration factory,
                                               ISystemFilterPool selectedPool,
                                               Shell shell)

Overridable method to return the single action for creating a new filter in a filter pool. By default returns a default supplied action for this.

If you have multiple actions for creating new filters, override getNewFilterPoolFilterActions (note the 's').

If you have only a single action for creating new filters, override this.

Parameters:

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

getNewNestedFilterAction

protected IAction getNewNestedFilterAction(ISubSystemConfiguration factory,
                                           ISystemFilter selectedFilter,
                                           Shell shell)

Overridable method to return the action for creating a new nested filter inside another filter. By default returns getNewFilterPoolFilterAction(selectedFilter.getParentFilterPool(),shell).

Parameters:

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

getChangeFilterAction

protected IAction getChangeFilterAction(ISubSystemConfiguration factory,
                                        ISystemFilter selectedFilter,
                                        Shell shell)

Overridable method to return the action for changing an existing filter. By default returns new SystemChangeFilterAction, unless the filter's isSingleFilterStringOnly() returns true, in which case null is returned.

Parameters:

selectedFilter - the currently selected filter

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

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.

By default, this method will call #getChangeFilterAction(ISystemFilter, Shell) to get your change filter action, and will configure the given page from the dialog created by your change filter action.

If your filter uses its own Change Filter dialog, versus subclassing or configuring SystemChangeFilterDialog you will have to override this method and specify the following information for the supplied page (via its setters):

• SystemChangeFilterPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
• SystemChangeFilterPropertyPage.setFilterStringEditPane(org.eclipse.rse.ui.filters.SystemFilterStringEditPane)
• SystemChangeFilterPropertyPage.setFilterStringValidator(org.eclipse.rse.ui.validators.ISystemValidator)
• SystemChangeFilterPropertyPage.setListLabel(String, String)
• SystemChangeFilterPropertyPage.setParentPoolPromptLabel(String, String)
• SystemChangeFilterPropertyPage.setNamePromptLabel(String, String)
• SystemChangeFilterPropertyPage.setNewListItemText(String)
• SystemChangeFilterPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
• SystemChangeFilterPropertyPage.setEditable(boolean)
• SystemChangeFilterPropertyPage.setSupportsMultipleStrings(boolean)
• DialogPage.setDescription(String)

Specified by:

customizeChangeFilterPropertyPage in interface ISubSystemConfigurationAdapter

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.

By default, this method will call #getChangeFilterAction(ISystemFilter, Shell) to get your change filter action, and will configure the given page from the dialog created by your change filter action.

If your filter uses its own Change Filter dialog, versus subclassing or configuring SystemChangeFilterDialog you will have to override this method and specify the following information for the supplied page (via its setters):

• SystemFilterStringPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
• SystemFilterStringPropertyPage.setFilterStringEditPane(org.eclipse.rse.ui.filters.SystemFilterStringEditPane)
• SystemFilterStringPropertyPage.setFilterStringValidator(org.eclipse.rse.ui.validators.ISystemValidator)
• SystemFilterStringPropertyPage.setDuplicateFilterStringErrorMessage(org.eclipse.rse.services.clientserver.messages.SystemMessage)
• SystemFilterStringPropertyPage.setEditable(boolean)
• DialogPage.setDescription(String)

Specified by:

customizeFilterStringPropertyPage in interface ISubSystemConfigurationAdapter

getFilterPoolReferenceActions

public IAction[] getFilterPoolReferenceActions(ISubSystemConfiguration factory,
                                               ISystemFilterPoolReference selectedPoolRef,
                                               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.

Specified by:

getFilterPoolReferenceActions in interface ISubSystemConfigurationAdapter

Parameters:

selectedPoolRef - the currently selected pool reference

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

getAdditionalFilterPoolReferenceActions

protected Vector getAdditionalFilterPoolReferenceActions(ISubSystemConfiguration factory,
                                                         ISystemFilterPool selectedPool,
                                                         Shell shell)

Overridable entry for child classes to contribute filter pool reference actions beyond the default supplied actions.

By default, this returns null.

Parameters:

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

Returns:

Vector of IAction objects.

See Also:

#getFilterPoolReferenceActions(ISystemFilterPoolReference,Shell)

getRemoveFilterPoolReferenceAction

protected IAction getRemoveFilterPoolReferenceAction(ISubSystemConfiguration factory,
                                                     ISystemFilterPool selectedPool,
                                                     Shell shell)

Overridable method to return the action for removing a filter pool reference. By default returns new SystemRemoveFilterPoolReferenceAction.

Parameters:

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

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.

This base implementation prompts using the generic filter prompt. You should override this but copy this code to use as a base/example how to do this.

Specified by:

createFilterByPrompting in interface ISubSystemConfigurationAdapter

Returns:

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

Throws:

Exception

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.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

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()

Specified by:

getFilterActions in interface ISubSystemConfigurationAdapter

getAdditionalFilterActions

protected Vector getAdditionalFilterActions(ISubSystemConfiguration factory,
                                            ISystemFilter selectedFilter,
                                            Shell shell)

Overridable entry for child classes to contribute filter actions beyond the default supplied actions.

By default, this returns null.

Returns:

Vector of IAction objects.

See Also:

#getFilterActions(ISystemFilter,Shell)

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.

YOU DO NOT NEED TO OVERRIDE THIS METHOD.

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 #getAdditionalFilterReferenceActions(ISystemFilterReference, Shell).

Specified by:

getFilterReferenceActions in interface ISubSystemConfigurationAdapter

Parameters:

selectedFilterRef - the currently selected filter reference

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

getAdditionalFilterReferenceActions

protected Vector getAdditionalFilterReferenceActions(ISubSystemConfiguration factory,
                                                     ISystemFilterReference selectedFilterRef,
                                                     Shell shell)

Overridable entry for child classes to contribute filter reference actions beyond the default supplied actions.

By default, this returns null.

Parameters:

selectedFilterRef - the currently selected filter reference

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

Returns:

Vector of IAction objects.

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.

We return org.eclipse.rse.ui.widgets.ServerLauncherForm. Override if appropriate.

Specified by:

getServerLauncherForm in interface ISubSystemConfigurationAdapter

renameSubSystemProfile

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

Called by SystemRegistry's renameSystemProfile method to ensure we update our filter pool manager names (and their folders)

Must be called AFTER changing the profile's name!!

Specified by:

renameSubSystemProfile in interface ISubSystemConfigurationAdapter

getPasswordValidator

public ISystemValidator getPasswordValidator(ISubSystemConfiguration configuration)

Return the validator for the password which is prompted for at runtime. Returns null by default.

Specified by:

getPasswordValidator in interface ISubSystemConfigurationAdapter

getPortValidator

public ISystemValidator getPortValidator(ISubSystemConfiguration configuration)

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

Specified by:

getPortValidator in interface ISubSystemConfigurationAdapter

getPropertyPage

public PropertyPage getPropertyPage(ISubSystem subsystem,
                                    Composite parent)

Description copied from interface: ISubSystemConfigurationAdapter

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.

Specified by:

getPropertyPage in interface ISubSystemConfigurationAdapter

getUserIdValidator

public ISystemValidator getUserIdValidator(ISubSystemConfiguration config)

Description copied from interface: ISubSystemConfigurationAdapter

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.

Specified by:

getUserIdValidator in interface ISubSystemConfigurationAdapter