| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Getting Started</title> |
| <meta name="description" content="Apache TomEE"> |
| <meta name="author" content="Apache TomEE"> |
| <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10"> |
| <meta http-equiv="Pragma" content="no-cache"> |
| <meta http-equiv="Expires" content="0"> |
| <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0"> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le styles --> |
| <link href="./resources/css/bootstrap.css" rel="stylesheet"> |
| <link href="./resources/css/prettify.css" rel="stylesheet"> |
| <!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"--> |
| <link href="./resources/css/main.css" rel="stylesheet"> |
| <link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet"> |
| |
| <script type="text/javascript"> |
| var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,"")); |
| var u = encodeURIComponent(""+document.URL); |
| |
| function fbshare () { |
| window.open( |
| "http://www.facebook.com/sharer/sharer.php?u="+u, |
| 'Share on Facebook', |
| 'width=640,height=426'); |
| }; |
| function gpshare () { |
| window.open( |
| "https://plus.google.com/share?url="+u, |
| 'Share on Google+', |
| 'width=584,height=385'); |
| }; |
| function twshare () { |
| window.open( |
| "https://twitter.com/intent/tweet?url="+u+"&text="+t, |
| 'Share on Twitter', |
| 'width=800,height=526'); |
| }; |
| function pinshare () { |
| window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t, |
| 'Share on Pinterest', |
| 'width=800,height=526'); |
| }; |
| </script> |
| |
| <!-- Le fav and touch icons --> |
| <link rel="shortcut icon" href="./favicon.ico"> |
| <link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png"> |
| |
| <script src="./resources/js/prettify.js" type="text/javascript"></script> |
| <script src="./resources/js/jquery-latest.js"></script> |
| <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script> |
| <script src="./resources/js/common.js"></script> |
| <script src="./resources/js/prettyprint.js"></script> |
| <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//--> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| |
| <div class="topbar" data-dropdown="dropdown"> |
| <div class="fill"> |
| <div class="container"> |
| <a class="brand" href="./index.html">Apache TomEE</a> |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#"> |
| Apache |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> --> |
| <!-- <li><a href="./misc/heritage.html">Heritage</a></li> --> |
| <li><a href="http://www.apache.org">Apache Home</a></li> |
| <!-- <li><a href="./misc/resources.html">Resources</a></li> --> |
| <li><a href="./misc/contact.html">Contact</a></li> |
| <li><a href="./misc/legal.html">Legal</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="divider"/> |
| <li><a href="http://www.apache.org/security">Security</a></li> |
| </ul> |
| </li> |
| <li><a href="./index.html">Home</a></li> |
| <li><a href="./downloads.html">Downloads</a></li> |
| <li><a href="./documentation.html">Documentation</a></li> |
| <li><a href="./examples-trunk/index.html">Examples</a></li> |
| <li><a href="./support.html">Support</a></li> |
| <li><a href="./contribute.html">Contribute</a></li> |
| <li><a href="./security/index.html">Security</a></li> |
| </ul> |
| |
| <!-- Google CSE Search Box Begins --> |
| <FORM class="pull-right" id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search"> |
| </FORM> |
| <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>--> |
| <!-- Google CSE Search Box Ends --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| <div class="page-header"> |
| <small><a href="./index.html">Home</a></small><br> |
| <h1>Getting Started |
| |
| <div style="float: right; position: relative; bottom: -10px; "> |
| <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a> |
| <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a> |
| <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a> |
| <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a> |
| <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a> |
| </div> |
| </h1> |
| </div> |
| |
| <h2>The following instructions are written using Eclipse 3.2. We will</h2> |
| |
| <p>refer to the install location of OpenEJB as OPENEJB_HOME</p> |
| |
| <p>Here are some basic steps you need to perform to get started with OpenEJB |
| 1. Download and install OpenEJB |
| 1. Setup your development environment |
| 1. Write an EJB |
| 1. Write an EJB client |
| 1. Start the server |
| 1. Deploy the EJB |
| 1. Run the client |
| 1. Stop the server</p> |
| |
| <blockquote> |
| |
| </blockquote> |
| |
| <p><a name="GettingStarted- 1.DownloadandInstallOpenEJB"></a></p> |
| |
| <h2>1. Download and Install OpenEJB</h2> |
| |
| <p>Follow these <a href="http://cwiki.apache.org/confluence/display/OPENEJB/Quickstart">instructions</a></p> |
| |
| <p><a name="GettingStarted- 2.Setupyourdevelopmentenvironment"></a></p> |
| |
| <h2>2. Setup your development environment</h2> |
| |
| <p><a name="GettingStarted- Eclipse"></a></p> |
| |
| <h3>Eclipse</h3> |
| |
| <ul> |
| <li>Open eclipse and create a new java project. Name it EJBProject</li> |
| <li>Add the following jars to the build path of your project |
| -- OPENEJB_HOME/lib/geronimo-ejb_3.0_spec-1.0.jar</li> |
| <li>Now create another project named EJBClient. This is where we will write a test client</li> |
| <li>Add the following jars to the build path of this project |
| -- OPENEJB_HOME/lib/openejb-client-3.0.0-SNAPSHOT.jar</li> |
| <li>Add the EJBProject to the classpath of the EJBClient project</li> |
| </ul> |
| |
| <p><a name="GettingStarted- 3.StarttheServer"></a></p> |
| |
| <h2>3. Start the Server</h2> |
| |
| <p>Open the command prompt and run the following command:</p> |
| |
| <pre><code>d:\openejb-3.0.0-SNAPSHOT\bin\openejb start |
| </code></pre> |
| |
| <p>You will get the following message on the console:</p> |
| |
| <pre><code>D:\openejb-3.0.0-SNAPSHOT>bin\openejb start |
| Apache OpenEJB 3.0.0-SNAPSHOT build: 20070830-07:53 |
| http://tomee.apache.org/ |
| OpenEJB ready. |
| [OPENEJB:init] |
| OpenEJB Remote Server |
| ** Starting Services ** |
| NAME IP PORT |
| httpejbd 0.0.0.0 4204 |
| admin thread 0.0.0.0 4200 |
| ejbd 0.0.0.0 4201 |
| hsql 0.0.0.0 9001 |
| telnet 0.0.0.0 4202 |
| ------- |
| Ready! |
| </code></pre> |
| |
| <p><a name="GettingStarted- 4.WriteanEJB"></a></p> |
| |
| <h2>4. Write an EJB</h2> |
| |
| <p>In the EJB project create a new interface named Greeting</p> |
| |
| <pre><code>package com.myejbs; |
| |
| import javax.ejb.Remote; |
| |
| @Remote |
| public interface Greeting { |
| public String greet(); |
| } |
| </code></pre> |
| |
| <p>Now create a new class named GreetingBean which implements the above |
| interface (shown below)</p> |
| |
| <pre><code>package com.myejbs; |
| |
| import javax.ejb.Stateless; |
| |
| @Stateless |
| public class GreetingBean implements Greeting { |
| |
| public String greet() { |
| return "My First Remote Stateless Session Bean"; |
| } |
| |
| } |
| </code></pre> |
| |
| <p><a name="GettingStarted- 5.DeploytheEJB"></a></p> |
| |
| <h2>5. Deploy the EJB</h2> |
| |
| <ol> |
| <li>Export the EJBProject as a jar file. Name it greeting.jar and put it in |
| the OPENEJB_HOME/apps directory.</li> |
| <li>Open the command prompt and type in the following command:</p> |
| |
| <p>d:\openejb-3.0.0-SNAPSHOT > bin\openejb deploy apps\greeting.jar</li> |
| </ol> |
| |
| <p>This should give you the following output:</p> |
| |
| <pre><code>D:\openejb-3.0.0-SNAPSHOT>bin\openejb deploy apps\greeting.jar |
| |
| Application deployed successfully at \{0\} |
| |
| App(id=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar) |
| |
| EjbJar(id=greeting.jar, path=D:\openejb-3.0.0-SNAPSHOT\apps\greeting.jar) |
| |
| Ejb(ejb-name=GreetingBean, id=GreetingBean) |
| |
| Jndi(name=GreetingBeanRemote) |
| </code></pre> |
| |
| <p><div class="color">:#330000}{<em>}Notice the Jndi(name=GreetingBeanRemote) information. |
| Keep this handy as this is the JNDI name of the bean which the client will |
| use for lookup{</em>}{color}</p> |
| |
| <p><a name="GettingStarted- 6.WritetheClient"></a></p> |
| |
| <h2>6. Write the Client</h2> |
| |
| <p>In the EJBClient project, create a class named Client (shown below)</p> |
| |
| <pre><code>package com.myclient; |
| |
| import com.myejbs.Greeting; |
| |
| import javax.naming.InitialContext; |
| import java.util.Properties; |
| |
| public class Client { |
| public static void main(String[] args) { |
| |
| try { |
| Properties p = new Properties(); |
| p.put("java.naming.factory.initial", "org.openejb.client.RemoteInitialContextFactory"); |
| p.put("java.naming.provider.url", "ejbd://127.0.0.1:4201"); |
| InitialContext ctx = new InitialContext(p); |
| Greeting greeter = (Greeting) ctx.lookup("GreetingBeanRemote"); |
| String message = greeter.greet(); |
| System.out.println(message); |
| } catch (Exception e) { |
| e.printStackTrace(); |
| } |
| } |
| } |
| </code></pre> |
| |
| <p><a name="GettingStarted- 7.RuntheClient"></a></p> |
| |
| <h2>7. Run the Client</h2> |
| |
| <p>Open Client.java in eclipse and run it as a java application. You should |
| see the following message in the console view:</p> |
| |
| <pre><code>My First Remote Stateless Session Bean |
| </code></pre> |
| |
| <p><a name="GettingStarted- 8.Stoptheserver"></a></p> |
| |
| <h2>8. Stop the server</h2> |
| |
| <p>There are two ways to stop the server: |
| 1. You can press Ctrl+c on the command prompt to stop the server |
| 1. On the command prompt type in the following command:</p> |
| |
| <pre><code>D:\openejb-3.0.0-SNAPSHOT>bin\openejb stop |
| </code></pre> |
| |
| |
| |
| |
| <div id="edit" class="modal hide fade in" style="display: none; "> |
| <div class="modal-header"> |
| <a class="close" data-dismiss="modal">x</a> |
| |
| <h3>Thank you for contributing to the documentation!</h3> |
| </div> |
| <div class="modal-body"> |
| <h4>Any help with the documentation is greatly appreciated.</h4> |
| <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p> |
| <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small> |
| <!--[if gt IE 6]> |
| <h4>Internet Explorer Users</h4> |
| <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p> |
| <![endif]--> |
| |
| </div> |
| <div class="modal-footer"> |
| Do you have an Apache ID? |
| <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a> |
| <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a> |
| </div> |
| </div> |
| <script src="./resources/js/bootstrap-modal.js"></script> |
| |
| <footer> |
| <p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="./resources/js/bootstrap-dropdown.js"></script> |
| |
| </body> |
| </html> |
