blob: 05780571181def34c255f5d8f52185ec76ba7b06 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Apache TomEE</title>
<meta name="description"
content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
<meta name="author" content="Luka Cvetinovic for Codrops" />
<link rel="icon" href="../../favicon.ico">
<link rel="icon" type="image/png" href="../../favicon.png">
<meta name="msapplication-TileColor" content="#80287a">
<meta name="theme-color" content="#80287a">
<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="../../css/owl.css">
<link rel="stylesheet" type="text/css" href="../../css/animate.css">
<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
<link rel="stylesheet" type="text/css" href="../../css/idea.css">
<link rel="stylesheet" type="text/css" href="../../css/cardio.css">
<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="preloader">
<img src="../../img/loader.gif" alt="Preloader image">
</div>
<nav class="navbar">
<div class="container">
<div class="row"> <div class="col-md-12">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<span>
<img src="../../img/logo-active.png">
</span>
Apache TomEE
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right main-nav">
<li><a href="../../docs.html">Documentation</a></li>
<li><a href="../../community/index.html">Community</a></li>
<li><a href="../../security/security.html">Security</a></li>
<li><a href="../../download-ng.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div></div>
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container main-block">
<div class="row title">
<div class="col-md-12">
<div class='page-header'>
<h1>Getting Started</h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div class="sect1">
<h2 id="_the_following_instructions_are_written_using_eclipse_3_2_we">The following instructions are written using Eclipse 3.2. We</h2>
<div class="sectionbody">
<div class="paragraph">
<p>will refer to the install location of OpenEJB as OPENEJB_HOME</p>
</div>
<div class="paragraph">
<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>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_1_download_and_install_openejb">1. Download and Install OpenEJB</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Follow
these http://cwiki.apache.org/confluence/display/OPENEJB/Quickstart[instructions]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_2_setup_your_development_environment">2. Setup your development environment</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_eclipse">Eclipse</h3>
<div class="ulist">
<ul>
<li>
<p>Open eclipse and create a new java project. Name it EJBProject</p>
</li>
<li>
<p>Add the following jars to the build path of your project&#8201;&#8212;&#8201;OPENEJB_HOME/lib/geronimo-ejb_3.0_spec-1.0.jar</p>
</li>
<li>
<p>Now create another project named EJBClient. This is where we will
write a test client</p>
</li>
<li>
<p>Add the following jars to the build path of this project&#8201;&#8212;&#8201;OPENEJB_HOME/lib/openejb-client-3.0.0-SNAPSHOT.jar</p>
</li>
<li>
<p>Add the EJBProject to the classpath of the EJBClient project</p>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_3_start_the_server">3. Start the Server</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Open the command prompt and run the following command:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">d:\openejb-3.0.0-SNAPSHOT\bin\openejb start</code></pre>
</div>
</div>
<div class="paragraph">
<p>You will get the following message on the console:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">D:\openejb-3.0.0-SNAPSHOT&gt;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>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_4_write_an_ejb">4. Write an EJB</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In the EJB project create a new interface named Greeting</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">package com.myejbs;
import javax.ejb.Remote;
@Remote
public interface Greeting {
public String greet();
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Now create a new class named GreetingBean which implements the above
interface (shown below)</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">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>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_5_deploy_the_ejb">5. Deploy the EJB</h2>
<div class="sectionbody">
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Export the EJBProject as a jar file. Name it greeting.jar and put it
in the OPENEJB_HOME/apps directory.</p>
</li>
<li>
<p>Open the command prompt and type in the following command:</p>
<div class="paragraph">
<p>d:-3.0.0-SNAPSHOT &gt; bindeploy apps.jar</p>
</div>
</li>
</ol>
</div>
<div class="paragraph">
<p>This should give you the following output:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">D:\openejb-3.0.0-SNAPSHOT&gt;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>
</div>
</div>
<div class="paragraph">
<p>\{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>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_6_write_the_client">6. Write the Client</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In the EJBClient project, create a class named Client (shown below)</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">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>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_7_run_the_client">7. Run the Client</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Open Client.java in eclipse and run it as a java application. You should
see the following message in the console view:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-properties" data-lang="properties">My First Remote Stateless Session Bean</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_8_stop_the_server">8. Stop the server</h2>
<div class="sectionbody">
<div class="paragraph">
<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>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">D:\openejb-3.0.0-SNAPSHOT&gt;bin\openejb stop</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
</ul>
</div>
<div class="col-sm-6 text-center-mobile">
<div class="row opening-hours">
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/docs/documentation.html" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../community/index.html" class="white">Community</a></h5>
<ul class="list-unstyled">
<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../security/index.html" class="white">Security</a></h5>
<ul class="list-unstyled">
<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row bottom-footer text-center-mobile">
<div class="col-sm-12 light-white">
<p>Copyright &copy; 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>
</div>
</div>
</div>
</footer>
<!-- Holder for mobile navigation -->
<div class="mobile-nav">
<ul>
<li><a hef="../../latest/docs/admin/index.html">Administrators</a>
<li><a hef="../../latest/docs/developer/index.html">Developers</a>
<li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
<li><a hef="../../community/index.html">Community</a>
</ul>
<a href="#" class="close-link"><i class="arrow_up"></i></a>
</div>
<!-- Scripts -->
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/owl.carousel.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/wow.min.js"></script>
<script src="../../js/typewriter.js"></script>
<script src="../../js/jquery.onepagenav.js"></script>
<script src="../../js/tree.jquery.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script src="../../js/main.js"></script>
</body>
</html>