Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PTP/designs/rm extensions"
(→Resource Manager Selection) |
|||
Line 28: | Line 28: | ||
; <code>void removeRMSelectionListener(IRMSelectionListener listener)</code> : Remove a listener that will be notified when an RM is selected | ; <code>void removeRMSelectionListener(IRMSelectionListener listener)</code> : Remove a listener that will be notified when an RM is selected | ||
− | == | + | == Extension Point Changes == |
− | * A new extension point | + | === New Extension Point === |
+ | |||
+ | * A new extension point <code>rmConfigurationWizardExtensions</code> has been added to allow tool-specific wizard pages to be added to RM configuration wizards | ||
* Multiple extensions are allowed | * Multiple extensions are allowed | ||
− | * | + | * Each extension specifies: |
− | * If | + | ** The ID of an <code>rmConfigurationWizards</code> that will be extended |
+ | ** A class that extends <code>RMConfigurationExtensionWizardPageFactory</code> to supply new wizard pages | ||
+ | * If an extension is available, a page showing a list of the available extensions will be displayed prior to the final wizard page. | ||
** Users will be able to individually select and configure the extensions | ** Users will be able to individually select and configure the extensions | ||
− | * Extensions will be | + | |
− | + | === Existing Extension Point Changes === | |
+ | |||
+ | * The <code>rmConfigurations</code> extension point has been renamed <code>rmConfigurationWizards</code>. | ||
+ | * The <code>name</code> attribute has been removed as it was not being used. | ||
+ | |||
+ | == Resource Manager Configuration Extensions == | ||
+ | |||
+ | * The <code>IResourceManagerConfiguration</code> interface will be extended to provide persistent attribute information: | ||
+ | |||
+ | ;<code>void put(String key, String value)</code> : save the (key, value) pair in the resource manager configuration | ||
+ | ;<code>String get(String key)</code> : retrieve the value associated with the key from the resource manager configuration |
Revision as of 17:58, 5 June 2009
The following sections detail some additional resource manager functionality that will be included in the 3.0 release of PTP.
Contents
Default Resource Manager Selection
- Adds "Select Default Resource Manager" to current context menu (enabled if RM is running)
- The selected resource manager will be annotated in view
- RM selection listeners will be notified when an RM is selected
- The method getSelected() will return null if no RM selected, otherwise will return selected RM
- Default is no RM selected
- Stopping a selected resource manager will fire selection event (with null presumably) and return to the default
- The selected resource manager will be persisted. When the resource manager is restarted:
- It will be selected provided no other RM has been selected
- The selection even will fire
- If the RM fails to start due to an error, it will still remain the selected RM
Interfaces
RM selection interfaces are accessed from the PTPUIPlugin
class by retrieving the RMManager
.
PTPUIPlugin Class
public RMManager getRMManager()
- Retrieve the
RMManager
class
RMManager Class
-
IResourceManager getSelected()
- Return the currently selected RM, or null if no RM is selected
-
void addRMSelectionListener(IRMSelectionListener listener)
- Add a listener that will be notified when an RM is selected
-
void removeRMSelectionListener(IRMSelectionListener listener)
- Remove a listener that will be notified when an RM is selected
Extension Point Changes
New Extension Point
- A new extension point
rmConfigurationWizardExtensions
has been added to allow tool-specific wizard pages to be added to RM configuration wizards - Multiple extensions are allowed
- Each extension specifies:
- The ID of an
rmConfigurationWizards
that will be extended - A class that extends
RMConfigurationExtensionWizardPageFactory
to supply new wizard pages
- The ID of an
- If an extension is available, a page showing a list of the available extensions will be displayed prior to the final wizard page.
- Users will be able to individually select and configure the extensions
Existing Extension Point Changes
- The
rmConfigurations
extension point has been renamedrmConfigurationWizards
. - The
name
attribute has been removed as it was not being used.
Resource Manager Configuration Extensions
- The
IResourceManagerConfiguration
interface will be extended to provide persistent attribute information:
void put(String key, String value)
- save the (key, value) pair in the resource manager configuration
String get(String key)
- retrieve the value associated with the key from the resource manager configuration