Setup Resources

 

All the information for managing the automated installation and provisioning is maintained in resources. Because Oomph is modeled using EMF, these resources are stored in XMI format, for example, The index resource is serialized as follows:

org.eclipse.setup      
<?xml version="1.0" encoding="UTF-8"?>
<setup:Index
    xmi:version=
"2.0"
    xmlns:xmi=
"http://www.omg.org/XMI"
    xmlns:setup=
"http://www.eclipse.org/oomph/setup/1.0"
    name=
"index"
    label=
"Index">
  
<discoverablePackage
      href=
"models/Git.ecore#/"/>
  
<discoverablePackage
      href=
"models/Launching.ecore#/"/>
  
<discoverablePackage
      href=
"models/JDT.ecore#/"/>
  
<discoverablePackage
      href=
"models/Maven.ecore#/"/>
  
<discoverablePackage
      href=
"models/Mylyn.ecore#/"/>
  
<discoverablePackage
      href=
"models/PDE.ecore#/"/>
  
<discoverablePackage
      href=
"models/Predicates.ecore#/"/>
  
<discoverablePackage
      href=
"models/Projects.ecore#/"/>
  
<discoverablePackage
      href=
"models/ProjectSet.ecore#/"/>
  
<discoverablePackage
      href=
"models/Resources.ecore#/"/>
  
<discoverablePackage
      href=
"models/SetupTarglets.ecore#/"/>
  
<discoverablePackage
      href=
"models/SetupWorkingSets.ecore#/"/>
  
<discoverablePackage
      href=
"models/Targlets.ecore#/"/>
  
<discoverablePackage
      href=
"models/Workbench.ecore#/"/>
  
<discoverablePackage
      href=
"models/WorkingSets.ecore#/"/>
  
<productCatalog
      href=
"catalog:/self-product-catalog.setup#/"/>
  
<productCatalog
      href=
"org.eclipse.products.setup#/"/>
  
<projectCatalog
      href=
"org.eclipse.projects.setup#/"/>
  
<projectCatalog
      href=
"com.github.projects.setup#/"/>
</setup:Index>

1  Index

The index:/org.eclipse.setup resource maintains the index, where index:/ is redirected to http://git.eclipse.org/c/oomph/org.eclipse.oomph.git/plain/setups/. It generally consists of references to product catalog resources and project catalog resources.

org.eclipse.setup      

Properties      
Discoverable Packages
 git, launching, jdt, maven, mylyn, pde, predicates, projects, projectset, resources, targlets, workingsets, targlets, workbench, workingsets

1.1  Product Catalogs

A product catalog resource maintains a product catalog. For example, the Eclipse Products Catalog resource contains all the products available at Eclipse, i.e., the equivalents of downloading and installing Eclipse packages. Each product catalog resource is generally assumed to contain a self product catalog so that any product with Oomph installed, but not installed by Oomph, will behave consistently as if it where installed by Oomph, in particular, a installation resource will be demand created to refer to the self product version. The logical URI for this resource is catalog:/self-product-catalog.setup. It does not correspond to any physical artifact located in the file system.

1.2  Project Catalogs

A project catalog resource maintains a project catalog. It generally contains references to various separately-maintained project resources. For example, the Eclipse Projects Catalog resource references all the Oomph-enabled Eclipse projects and the Github Projects Catalog resource references all the Oomph-enabled Github projects. Each project catalog resource is generally assumed to maintain a so called <User> project resource. For example, the Eclipse Projects Catalog contains a reference to user:/org.eclipse.projects.setup where user:/ is redirected to ~/.eclipse/org.eclipse.oomph.setup/setups/. Projects can be added to or removed from this resource using the project page. This feature allows a developer to author her own setup project and to logically add it to an existing read-only project catalog without modifying that project catalog.

1.2.1  Project Resources

A project resource maintains a project. Project resources are generally hosted on the Internet or on the local file system. For example the Oomph.setup resource contains the streams and tasks for the Oomph project itself.

2  Location Catalog

The location resource maintains the location catalog. The logical URI for this resource is user:/locations.setup where user:/ is redirected to ~/.eclipse/org.eclipse.oomph.setup/setups/.

3  Catalog Selection

The catalog selection resource maintains the catalog selection. The logical URI for this resource is user:/catalogs.setup where user:/ is redirected to ~/.eclipse/org.eclipse.oomph.setup/setups/.

4  Installation

An installation resource maintains an installation. The physical URI of this resource is org.eclipse.oomph.setup/installation.setup relatively within the configuration folder of the installed product.

5  Workspace

An workspace resource maintains a workspace. The physical URI of this resource is .metadata/.plugins/org.eclipse.oomph.setup/workspace.setup relatively within the running product's phyiscal workspace folder.

6  User

The user resource maintain the user. The logical URI for this resource is user:/user.setup where user:/ is redirected to ~/.eclipse/org.eclipse.oomph.setup/setups/.