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 SDD Tooling Examples"
(→Creating SDDs) |
(→Creating SDDs) |
||
| Line 9: | Line 9: | ||
The SPI is controlled through one instance of a session. In order to use any methods in the SPI, a session must first be created. | The SPI is controlled through one instance of a session. In order to use any methods in the SPI, a session must first be created. | ||
| − | <code><pre>SPISession | + | <code><pre>SPISession session = SPISession.DEFAULT_INSTANCE;</pre></code> |
| − | BaseFactory baseFactory = | + | |
| + | The SPI objects for the most part correspond to the SDD types. These objects are created from factory objects, so let's create these first. | ||
| + | |||
| + | <code><pre>BaseFactory baseFactory = session.createBaseFactory(); | ||
| + | ContentUnitFactory cuFactory = session.createContentUnitFactory(); | ||
| + | ArtifactFactory artifactFactory = session.createArtifactFactory();</pre></code> | ||
| + | |||
| + | Each package of the SPI APIs have a factory class. To create an SPI object, all required elements and attributes of the SPI object must be passed into the factory method. This means we'll be creating our deployment descriptor close to the end. Let's create our install artifact first. | ||
| + | |||
| + | <code><pre>Artifact install = artifactFactory.createInstallArtifact(); | ||
| + | install.setContentReference("installArtifact"); | ||
| + | install.setResourceReference("artifact_Resource_Ref");</pre></code> | ||
Revision as of 17:43, 3 October 2008
This page contains examples of how to use various functions of the SDD tooling. Please use these examples as references as you create your own applications.
SDD Programmatic Interface
The SPI is used to read and write SDDs with a Java interface. These examples will take the reader through reading, writing, and creating SDDs.
Creating SDDs
The SPI is controlled through one instance of a session. In order to use any methods in the SPI, a session must first be created.
SPISession session = SPISession.DEFAULT_INSTANCE;
The SPI objects for the most part correspond to the SDD types. These objects are created from factory objects, so let's create these first.
BaseFactory baseFactory = session.createBaseFactory();
ContentUnitFactory cuFactory = session.createContentUnitFactory();
ArtifactFactory artifactFactory = session.createArtifactFactory();
Each package of the SPI APIs have a factory class. To create an SPI object, all required elements and attributes of the SPI object must be passed into the factory method. This means we'll be creating our deployment descriptor close to the end. Let's create our install artifact first.
Artifact install = artifactFactory.createInstallArtifact();
install.setContentReference("installArtifact");
install.setResourceReference("artifact_Resource_Ref");