Project Examples Sites

Version 11

    Project Examples is a JBoss Tools feature that provides creating and importing different Eclipse and Maven projects.

    A project example contains one or more Eclipse/Maven projects archived in zip format.

    Project examples of the type "mavenArchetype" and "mavenGit" don't require a zip file.  It is enough to declare them in the project examples xml file.

    Project Examples Sites

     

    Project examples are organized in sites. A site is a local or remote xml file that describes one or more project examples.

    The sites can be defined in three ways:

    • using an extension point Below, it is shown an example of an extension point for defining the "JBoss Tools Community Examples" site:     

     


       <extension

            point="org.jboss.tools.project.examples.projectExamplesXml"

            name="JBoss Tools 32 Community_Examples">

            <url>http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml</url>

            <experimental>false</experimental>

       </extension>

     


    The extension point contains the name of the site, the URL on which the xml file is placed and a flag that indicates whether the file is experimental. Experimental sites aren't shown by default.
    The user imports project examples using the Help>Project Examples menu, as shown in the following figure:

     

     

    projectExamples1.png



    • adding a user site within the Project Examples Dialog The user can add his own site using the Project Example Dialog as shown in the following figure:

    projectExamples2.png

    • by adding the "org.jboss.tools.project.examples.xml" system property when starting Eclipse For example:
      -Dorg.jboss.tools.project.examples.xml=file:///E:/temp/MyProjects.xml

     

    User sites and a site added using the system property are always experimental.

     

    The Project Examples Engine uses ECF to download zip archives which means that the sites (xml files) and project examples (zip archives) can be password protected.

     

    The following site is defined in the org.jboss.tools.project.examples plugin

    The 5 project examples defined in this site are shown both in JBDS and JBoss Tools

     

    The following sites are defined in the com.jboss.jbds.project.examples plugin:

     

     

    Project examples defined in these sites are shown only in JBDS.

     

    The org.jboss.tools.community.project.examples plugin defines the following sites:

     

    The org.jboss.tools.project.examples plugin defines the following sites:

     

     

    Project examples defined in these sites are shown in both JBoss Tools and JBDS.

     

    Changes in JBDS 4.0.1/JBoss Tools 3.2.1

     

    JBDS 4.0.1

     

     

    All the examples from JBDS 4.0.0 including the Teiid examples have been moved to the above site.

    The site is defined in the com.jboss.jbds.project.examples plugin

     

    JBoss Tools 3.2.1

     

     

     

    These sites are defined in the org.jboss.tools.community.project.examples plugin.

     

    There isn't any site defined in the org.jboss.tools.project.examples plugin.

     

    If an example needs to be in both, JBDS 4.0.1 and JBoss Tools 3.2.1, it should be added to :

     

    JBoss Developer Studio 4.0 Examples - http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml (JBDS)

    and some of the JBoss Tools sites.

     

    The Teiid examples, for instance, have been added to :

     

    JBoss Developer Studio 4.0 Examples - http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml

    and

    JBoss Tools 3.2 Community Examples - http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml

     

    See JBDS-1590 and JBIDE-8516.