blob: 676b0c688fe067642308bfe79914a6ed5515295e [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">
<!-- 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="../examples/index.html">Examples</a></li>
<li><a href="../community/index.html">Community</a></li>
<li><a href="../security/index.html">Security</a></li>
<li><a href="../download-ng.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container section-padded">
<div class="row title">
<div class='page-header'>
<div class='btn-toolbar pull-right' style="z-index: 2000;">
<div class='btn-group'>
<a class="btn" href="../examples/jsf-cdi-and-ejb.pdf"><i class="fa fa-file-pdf-o"></i> Download as PDF</a>
</div>
</div>
<h2>JSF-CDI-EJB</h2>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Example jsf-cdi-and-ejb can be browsed at <a href="https://github.com/apache/tomee/tree/master/examples/jsf-cdi-and-ejb" class="bare">https://github.com/apache/tomee/tree/master/examples/jsf-cdi-and-ejb</a></p>
</div>
<div class="paragraph">
<p>The simple application contains a CDI managed bean <code>CalculatorBean</code>, which uses the <code>Calculator</code> EJB to add two numbers
and display the results to the user. The EJB is injected in the managed bean using @Inject annotation.</p>
</div>
<div class="paragraph">
<p>You could run this in the latest Apache TomEE <a href="https://repository.apache.org/content/repositories/snapshots/org/apache/openejb/apache-tomee/">snapshot</a></p>
</div>
<div class="paragraph">
<p>The complete source code is below but lets break down to look at some smaller snippets and see how it works.</p>
</div>
<div class="paragraph">
<p>A little note on the setup:</p>
</div>
<div class="paragraph">
<p>As for the libraries, myfaces-api and myfaces-impl are provided in tomee/lib and hence they should not be a part of the
war. In maven terms, they would be with scope 'provided'</p>
</div>
<div class="paragraph">
<p>Also note that we use servlet 2.5 declaration in web.xml
&lt;web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
<a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"" class="bare">http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</a>
version="2.5"&gt;</p>
</div>
<div class="paragraph">
<p>And we use 2.0 version of faces-config</p>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;faces-config xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
version="2.0"&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>To make this a cdi-aware-archive (i.e bean archive) an empty beans.xml is added in WEB-INF</p>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;</pre>
</div>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;beans xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/beans_1_0.xsd"&gt;
&lt;/beans&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>We&#8217;ll first declare the FacesServlet in the web.xml</p>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;servlet&gt;
&lt;servlet-name&gt;Faces Servlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;javax.faces.webapp.FacesServlet&lt;/servlet-class&gt;
&lt;load-on-startup&gt;1&lt;/load-on-startup&gt;
&lt;/servlet&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>FacesServlet acts as the master controller.</p>
</div>
<div class="paragraph">
<p>We&#8217;ll then create the calculator.xhtml file.</p>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;h:outputText value='Enter first number'/&gt;
&lt;h:inputText value='#{calculatorBean.x}'/&gt;
&lt;h:outputText value='Enter second number'/&gt;
&lt;h:inputText value='#{calculatorBean.y}'/&gt;
&lt;h:commandButton action="#{calculatorBean.add}" value="Add"/&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>Notice how we&#8217;ve used the bean here. By default, the bean name would be the simple name of the bean
class with the first letter in lower case.</p>
</div>
<div class="paragraph">
<p>We&#8217;ve annotated the <code>CalculatorBean</code> with <code>@RequestScoped</code>.
So when a request comes in, the bean is instantiated and placed in the request scope.</p>
</div>
<div class="paragraph">
<p>&lt;h:inputText value='#{calculatorBean.x}'/&gt;</p>
</div>
<div class="paragraph">
<p>Here, getX() method of calculatorBean is invoked and the resulting value is displayed.
x being a Double, we rightly should see 0.0 displayed.</p>
</div>
<div class="paragraph">
<p>When you change the value and submit the form, these entered values are bound using the setters
in the bean and then the commandButton-action method is invoked.</p>
</div>
<div class="paragraph">
<p>In this case, CalculatorBean#add() is invoked.</p>
</div>
<div class="paragraph">
<p>Calculator#add() delegates the work to the ejb, gets the result, stores it
and then returns what view is to be rendered.</p>
</div>
<div class="paragraph">
<p>The return value "success" is checked up in faces-config navigation-rules
and the respective page is rendered.</p>
</div>
<div class="paragraph">
<p>In our case, 'result.xhtml' page is rendered where
use EL and display the result from the request-scoped <code>calculatorBean</code>.</p>
</div>
</div>
</div>
<h1 id="_source_code" class="sect0">Source Code</h1>
<div class="sect1">
<h2 id="_calculatorbean">CalculatorBean</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-java" data-lang="java">import javax.enterprise.context.RequestScoped;
import javax.inject.Named;
import javax.inject.Inject;
@RequestScoped
@Named
public class CalculatorBean {
@Inject
Calculator calculator;
private double x;
private double y;
private double result;
public double getX() {
return x;
}
public void setX(double x) {
this.x = x;
}
public double getY() {
return y;
}
public void setY(double y) {
this.y = y;
}
public double getResult() {
return result;
}
public void setResult(double result) {
this.result = result;
}
public String add() {
result = calculator.add(x, y);
return "success";
}
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_calculator">Calculator</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-java" data-lang="java">package org.superbiz.jsf;
import javax.ejb.Stateless;
@Stateless
public class Calculator{
public double add(double x, double y) {
return x + y;
}
}</code></pre>
</div>
</div>
</div>
</div>
<h1 id="_web_xml" class="sect0">web.xml</h1>
<div class="paragraph">
<p>&lt;?xml version="1.0"?&gt;</p>
</div>
<div class="paragraph">
<p>&lt;web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
<a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"" class="bare">http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</a>
version="2.5"&gt;</p>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;description&gt;MyProject web.xml&lt;/description&gt;</pre>
</div>
</div>
<div class="literalblock">
<div class="content">
<pre>&lt;!-- Faces Servlet --&gt;
&lt;servlet&gt;</pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml">&lt;servlet-name&gt;Faces Servlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;javax.faces.webapp.FacesServlet&lt;/servlet-class&gt;
&lt;load-on-startup&gt;1&lt;/load-on-startup&gt;
&lt;/servlet&gt;
&lt;!-- Faces Servlet Mapping --&gt;
&lt;servlet-mapping&gt;
&lt;servlet-name&gt;Faces Servlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;*.jsf&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;
&lt;!-- Welcome files --&gt;
&lt;welcome-file-list&gt;
&lt;welcome-file&gt;index.jsp&lt;/welcome-file&gt;
&lt;welcome-file&gt;index.html&lt;/welcome-file&gt;
&lt;/welcome-file-list&gt;
&lt;/web-app&gt;
#Calculator.xhtml
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"&gt;
&lt;html xmlns="http://www.w3.org/1999/xhtml"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:h="http://java.sun.com/jsf/html"&gt;
&lt;h:body bgcolor="white"&gt;
&lt;f:view&gt;
&lt;h:form&gt;
&lt;h:panelGrid columns="2"&gt;
&lt;h:outputText value='Enter first number'/&gt;
&lt;h:inputText value='#{calculatorBean.x}'/&gt;
&lt;h:outputText value='Enter second number'/&gt;
&lt;h:inputText value='#{calculatorBean.y}'/&gt;
&lt;h:commandButton action="#{calculatorBean.add}" value="Add"/&gt;
&lt;/h:panelGrid&gt;
&lt;/h:form&gt;
&lt;/f:view&gt;
&lt;/h:body&gt;
&lt;/html&gt;
#Result.xhtml
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"&gt;
&lt;html xmlns="http://www.w3.org/1999/xhtml"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:h="http://java.sun.com/jsf/html"&gt;
&lt;h:body&gt;
&lt;f:view&gt;
&lt;h:form id="mainForm"&gt;
&lt;h2&gt;&lt;h:outputText value="Result of adding #{calculatorBean.x} and #{calculatorBean.y} is #{calculatorBean.result }"/&gt;&lt;/h2&gt;
&lt;h:commandLink action="back"&gt;
&lt;h:outputText value="Home"/&gt;
&lt;/h:commandLink&gt;
&lt;/h:form&gt;
&lt;/f:view&gt;
&lt;/h:body&gt;
&lt;/html&gt;
#faces-config.xml
&lt;?xml version="1.0"?&gt;
&lt;faces-config xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
version="2.0"&gt;
&lt;navigation-rule&gt;
&lt;from-view-id&gt;/calculator.xhtml&lt;/from-view-id&gt;
&lt;navigation-case&gt;
&lt;from-outcome&gt;success&lt;/from-outcome&gt;
&lt;to-view-id&gt;/result.xhtml&lt;/to-view-id&gt;
&lt;/navigation-case&gt;
&lt;/navigation-rule&gt;
&lt;navigation-rule&gt;
&lt;from-view-id&gt;/result.xhtml&lt;/from-view-id&gt;
&lt;navigation-case&gt;
&lt;from-outcome&gt;back&lt;/from-outcome&gt;
&lt;to-view-id&gt;/calculator.xhtml&lt;/to-view-id&gt;
&lt;/navigation-case&gt;
&lt;/navigation-rule&gt;
&lt;/faces-config&gt;</code></pre>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Apache TomEE the little great server.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://fr-fr.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="../documentation.html" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="../admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="../admin/directory-structure.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="../developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="../admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../examples.html" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="../examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="../examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="../examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="../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="../admin/index.html">Administrators</a>
<li><a hef="../developer/index.html">Developers</a>
<li><a hef="../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>