Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS DG Constructing a Data Manager"
(→Creating a data manager or MDR project) |
(→Creating a data manager or MDR project) |
||
Line 32: | Line 32: | ||
=== Creating a data manager or MDR project === | === Creating a data manager or MDR project === | ||
− | The COSMOS SDK provides Eclipse-based tooling for creating data manager and MDR projects. These tools make use of capabilities provided by the Eclipse Webtools project to configure your project with the necessary components to deploy your MDR in J2EE. | + | The COSMOS SDK provides Eclipse-based tooling for creating data manager and MDR projects. These tools make use of capabilities provided by the Eclipse Webtools project to configure your project with the necessary components to deploy your MDR in J2EE. When you are finished, the new project will contain new configuration files (<code>config.properties</code> and <code>domainEPR.xml</code>) and stub classes for you to implement, and also the necessary prerequisite .jar libraries in the <code>WebContent/WEB-INF/lib</code> directory. |
To create a new data manager project, complete the following steps: | To create a new data manager project, complete the following steps: |
Revision as of 15:30, 24 March 2008
COSMOS Wiki > COSMOS Document Plan > COSMOS Manual Guide
Contents
- 1 COSMOS Development Guide Constructing a Data Manager
- 2 Outline
- 3 Creating a Data Manager
- 3.1 Preparing the development environment
- 3.2 Creating a data manager or MDR project
- 3.3 Customizing MDR parameters
- 3.4 Providing CMDBf Query Processing Handlers
- 3.5 Providing Custom Capabilities
- 3.6 Writing Client Proxies
- 3.7 Class Diagram
- 3.8 Running the MDR within Eclipse
- 3.9 Deploying the MDR on Tomcat
- 4 Content
COSMOS Development Guide Constructing a Data Manager
Category: Development Guide
Owner | Hubert Leung and David Whiteman |
Bug # | 219141 |
Due dates | Schedule |
Outline
Creating a Data Manager
Preparing the development environment
Installing COSMOS SDK and pre-requisites
For the following instuctions, eclipse-home
refers to the directory where Eclipse is installed (i.e. the parent of the "eclipse" directory).
- Download Webtools 3.0 from http://www.eclipse.org/webtools and unzip into
eclipse-home
. - Download EMF and GEF prerequisites linked from the above Webtools download page, and unzip into
eclipse-home
. - Download SDK zip from the desired stable COSMOS build at http://www.eclipse.org/cosmos, and unzip into
eclipse-home
. - Ensure Tomcat 5.5 or greater is installed, per the instructions in the COSMOS Install Guide.
Creating a data manager or MDR project
The COSMOS SDK provides Eclipse-based tooling for creating data manager and MDR projects. These tools make use of capabilities provided by the Eclipse Webtools project to configure your project with the necessary components to deploy your MDR in J2EE. When you are finished, the new project will contain new configuration files (config.properties
and domainEPR.xml
) and stub classes for you to implement, and also the necessary prerequisite .jar libraries in the WebContent/WEB-INF/lib
directory.
To create a new data manager project, complete the following steps:
- Open the J2EE perspective in Eclipse.
- Select File -> New -> Project... from the Eclipse menu bar. The New Project wizard starts.
- From the New Project wizard, select Web -> Dynamic Web Project and press the Next button. The New Dynamic Web Project wizard starts.
- Follow the project wizard prompts, and set the values as suggested below.
Wizard fields
- Target Runtime
- In the Target Runtime field, select the Apache Tomcat server where you want to deploy the data manager project. If a Tomcat server is not already defined, click New... to select a server runtime environment.
- Configuration
- After you define and select a target runtime for Apache Tomcat, the configuration "Default Configuration for Apache Tomcat v5.5" will be available for selection. Select this configuration and click the Modify... button. The Project Facets dialog will open. Select either "Custom data manager" (to create a data manager) or "Management data repository" (to create an MDR) under the "Systems Management" category and press OK.
- Package name
- On the "Data manager configuration" or "MDR configuration" page, enter the name of the package that will contain the generated class representing the data manager or MDR.
- Generated class name
- Enter the name of the class to be generated that represents the data manager or MDR.
- Resource id
- Enter a unique identifier for the data manager or MDR.
- Display name
- Enter a human readable name for the data manager or MDR. This is the name displayed in the COSMOS Web UI for this data manager or MDR.
- Description
- Enter a description of the data manager or MDR.
- URI
- On the Domain EPR wizard page, enter the URI used for the Endpoint Reference (EPR) used for testing.
- Reference parameters
- Enter any optional reference parameters for the EPR.
- CMDBf services to implement
- If you selected "Management Data Repository" as the Systems Management facet of the project, you can select whether you want to implement just a query service, or both a query and registration service.