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.
CosmosResourceModelingComponent
Contents
Resource Modeling
Note: this content is mostly deprecated, but gives some insight to the original intent of the Resource Modeling component. This material should be rewritten to provide a new overview of the component, and should be linked from the www.eclipse.org/cosmos.
For more documents on the Resource Modeling component, see the category linked at the bottom.
Next Meeting
Friday 4/26/07 @ 2 pm EST. Call in:
US/Canada: +1.866.432.9903 United Kingdom: +44.20.8824.0117 India: +91.80.4103.3979 Germany: +49.619.6773.9002 Japan: +81.3.5763.9394 China: +86.10.8515.5666
Meeting ID: 2212212
If we need web conferencing: http://meetingplace.cisco.com/join.asp?22122121
Scope and Mission
In most tools that monitor resources there is an awareness of some of the more static features of a resource; for example the physical location and the IP address, in addition to the actual data being extracted from the resource is often known. Yet each tool has its own representation of this information. With the growing presence of distributed and componentized applications this information also includes the overall topology of the application. This is redundant information between the tool used to debug a performance bottleneck and the tool that is used to deploy components of the application, or the tool that is doing load testing and monitoring of the application. The Resource Modeling sub project goal is to address this redundancy by helping to build a canonical representation of these resources.
The COSMOS Resource Modeling sub-project aims to provide support for building a common model to represent the information being shared in a system management scenario. The project is proposing to use SML as the xml schema language to define this common model. The SML-IF interchange format will be used to share model components between the tools involved in a system management activity.
To that extent, the COSMOS Resource Modeling sub-project is focused on the following deliverables:
- Tooling for validating SML instances and SML-IF documents
- Tooling for importing/exporting SML-IF documents to and from predefined repositories.
- Tooling for creating SML template documents
- Tooling for creating domain models based on existing SML templates
For information regarding SML look here.
Integration with other Eclipse projects
The Resource Modeling workgroup is proposing to investigate which Eclipse projects are offering XML editors or schema validation and work together to create a common scenario to make Cosmos and these projects interact and complement each other.
WTP has been identified as one of the projects offering xml schema and instance validation. The action is available for any document with the extension XML and XSD (right click and select Run Validate or Validation XML File action). A good usability scenario would require extending these actions with SML extra validation and not providing new validate actions on an xml or xsd resource. Since this may require working with the WTP team to define a common scenario and the set of extensions required to hook in SML validation, this may not be a viable delivery for the first release of Cosmos. This should not stop us from starting the collaboration with WTP (and any other projects) with the goal of identifying required API and extension points for making this happen.
Project Deliverables
Tooling for validating SML instances and SML-IF documents
- Target date for this item: March 07.
The validator should be fully functional by the end of the COSMOS 1.0 , June 07
- Provide a common interface for handling and reporting errors
- SML validation
- Provide a common interface for handling and reporting errors
- A default implementation for the XML validation phase
- A default implementation for the SML extension validation phase
- A default implementation for the Schematron validation phase, which will include displaying results to a predefined output based on report/assertion conditions
- Create a default validation scheme for the SML extensions: sml:acyclic, sml:targetElement, sml:targetType, sml:key, sml:unique, and sml:keyref
- SML-IF validation
- A default implementation for the XML validation phase
- A default implementation for the Schematron validation phase in the context of an SML-IF document; includes displaying results to a predefined output based on report/assertion conditions
- Apply the SML validation extension in the context of an SML-IF document: sml:acyclic, sml:targetElement, sml:targetType, sml:key, sml:unique, and sml:keyref
- An implementation of RFC 3986 to resolve inter-document references within an SML-IF document
- Verify that the SML and SML-IF validation implementations cover the test cases of the SML workshop scenario
Tooling for importing/exporting SML-IF documents to and from predefined repositories
- Target date for this item : March 07
An SML-IF document can be formed from a project by selecting export from the context menu of one or more resource that appears under a project. The operation will determine the genic or phenic documents based on a registered content type that describes each type of the document. The user will have the option of changing the document type (i.e. genic/phenic) if a unit’s type is incorrectly assigned. The export operation will be integrated with Eclipse’s export wizard under the category: “Service Model Language”.
The user can also import an SML-IF model into its units using the import operation. The import operation will simply divide up an SML-IF document into individual genic and phenic documents and store them in a desired target folder. The import operation will be integrated with Eclipse’s import wizard under the category: “Service Model Language”.
Ideally an import operation followed by an export operation should generate a file that is semantically equivalent to the original file imported. Unfortunately there is some loss of data when an SML-IF document is broken into its respective SML model units. For example, the aliases associated with a document or schematron rule bindings are not preserved in SML model units. To preserve this information, a meta-data file is generated with every SML-IF document import. Using the meta-data, the user can perform an export operation that will result in a file that is semantically equivalent to the original SML-IF document imported. Validation can be done at a project, folder, or a unit level. To validate an entire model the user can select validate from the context menu of a project. Alternatively the user can validate a subset of the model by selecting validate from the context menu of a parent folder or a set of model units.
A more detailed document describing import and export implementation and extension points is attached below. http://wiki.eclipse.org/images/a/ae/SML-Validation-v7.pdf
Tooling for creating SML template documents
- Target date for this item: post June 07
An SML template document is an SML instance defining a common pattern that can be re-used and adapted in different domain models.
The project is proposing to offer an extendable tool which allows users to easily create SML templates. The tool will be based on GEF and will provide drag and drop capabilities for creating templates.
Tooling for creating domain models based on existing SML templates
- Target date for this item: post June 07
The project is proposing to offer an extendable tool which allows users to easily create SML instances based on SML templates. The tool will be based on GEF and will provide drag and drop capabilities for building the instances. The SML instances will be possibly created using SML templates, built using the SML templates builder.
The tool should be extendable to allow registration of third parties SML templates.
Open Issues
The SML, SML-IF standards are in an emerging phase so they are not completely defined yet. This will require for the Resource Modeling sub-project, as well as the COSMOS project as a whole, to continue synchronizing with the latest specifications. For example, the SML and SMLIF validators will need to be updated as soon as the specification changes.
Useful links
SML and SMLIF specifications
SMLIF validation design document
The following attached document describes the validation of SML/SML-IF documents. It also includes description of embedded editors in Eclipse
Link to a detailed overview of the SML validation implementation
Download page
You can download the SML validator and the SMLIF editor from this link