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 "COSMOS Design 273069"
(New page: = Provide CLI for runtime= This is the design document for [http://bugs.eclipse.org/260725 bugzilla 273069]. = Change History = {|{{BMTableStyle}} !align="left"|Name: !align="left"|Date:...) |
|||
| Line 1: | Line 1: | ||
| − | = | + | = Implement CLI for interacting w/ SDD runtime = |
This is the design document for [http://bugs.eclipse.org/260725 bugzilla 273069]. | This is the design document for [http://bugs.eclipse.org/260725 bugzilla 273069]. | ||
| Line 59: | Line 59: | ||
=Requirements= | =Requirements= | ||
| − | * | + | * The CLI bundle must implement an IAdvisor interface. |
| − | ** | + | ** The IAdvisor class is an interface that the Orchestrator uses to identify bundles that need to implement an interface such as a graphical or command line interface. |
| − | * The | + | * The CLI advisor will be capable of getting ParameterType objects as defined by the SDD in order to represent this data to the user. |
| − | + | * The CLI advisor will be able to prompt for the information as requested by a ParameterType object. | |
| − | + | * The CLI advisor must accept user input from the command line. | |
| − | + | * The CLI advisor must provide means of getting the user data. | |
| − | + | * The CLI advisor must provide a means to accept asynchronous data from the operation handler interfaces to provide feedback of the operation being run. | |
| − | + | ||
=Design details= | =Design details= | ||
| Line 74: | Line 73: | ||
===Known Limitations=== | ===Known Limitations=== | ||
| − | * | + | * The first phase of implementation will focus on integrating the CLI into the Orchestrator through method calls in an attempt to flesh out the CLI methods and functions. |
| + | * The second phase of implementtion will introduce the concepts of an event bus or listener model that will allow the Orchestrator and the Advisor interfaces to be married in a more dynamic approach. | ||
=Impacts of this enhancement= | =Impacts of this enhancement= | ||
| − | * The SDD runtime will be able to interact with defined | + | * The SDD runtime will be able to interact with the user via the CLI interface for ParameterType information as defined by the SDD. In response to the user, the runtime will perform resolution with the provided data in order to successfully resolve and operate on a SDD succcessfully. Also, feedback of the resolution and the operation(s) that are performed will be provided to the CLI. |
| − | + | ||
=Open Issues/Questions= | =Open Issues/Questions= | ||
Revision as of 12:59, 27 April 2009
Contents
Implement CLI for interacting w/ SDD runtime
This is the design document for bugzilla 273069.
Change History
| Name: | Date: | Revised Sections: |
|---|---|---|
| Jeff Hamm | April 27, 2009 |
|
Workload Estimation
| Process | Sizing | Names of people doing the work |
|---|---|---|
| Design | 1 | Jeff Hamm |
| Code | 2 | Jeff Hamm, Josh Hester |
| Test | 3 | Jeff Hamm, Josh Hester |
| Documentation | 0 | |
| Build and infrastructure | 0 | |
| Code review, etc.* | 1 | |
| TOTAL | 7 |
'* - includes other committer work (e.g. check-in, contribution tracking)
Purpose
This enhancement will provide a basic command line interface for interacting with resolved SDD parameters.
Requirements
- The CLI bundle must implement an IAdvisor interface.
- The IAdvisor class is an interface that the Orchestrator uses to identify bundles that need to implement an interface such as a graphical or command line interface.
- The CLI advisor will be capable of getting ParameterType objects as defined by the SDD in order to represent this data to the user.
- The CLI advisor will be able to prompt for the information as requested by a ParameterType object.
- The CLI advisor must accept user input from the command line.
- The CLI advisor must provide means of getting the user data.
- The CLI advisor must provide a means to accept asynchronous data from the operation handler interfaces to provide feedback of the operation being run.
Design details
- "FileSystemResolver" will take the file system properties defined in the SDD and see if the conditions that are required can be satisfied.
- This resolver will use other defined resources in topology of the SDD to validate the existance.
- Resolution of file system properties often will require other resources in topology to be resolved.
Known Limitations
- The first phase of implementation will focus on integrating the CLI into the Orchestrator through method calls in an attempt to flesh out the CLI methods and functions.
- The second phase of implementtion will introduce the concepts of an event bus or listener model that will allow the Orchestrator and the Advisor interfaces to be married in a more dynamic approach.
Impacts of this enhancement
- The SDD runtime will be able to interact with the user via the CLI interface for ParameterType information as defined by the SDD. In response to the user, the runtime will perform resolution with the provided data in order to successfully resolve and operate on a SDD succcessfully. Also, feedback of the resolution and the operation(s) that are performed will be provided to the CLI.