Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "PTP/designs/rm extensions"

< PTP‎ | designs
(Resource Manager Selection)
(Resource Manager Selection)
Line 3: Line 3:
 
== Resource Manager Selection ==
 
== Resource Manager Selection ==
  
* Add "Select Resource Manager" to current context menu
+
* Add "Select Resource Manager" to current context menu if RM is running
 
* The selected resource manager will be annotated in view
 
* The selected resource manager will be annotated in view
 
* RM selection listeners will be notified when an RM is selected
 
* 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
 
* The method getSelected() will return null if no RM selected, otherwise will return selected RM
 
* Default is no RM selected
 
* 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 ===
 
=== Interfaces ===
  
; <code>IResourceManager getSelected()</code> : Return the currently selected RM, or null if no RM is selected
+
RM selection interfaces are accessed from the PTPUIPlugin class by retrieving the RMManager: <code>PTPUIPlugin.getDefault().getRMManager()</code>
; <code>void addSelectionListener(SelectionListener listener)</code> : Add a listener that will be notified when an RM is selected
+
 
 +
; <code>IResourceManager getSelectedRM()</code> : Return the currently selected RM, or null if no RM is selected
 +
; <code>void addRMSelectionListener(IRMSelectionListener listener)</code> : Add 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
  
 
== Wizard Extension ==
 
== Wizard Extension ==

Revision as of 09:39, 4 June 2009

The following sections detail some additional resource manager functionality that will be included in the 3.0 release of PTP.

Resource Manager Selection

  • Add "Select Resource Manager" to current context menu 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.getDefault().getRMManager()

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

Wizard Extension

  • A new extension point will be added to allow tool-specific wizard pages to be added to the RM configuration wizard
  • Multiple extensions are allowed
  • If one extension is available, the new page will be displayed just prior to the final wizard page
  • If more than one extensions is available, a page showing a list of the available extensions will be displayed.
    • Users will be able to individually select and configure the extensions
  • Extensions will be able to contribute persistent information to the RM configuration
  • RM configuration information, including the extension information, will be able to be queried

Back to the top