You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by ds...@apache.org on 2008/03/25 00:39:17 UTC
svn commit: r640645 - in /openejb/trunk/sandbox/openejb-eclipse-plugin/src:
./ site/ site/apt/ site/resources/ site/resources/images/
Author: dsh
Date: Mon Mar 24 16:39:16 2008
New Revision: 640645
URL: http://svn.apache.org/viewvc?rev=640645&view=rev
Log:
OPENEJB-674 Eclipse plugin for OpenEJB
Contributed by: Jonathan Gallimore
Binary: openejb-674-16.zip
Added:
openejb/trunk/sandbox/openejb-eclipse-plugin/src/
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/annotations.apt
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/building.apt
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/installation.apt
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/server.apt
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_1.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_2.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_3.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_1.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_2.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_3.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_4.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_1.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_2.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_3.jpg (with props)
openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/site.xml
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/annotations.apt
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/annotations.apt?rev=640645&view=auto
==============================================================================
--- openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/annotations.apt (added)
+++ openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/annotations.apt Mon Mar 24 16:39:16 2008
@@ -0,0 +1,51 @@
+Generating annotations
+
+ The OpenEJB Eclipse plugin is able to provide some assistance in helping you migrate EJB 2.x projects to EJB 3.0, by analyzing your ejb-jar.xml file, and adding EJB annotations to your source code.
+ This page will show you how to use this functionality.
+
+ First of all you will need to add the EJB 3.0 API jars to the classpath of your project. If you are using Maven, you can add the
+ following to your POM (you will need to update your Eclipse project using mvn eclipse:eclipse afterwards)
+
+---
+ <dependencies>
+ ...
+ <dependency>
+ <groupId>org.apache.geronimo.specs</groupId>
+ <artifactId>geronimo-ejb_3.0_spec</artifactId>
+ <version>1.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.geronimo.specs</groupId>
+ <artifactId>geronimo-jpa_3.0_spec</artifactId>
+ <version>1.1</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+---
+
+ Alternatively, import the API jars into your project, and add them to your build path.
+
+ Next, click the 'OpenEJB' menu on the menubar, and select 'Generate Annotations'.
+
+[images/annotations_step_1.jpg]
+
+ Select the project you would like to work with, if it isn't already selected. Click 'Next'.
+
+[images/annotations_step_2.jpg]
+
+ Select your ejb-jar.xml and (optionally) your openejb-jar.xml files. Select or deselect the other options as appropriate, and select 'Next'.
+
+ Options:
+
+ * Alter SessionBean interfaces - This option makes your session beans implement your remote / local interfaces as opposed to javax.ejb.SessionBean, and stops your remote / local interfaces extending javax.ejb.EJBObject.
+
+ * Add @Remote and @RemoteHome annotations - This adds @Remote and @RemoteHome annotations appropriately
+
+ * Convert entity beans to POJOs - This options converts abstract CMP classes to POJOs generating simple getters and setters.
+
+ []
+
+[images/annotations_step_3.jpg]
+
+ Review the changes that the plugin will make to your source code. Uncheck any changes you don't want to apply, and click 'Finish'.
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/building.apt
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/building.apt?rev=640645&view=auto
==============================================================================
--- openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/building.apt (added)
+++ openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/building.apt Mon Mar 24 16:39:16 2008
@@ -0,0 +1,40 @@
+Building from source
+
+ * Checking out the source
+
+ []
+
+ The source is currently checked into the sandbox area of the OpenEJB project's subversion repository. To checkout the source,
+ run this command with your subversion client.
+
+-----------------------------------------------------------------------------------------------------------------
+ svn checkout https://svn.apache.org/repos/asf/openejb/trunk/sandbox/openejb-eclipse-plugin openejb-eclipse-plugin
+-----------------------------------------------------------------------------------------------------------------
+
+ * Building the source
+
+ []
+
+ To build the plugin you will need Maven (the build has been tested with Maven 2.0.7). To run the build, issue this command
+
+--------------------------------------------------------------------------------
+ mvn -Dassemble clean install
+--------------------------------------------------------------------------------
+
+ You should be aware that this will download any dependencies, including a copy of Eclipse. This will take a while for your first build.
+
+ * Importing the plugin code into an Eclipse workspace
+
+ []
+
+ You can generate the Eclipse projects for the plugins by running the following command
+
+--------------------------------------------------------------------------------
+ mvn eclipse:clean eclipse:eclipse
+--------------------------------------------------------------------------------
+
+ You can add the M2_REPO classpath variable to your Eclipse workspace by running the following command
+
+--------------------------------------------------------------------------------
+ mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
+--------------------------------------------------------------------------------
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/installation.apt
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/installation.apt?rev=640645&view=auto
==============================================================================
--- openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/installation.apt (added)
+++ openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/installation.apt Mon Mar 24 16:39:16 2008
@@ -0,0 +1,27 @@
+Installation
+
+ Installation is easiest from an update site. In Eclipse, select Help, Software Updates, Find and install...
+
+
+[images/install_step_1.jpg]
+
+ Select 'Search for new features to install'
+
+[images/install_step_2.jpg]
+
+ Select 'New Remote site'. Enter 'OpenEJB' for the name and {http://www.jrg.me.uk/update-site} for the URL. Click 'Ok' and make sure your new update site is selected.
+ Then select 'Finish'
+
+[images/install_step_3.jpg]
+
+ Check the box to install the OpenEJB feature. Click 'Next'
+
+[images/install_step_4.jpg]
+
+ Read and make sure you're happy with the license agreement.
+
+[images/install_step5.jpg]
+
+ Check the installation location, and change it if you wish to. Select 'Finish'.
+
+ Restarting the workbench when the installation is finished is recommended.
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/server.apt
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/server.apt?rev=640645&view=auto
==============================================================================
--- openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/server.apt (added)
+++ openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/apt/server.apt Mon Mar 24 16:39:16 2008
@@ -0,0 +1,27 @@
+Running a server
+
+ The OpenEJB plugin provides a mechanism to run OpenEJB as a standalone server in Eclipse. This page show you how to use it.
+
+ First of all, open the Server view. You can do this from the menu bar using the 'Window->Show view->Other' options. Select 'Servers' under the 'Server' category.
+
+ Right click in the Server view, and select 'New->Server'.
+
+[images/server_step_1.jpg]
+
+ Expand the 'Apache' category and select 'OpenEJB 3.0.0'. Click 'Next'.
+
+[images/server_step_2.jpg]
+
+ Select the directory where you have OpenEJB installed.
+
+[images/server_step_3.jpg]
+
+ Select the host and port, and click 'Finish'.
+
+ You can now start and stop the server from the servers view.
+
+Known issues
+
+ Version numbering. The current plugin only works with OpenEJB built from source, as it looks for jars with 3.0-SNAPSHOT in the filenames.
+ This is in the process of being fixed, and will hopefully be resolved shortly.
+
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_1.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_1.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_1.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_2.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_2.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_2.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_3.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_3.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/annotations_step_3.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_1.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_1.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_1.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_2.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_2.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_2.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_3.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_3.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_3.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_4.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_4.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/install_step_4.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_1.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_1.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_1.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_2.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_2.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_2.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_3.jpg
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_3.jpg?rev=640645&view=auto
==============================================================================
Binary file - no diff available.
Propchange: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/resources/images/server_step_3.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/site.xml?rev=640645&view=auto
==============================================================================
--- openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/site.xml (added)
+++ openejb/trunk/sandbox/openejb-eclipse-plugin/src/site/site.xml Mon Mar 24 16:39:16 2008
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="OpenEJB Eclipse">
+ <body>
+ <menu name="Using the plugins">
+ <item name="Installation" href="/installation.html"/>
+ <item name="Building from source" href="/building.html"/>
+ <item name="Running a server" href="/server.html"/>
+ <item name="Generating annotations" href="/annotations.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>