View source for Embed OpenEJB in J2EE Preview Server Adapter

== Idea For Google Summer Of Code ==

===== '''Possible mentor:''' Kaloyan Raev =====

===== '''Student:''' Marcelo Dias =====

[http://code.google.com/p/embed-openejb-in-eclipse/wiki/Index Project's wiki page:]

----

=== Description ===

I had taken this idea from the ideas of Kaloyan Raev in the Eclipse Foundation Ideas List for GSoC. It is under the Web Tool Plataform Project (WTP)[1].

The idea is to embed OpenEJB container[2] in Jetty Web Server[3] in order to provide supports to deploy and run EJB modules using J2EE Preview Adapter, since J2EE Preview Adapter uses the Jetty to deploy and run web applications.

Why we chose OpenEJB for that? This choise rely on two major things. The former is that OpenEJB is a well embeddable EJB container from a great Open Source Community that is Apache Software Foundation. The latter is that OpenEJB project already has a stable OpenEJB plugin for Tomcat. Who embed the OpenEJB into the Tomcat's servlet container Catalina providing all of the OpenEJB features for servlets[4]. This plugin will be (and, already is) very helpful to the planning and implementation of this idea. From now on, this proposal rely on the architectural concepts of this plugin.

The OpenEJB plugin for Tomcat architecture can be divided in two parts:
	
*Infraestructural Classes: It's the classes responsible to make the integration of OpenEJB with Tomcat.
	
*OpenEJB Web Application Installer: A web application that is shipped with the plugin. It have to be put in Tomcat webapps directory to run  it in Tomcat in order to install the plugin. This web application is responsible to edit the Tomcat configuration files. After this file edition, when Tomcat restarts, Tomcat will take into account, when handling users requests, the OpenEJB container.

In a similar way, the integration of OpenEJB with Jetty will be formed with these two parts too.

Another issue we have to consider is the differences between the Tomcat Architecture[5] and the Jetty Architecture[6]. And take into account these differences when adapting the OpenEJB plugin for Tomcat in order to embed the OpenEJB in Jetty.  

The consideration of those differences is very important, since we are planning to rely the implementation of the integration of OpenEJB with Jetty
on the OpenEJB plugin developed for Tomcat. And here is the place that problems can appear. Example, if in a concern the difference between the Tomcat and Jetty is so wide that a adaptation of the plugin is impossible. In this case I'll have to code this concern from scratch.

In the end, the J2EE Preview Server Adapter will support not only the WEB and EAR modules, but will also support Web applications that use EJB module
without need of complex configurations.

More details and source code can be found [http://code.google.com/p/embed-openejb-in-eclipse/wiki/Index here]
----

== Schedule ==
<table style="text-align: left; width: 800px; height: 64px;" border="1" cellpadding="2" cellspacing="2">
	<tr align="center">
		<td style="vertical-align: top;" ></td>
		<td style="vertical-align: top;" colspan="2"><span style="font-weight: bold;">April</span></td>
		<td style="vertical-align: top;" colspan="4"><span style="font-weight: bold;">May</span></td>
		<td style="vertical-align: top;" colspan="4"><span style="font-weight: bold;">June</span></td>
		<td style="vertical-align: top;" colspan="4"><span style="font-weight: bold;">July</span></td>
		<td style="vertical-align: top;" colspan="3"><span style="font-weight: bold;">August</span></td>
	</tr>
	<tr align="center">
		<td style="vertical-align: top;" ></td>
		<td style="vertical-align: top;" colspan="18"><span style="font-weight: bold;">Week</span></td>
	</tr>

  <tr>
      <td style="vertical-align: top;" ><span style="font-weight: bold;">Activities</span></td>
	<td> 3rd </td>
	<td> 4th </td>      
	<td> 1st </td>
	<td> 2nd </td>
	<td> 3rd </td>
	<td> 4th </td>
	<td> 1st </td>
	<td> 2nd </td>
	<td> 3rd </td>
	<td> 4th </td>
	<td> 1st </td>
	<td> 2nd </td>
	<td> 3rd </td>
	<td> 4th </td>
	<td> 1st </td>
	<td> 2nd </td>
	<td> 3rd </td>      
  </tr>

    <tr>
      <td style="vertical-align: top;">1) Getting familiar with the Eclipse Foundation processes</td>
	<td> X </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
    </tr>

    <tr>
      <td style="vertical-align: top;">2) Study good practices in development of Eclipse plugins</td>
	<td> . </td>
	<td> X </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>    

</tr>   

    <tr>
      <td style="vertical-align: top;">3) Study how the WTP Server Adapters works</td>
	<td> . </td>
	<td> . </td>      
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>    
    </tr>

    <tr>
      <td style="vertical-align: top;">4) Study the architecture of Tomcat and Jetty servers</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>    
    </tr>

    <tr>
      <td style="vertical-align: top;">5) Study the OpenEJB plugin for Tomcat</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
</tr>              

    <tr>
      <td style="vertical-align: top;">6) Plan how to embed and how to integrate OpenEJB with Jetty</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
    </tr>

<tr>
      <td style="vertical-align: top;">7) Implementation of the Structural Classes of the embedment of OpenEJB in Jetty</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> X </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">8) Test the Structural Classes of the embedment of OpenEJB int Jetty</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">9) Study the OpenEJB Web Application Installer</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">Mid-term evaluations</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">10) Implement the OpenEJB Web Application responsible to embed OpenEJB in Jetty</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> X </td>
	<td> X </td>
	<td> . </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">11) Test the J2EE Preview Server Adapter using Jetty embedding OpenEJB.</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>
	<td> . </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">12) Create documentation to guide the use of the Jetty embedding OpenEJB</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>        
    </tr>    

<tr>
      <td style="vertical-align: top;">Final evaluation deadline on 08/24</td>
	<td> . </td>
	<td> . </td>      
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> . </td>
	<td> X </td>        
    </tr>    
</table>

== References ==
[1] http://www.eclipse.org/webtools/server/

[2] http://openejb.apache.org

[3] http://www.mortbay.org/jetty/

[4] http://openejb.apache.org/tomcat.html

[5] http://tomcat.apache.org/tomcat-6.0-doc/architecture/overview.html

[6] http://docs.codehaus.org/display/JETTY/Architecture