You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by bu...@apache.org on 2014/12/15 00:27:56 UTC
svn commit: r932758 [4/7] - in /websites/staging/deltaspike/trunk/content:
./ staging/documentation/
Modified: websites/staging/deltaspike/trunk/content/staging/documentation/index.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/staging/documentation/index.html (original)
+++ websites/staging/deltaspike/trunk/content/staging/documentation/index.html Sun Dec 14 23:27:55 2014
@@ -168,928 +168,112 @@ body {
</div>
<div id="toc" class="toc">
- <ul class="sectlevel1">
-<li><a href="#_introduction">Introduction</a>
-<ul class="sectlevel2">
-<li><a href="#_what_is_a_portable_cdi_extension">What is a portable CDI extension ?</a></li>
-<li><a href="#_deltaspike_in_a_nutshell">DeltaSpike in a nutshell</a>
-<ul class="sectlevel3">
-<li><a href="#_java_ee_7_without_java_ee_7">Java EE 7 without Java EE 7!</a></li>
-<li><a href="#_jsf_improvements">JSF Improvements</a></li>
-<li><a href="#_productivity_improvements">Productivity Improvements</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#_getting_started">Getting Started</a>
-<ul class="sectlevel2">
-<li><a href="#_project_configuration_without_maven">Project Configuration without Maven</a></li>
-<li><a href="#_project_configuration_with_maven">Project Configuration with Maven</a>
-<ul class="sectlevel3">
-<li><a href="#_configuration_of_deltaspike_core">Configuration of DeltaSpike Core</a></li>
-<li><a href="#_configuration_of_deltaspike_modules">Configuration of DeltaSpike Modules</a>
-<ul class="sectlevel4">
-<li><a href="#_security_module">Security Module</a></li>
-<li><a href="#_jpa_module">JPA Module</a></li>
-<li><a href="#_jsf_module">JSF Module</a></li>
-<li><a href="#_bean_validation_module">Bean Validation Module</a></li>
-<li><a href="#_servlet_module">Servlet Module</a></li>
-<li><a href="#_data_module">Data Module</a></li>
-<li><a href="#_test_control_module">Test-Control Module</a></li>
-<li><a href="#_scheduler_module">Scheduler Module</a></li>
-</ul>
-</li>
-<li><a href="#_with_java_se">With Java SE</a>
-<ul class="sectlevel4">
-<li><a href="#_add_the_deltaspike_container_ctrl_api">Add the DeltaSpike Container Ctrl API</a></li>
-<li><a href="#_add_a_cdi_container_container_ctrl_impl">Add a CDI container + Container Ctrl Impl</a></li>
-</ul>
-</li>
-<li><a href="#__for_apache_openwebbeans">…​ for Apache OpenWebBeans</a></li>
-<li><a href="#__for_jboss_weld_ri">…​ for JBoss Weld (RI)</a></li>
-<li><a href="#_for_embedded_servlet_runtimes_you_can_add">For Embedded Servlet Runtimes, you can add</a></li>
-<li><a href="#_testing_snapshots">Testing Snapshots</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#_deployment_mode">Deployment mode</a>
-<ul class="sectlevel2">
-<li><a href="#_with_java_ee6">With Java EE6+</a></li>
-<li><a href="#_with_java_ee5_or_servlet_containers">With Java EE5 or Servlet Containers</a></li>
-<li><a href="#_standard_java_se6">Standard Java SE6+</a></li>
-</ul>
-</li>
-<li><a href="#_start_a_cdi_container_using_java_se">Start a CDI container using Java SE</a></li>
-<li><a href="#_module_overview">Module Overview</a>
-<ul class="sectlevel2">
-<li><a href="#_core_required">Core (required)</a></li>
-<li><a href="#_security_optional">Security (optional)</a></li>
-<li><a href="#_jpa_optional">JPA (optional)</a></li>
-<li><a href="#_jsf_optional">JSF (optional)</a></li>
-<li><a href="#_container_control_optional">Container Control (optional)</a></li>
-<li><a href="#_bean_validation_optional">Bean Validation (optional)</a></li>
-<li><a href="#_servlet_optional">Servlet (optional)</a></li>
-<li><a href="#_partial_bean_optional">Partial-Bean (optional)</a></li>
-<li><a href="#_data_optional">Data (optional)</a></li>
-<li><a href="#_test_control_optional">Test-Control (optional)</a></li>
-<li><a href="#_scheduler_optional">Scheduler (optional)</a></li>
-</ul>
-</li>
-<li><a href="#_deltaspike_spi">DeltaSpike SPI</a></li>
-<li><a href="#_external">External</a>
-<ul class="sectlevel2">
-<li><a href="#_blogs">Blogs</a></li>
-<li><a href="#_add_ons">Add-ons</a></li>
-<li><a href="#_project_templates">Project Templates</a></li>
-<li><a href="#_examples">Examples</a></li>
-</ul>
-</li>
-</ul>
+
<hr>
- <div class="sect1">
-<h2 id="_introduction">Introduction</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Apache DeltaSpike project has been created to support the development of
-portable CDI extensions that provide useful features for Java
-applications not provided out of the box by the CDI spec (Security, JPA,
-…​). CDI extensions created by the DeltaSpike community are packaged as
-modules.</p>
-</div>
-<div class="paragraph">
-<p>Therefore, Apache DeltaSpike is a great toolbox for CDI. More than a set
-of powerful extension and tools to ease extension development,
-DeltaSpike also proves that CDI allows Java EE to evolve between each
-release.</p>
-</div>
-<div class="paragraph">
-<p>The goal of the project is also to provide useful classes to :</p>
-</div>
+ <div class="ulist">
+<ul>
+<li>
+<p>Get Started</p>
<div class="ulist">
<ul>
<li>
-<p>Boot CDI Container (Weld, OpenWebbeans, OpenEJB) for Java SE,</p>
+<p><a href="overview.html">Overview of DeltaSpike</a></p>
</li>
<li>
-<p>Stage a project,</p>
+<p><a href="configure.html">Configure DeltaSpike in Your Projects</a></p>
</li>
<li>
-<p>Provide new scopes (Window Scope, …​),</p>
+<p><a href="cdiimp.html">Enable CDI For Your Java Environment</a></p>
</li>
<li>
-<p>Manage messages and configurations</p>
+<p><a href="examples.html">See DeltaSpike in Action</a></p>
</li>
</ul>
</div>
-<div class="paragraph">
-<p>The project is currently tested on different CDI implementations like
-Apache OpenWebBeans and JBoss Weld, and also on different Java Web
-containers like Apache TomEE or JavaEE, JBoss AS7, Oracle GlassFish
-3.1+, Oracle WebLogic Server 12c.</p>
-</div>
-<div class="sect2">
-<h3 id="_what_is_a_portable_cdi_extension">What is a portable CDI extension ?</h3>
-<div class="paragraph">
-<p>A portable CDI extension means that CDI itself can be extended. Such
-extensions can be used with any spec. compliant CDI implementation. From
-the user perspective, it means that you can simply drop in CDI extension
-jars into your runtime e.g. to integrate third-party APIs with CDI or to
-improve existing JavaEE-APIs.</p>
-</div>
-<div class="paragraph">
-<p>The CDI Portable extensions SPI (Service Provider Interface) allows to
-define additional beans, scopes, stereotypes, interceptors and
-decorators. The SPI of CDI is a powerful vehicle for innovation and
-DeltaSpike is an example of it.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_deltaspike_in_a_nutshell">DeltaSpike in a nutshell</h3>
-<div class="sect3">
-<h4 id="_java_ee_7_without_java_ee_7">Java EE 7 without Java EE 7!</h4>
-<div class="paragraph">
-<p><strong>Transactional support for non-EJB beans:</strong> The Transactional Interceptor
-in DeltaSpike paved the way for @Transactional in Java EE 7.</p>
-</div>
-<div class="paragraph">
-<p><strong>Injectable Servlet objects:</strong> Allows the developer to inject CDI beans
-on Servlets on Java EE 6/CDI 1.0 environments</p>
-</div>
-<div class="paragraph">
-<p><strong>Injectable resources:</strong> Configuration, resource bundles,…​ are easy to
-inject when using CDI and Apache DeltaSpike.</p>
-</div>
-<div class="paragraph">
-<p><strong>@Exclude annotation:</strong> it’s possible to annotate beans which should be
-ignored by CDI even if they are in a CDI enabled archive on Java EE
-6/CDI 1.0 environment where you can’t use @Vetoed or a veto based on
-project-stages or expressions is needed.</p>
-</div>
-<div class="paragraph">
-<p><strong>Scheduling tasks</strong>: Async processes in a non Java EE 7 environment.</p>
-</div>
-<div class="paragraph">
-<p><strong>Bean Validation integration:</strong> Allows to inject CDI beans and EJB in to
-Constraint-Validators.</p>
-</div>
-<div class="paragraph">
-<p><strong>BeanProvider:</strong> Access the BeanManager and CDI beans even in non managed
-classes like JPA-2.0 EntityListeners or Spring Beans.</p>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_jsf_improvements">JSF Improvements</h4>
-<div class="paragraph">
-<p><strong>Multi-window handling:</strong> Allows to manage logical windows for
-batches,…​ or in case of JSF it offers proper separation of
-browser-tabs.</p>
-</div>
-<div class="paragraph">
-<p><strong>Type-safe view-config:</strong> It allows to bind meta-data (e.g. for security)
-to views with a type-safe, but flexible approach. It provides a more
-solid navigation in case of JSF and helps a lot in the maintenance
-phase.</p>
-</div>
-<div class="paragraph">
-<p><strong>View-Controller:</strong> Based on type-safe view-configs view-controller
-annotations provide a type-safe alternative to standard-tags.</p>
-</div>
-<div class="paragraph">
-<p><strong>Injection on Converters and Validators:</strong> Allows to inject CDI beans and
-EJB in to JSF Converters and Validators.</p>
-</div>
-<div class="paragraph">
-<p><strong>JSF event broadcasting to CDI:</strong> Allows CDI to be notified about JSF
-events</p>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_productivity_improvements">Productivity Improvements</h4>
-<div class="paragraph">
-<p><strong>Security based on annotations:</strong> The foundation for building a robust,
-capable and non invasive security solution.</p>
-</div>
-<div class="paragraph">
-<p><strong>New CDI scopes:</strong> TransactionScoped, WindowScoped, ViewScoped,
-ViewAccess scope, Grouped conversion scope</p>
-</div>
-<div class="paragraph">
-<p><strong>Container Control & Test Control:</strong> Java SE with CDI, all with a
-unifying API. Start, stop, add classes to a running CDI container.</p>
-</div>
-<div class="paragraph">
-<p><strong>Data Module:</strong> An out of the box entity framework solution complete with
-support for container or application managed persistence contexts, as
-well as JDBC.</p>
-</div>
-<div class="paragraph">
-<p><strong>Decoupled Exception handling:</strong> Allows to do exception handling in one
-location similar to CDI Observers.</p>
-</div>
-<div class="paragraph">
-<p><strong>JMX integration:</strong> Any CDI bean can be exposed via JMX easily with one
-annotation.</p>
-</div>
-<div class="paragraph">
-<p><strong>Type-safe i18n messages:</strong> Localized messages are easy to use with an
-interface and a resource bundle, no more boilerplate and your messages
-now have context within the code.</p>
-</div>
-<div class="paragraph">
-<p><strong>Type-safe Project-Stages:</strong> Compared to project-stages in JSF,
-DeltaSpike provides a type-safe, but still extensible approach which can
-be used in CDI based applications.</p>
-</div>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_getting_started">Getting Started</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>A DeltaSpike project can be designed using or not Apache Maven and
-consists in a collection of jar files. Depending on your needs, you will
-package DeltaSpike core jar (api and impl) files or extend the list with
-DeltaSpike modules. DeltaSpike Api and Impl are mandatory and provide
-code required to benefits of portable CDI extensions or useful features
-created.</p>
-</div>
-<div class="paragraph">
-<p>Remark : For Java SE, an additional step is required as you have to
-select the CDI implementation of your choice to boot a CDI container.</p>
-</div>
-<div class="paragraph">
-<p>[TODO] Add a section or remark to explain how to package & deploy
-DeltaSpike in an OSGI environment (Apache Felix, Apache Karaf, Apache
-ServiceMix)</p>
-</div>
-<div class="sect2">
-<h3 id="_project_configuration_without_maven">Project Configuration without Maven</h3>
-<div class="paragraph">
-<p>You can manually download all JARs described above or you get <a href="source.html">the source-code</a> and <a href="build.html">build</a> DeltaSpike
-manually.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_project_configuration_with_maven">Project Configuration with Maven</h3>
-<div class="paragraph">
-<p><strong>Hint:</strong> In the listings below replace the placeholders for the version with the version of your choice or use:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
- <span class="tag"><deltaspike.version></span>1.0.3<span class="tag"></deltaspike.version></span>
-<span class="tag"></properties></span></code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Or if you want to very bleeding edge, point to our current snapshot.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
- <span class="tag"><deltaspike.version></span>1.0.4-SNAPSHOT<span class="tag"></deltaspike.version></span>
-<span class="tag"></properties></span></code></pre>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_configuration_of_deltaspike_core">Configuration of DeltaSpike Core</h4>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-core-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-core-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_configuration_of_deltaspike_modules">Configuration of DeltaSpike Modules</h4>
-<div class="sect4">
-<h5 id="_security_module">Security Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-security-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-security-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_jpa_module">JPA Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-jpa-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-jpa-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_jsf_module">JSF Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-jsf-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-jsf-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Some EE6 servers can’t handle optional classes. If you don’t like the
-corresponding log entries during the startup or the deployment fails,
-you can use an alternative impl-module (instead of
-deltaspike-jsf-module-impl) since v1.0.1:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-jsf-module-impl-ee6<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_bean_validation_module">Bean Validation Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-bean-validation-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_servlet_module">Servlet Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-servlet-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-servlet-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_data_module">Data Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-data-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-data-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_test_control_module">Test-Control Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-test-control-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>test<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-test-control-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>test<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_scheduler_module">Scheduler Module</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-scheduler-module-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-scheduler-module-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_with_java_se">With Java SE</h4>
-<div class="paragraph">
-<p>To use DeltaSpike with Java SE, we must provide additional jars file
-corresponding to the DeltaSpike CDI Controller API and its
-implementation. The Controller uses Java Services to resolve the CDI
-container
-(<a href="http://docs.jboss.org/weld/reference/1.1.5.Final/en-US/html/">JBoss
-Weld</a>, <a href="http://openwebbeans.apache.org">Apache OpenWebbeans</a> (and
-<a href="http://openejb.apache.org">Apache OpenEJB</a>)) and implementation contains
-the code to manage the <a href="#_container_control_optional">CDI container and contexts</a>.</p>
-</div>
-<div class="paragraph">
-<p><strong>Hint:</strong> In the listings below replace the placeholders for the version
-with the version of your choice or use:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
- <span class="tag"><deltaspike.version></span>1.0.0<span class="tag"></deltaspike.version></span>
- <span class="tag"><owb.version></span>1.2.0<span class="tag"></owb.version></span>
- <span class="tag"><weld.version></span>1.1.9.Final<span class="tag"></weld.version></span>
-<span class="tag"></properties></span></code></pre>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_add_the_deltaspike_container_ctrl_api">Add the DeltaSpike Container Ctrl API</h5>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.cdictrl<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-cdictrl-api<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_add_a_cdi_container_container_ctrl_impl">Add a CDI container + Container Ctrl Impl</h5>
-
-</div>
-</div>
-<div class="sect3">
-<h4 id="__for_apache_openwebbeans">…​ for Apache OpenWebBeans</h4>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.openwebbeans<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>openwebbeans-impl<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${owb.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.openwebbeans<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>openwebbeans-spi<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${owb.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.cdictrl<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-cdictrl-owb<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="__for_jboss_weld_ri">…​ for JBoss Weld (RI)</h4>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.cdictrl<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-cdictrl-weld<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span>
-
-<span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.jboss.weld.se<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>weld-se<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${weld.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_for_embedded_servlet_runtimes_you_can_add">For Embedded Servlet Runtimes, you can add</h4>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.apache.deltaspike.cdictrl<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>deltaspike-cdictrl-servlet<span class="tag"></artifactId></span>
- <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
- <span class="tag"><scope></span>compile<span class="tag"></scope></span>
-<span class="tag"></dependency></span></code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_testing_snapshots">Testing Snapshots</h4>
-<div class="paragraph">
-<p>If you would like to test the latest Snapshot, you can <a href="build.html">build</a> DeltaSpike locally or you
-get it from the Apache Snapshot-Repository:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><repositories></span>
- <span class="tag"><repository></span>
- <span class="tag"><id></span>apache-snapshot-repository<span class="tag"></id></span>
- <span class="tag"><url></span>http://repository.apache.org/snapshots/<span class="tag"></url></span>
- <span class="tag"><releases></span>
- <span class="tag"><enabled></span>false<span class="tag"></enabled></span>
- <span class="tag"></releases></span>
- <span class="tag"><snapshots></span>
- <span class="tag"><enabled></span>true<span class="tag"></enabled></span>
- <span class="tag"></snapshots></span>
- <span class="tag"></repository></span>
-<span class="tag"></repositories></span></code></pre>
-</div>
-</div>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_deployment_mode">Deployment mode</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>DeltaSpike can be deployed in different Java environments. Depending
-which Java container and release you are using, the procedure which is
-different is explained here after.</p>
-</div>
-<div class="sect2">
-<h3 id="_with_java_ee6">With Java EE6+</h3>
-<div class="paragraph">
-<p>If you are using DeltaSpike in a Java EE6 environment, you don’t need to
-configure a CDI implementation explicitly because it’s shipped with the
-container.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_with_java_ee5_or_servlet_containers">With Java EE5 or Servlet Containers</h3>
-<div class="paragraph">
-<p>Java EE5 application servers as well as pure servlet containers like
-Apache Tomcat / Eclipse Jetty don’t provide a CDI implementation
-out-of-the-box. So don’t forget to setup the CDI implementation of your
-choice.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_standard_java_se6">Standard Java SE6+</h3>
-<div class="paragraph">
-<p>If you are only using a JDK and runs Java in a standalone or standard
-mode (Java SE), then DeltaSpike will allow you to boot a CDI
-implementation where you can use Dependency Injection with a Bean
-Manager. Such an example will be presented at the next section.</p>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_start_a_cdi_container_using_java_se">Start a CDI container using Java SE</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>This code snippet show you how with a Java MainApplication a CDI
-container can be started (= boot) by DeltaSpike using Java SE and how
-you define a CDI scope and resolve beans injected.</p>
-</div>
-<div class="paragraph">
-<p><strong>Hint</strong>: To bootstrap a CDI container in your Java application, you
-just need to instantiate the <code>CdiContainer</code> and call the <code>#boot</code> method.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">import</span> <span class="include">org.apache.deltaspike.cdise.api.CdiContainer</span>;
-<span class="keyword">import</span> <span class="include">org.apache.deltaspike.cdise.api.CdiContainerLoader</span>;
-
-<span class="directive">public</span> <span class="type">class</span> <span class="class">MainApp</span> {
- <span class="directive">public</span> <span class="directive">static</span> <span class="type">void</span> main(<span class="predefined-type">String</span><span class="type">[]</span> args) {
-
- CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer();
- cdiContainer.boot();
-
- <span class="comment">// You can use CDI here</span>
-
- cdiContainer.shutdown();
- }
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>When <code>#boot</code> is called, the <code>CdiContainer</code> will scan CDI enabled
-archives for beans and CDI extensions.</p>
-</div>
-<div class="paragraph">
-<p><strong>Note</strong>: Booting the container does not automatically start all CDI
-Contexts!</p>
-</div>
-<div class="paragraph">
-<p>Example for starting the application-context:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">import</span> <span class="include">org.apache.deltaspike.cdise.api.CdiContainer</span>;
-<span class="keyword">import</span> <span class="include">org.apache.deltaspike.cdise.api.CdiContainerLoader</span>;
-<span class="keyword">import</span> <span class="include">org.apache.deltaspike.cdise.api.ContextControl</span>;
-<span class="keyword">import</span> <span class="include">javax.enterprise.context.ApplicationScoped</span>;
-
-<span class="directive">public</span> <span class="type">class</span> <span class="class">MainApp</span> {
- <span class="directive">public</span> <span class="directive">static</span> <span class="type">void</span> main(<span class="predefined-type">String</span><span class="type">[]</span> args) {
-
- CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer();
- cdiContainer.boot();
-
- <span class="comment">// Starting the application-context allows to use @ApplicationScoped beans</span>
- ContextControl contextControl = cdiContainer.getContextControl();
- contextControl.startContext(ApplicationScoped.class);
-
- <span class="comment">// You can use CDI here</span>
-
- cdiContainer.shutdown();
- }
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>To resolve a bean of this project, you can use the <code>BeanProvider</code>
-provided by DeltaSpike. The following example shows how to resolve the a
-bean without qualifiers. It depends on the application if <code>EchoService</code>
-is a concrete implementation or just an interface. In case of an
-interface the corresponding implementation will be resolved. The
-resolved bean is a normal CDI bean which means you can use all CDI
-concepts like <code>@Inject</code> in the class (and you don’t need further usages
-of <code>BeanProvider</code>).</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java">EchoService echoService = BeanProvider.getContextualReference(EchoService.class, <span class="predefined-constant">false</span>);</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Before the application exits, you have to call <code>#shutdown</code> to destroy
-beans,…​ in a well-ordered fashion.</p>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_module_overview">Module Overview</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>The core features of DeltaSpike project are packaged under the following
-different modules. Some of them are mandatory while others are optional.</p>
-</div>
-<div class="sect2">
-<h3 id="_core_required">Core (required)</h3>
-<div class="paragraph">
-<p>Definition : Contain the API and util classes of DeltaSpike project</p>
-</div>
-<a class="btn" href="core.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_security_optional">Security (optional)</h3>
-<div class="paragraph">
-<p>Definition : Intercept and check security</p>
-</div>
-<a class="btn" href="security.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_jpa_optional">JPA (optional)</h3>
-<div class="paragraph">
-<p>Definition :</p>
-</div>
-<a class="btn" href="jpa.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_jsf_optional">JSF (optional)</h3>
-<div class="paragraph">
-<p>Definition :</p>
-</div>
-<a class="btn" href="jsf.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_container_control_optional">Container Control (optional)</h3>
-<div class="paragraph">
-<p>Definition :</p>
-</div>
-<a class="btn" href="container-control.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_bean_validation_optional">Bean Validation (optional)</h3>
-<div class="paragraph">
-<p>Definition : A module for adding CDI support in Bean Validation.</p>
-</div>
-<div class="paragraph">
-<p>Features : Allows a developer to create CDI aware `ConstraintValidator`s
-that can use business objects (EJBs, ManagedBeans) to support validation
-needs.</p>
-</div>
-<a class="btn" href="bean-validation.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_servlet_optional">Servlet (optional)</h3>
-<div class="paragraph">
-<p>Definition : The DeltaSpike Servlet module provides integration with the
-Java Servlet API.</p>
-</div>
-<div class="paragraph">
-<p>Features :</p>
-</div>
+</li>
+<li>
+<p>Use Individual Modules</p>
<div class="ulist">
<ul>
<li>
-<p>Injection of common servlet objects.</p>
+<p><a href="modules.html">Overview of DeltaSpike Modules</a></p>
</li>
<li>
-<p>Propagation of servlet events to the CDI event bus.</p>
+<p><a href="core.html">Core</a></p>
</li>
-</ul>
-</div>
-<a class="btn" href="servlet.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_partial_bean_optional">Partial-Bean (optional)</h3>
-<a class="btn" href="partial-bean.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_data_optional">Data (optional)</h3>
-<div class="paragraph">
-<p>Definition : The DeltaSpike Data module provides enhanced JPA experience
-with declarative queries, reducing boilerplate to a minimum.</p>
-</div>
-<div class="paragraph">
-<p>Features :</p>
-</div>
-<div class="ulist">
-<ul>
<li>
-<p>Derive queries by simple method names or by method annotations
-defining JPQL, named queries or plain SQL</p>
+<p><a href="bean-validation.html">Bean Validation</a></p>
</li>
<li>
-<p>Result pagination and sorting</p>
+<p><a href="container-control.html">Container Control</a></p>
</li>
<li>
-<p>Auditing of entities</p>
+<p><a href="data.html">Data</a></p>
</li>
<li>
-<p>A simplified alternative to the Criteria API</p>
+<p><a href="jpa.html">JPA</a></p>
</li>
<li>
-<p>Mapping of entities from and to DTOs</p>
+<p><a href="jsf.html">JSF</a></p>
+</li>
+<li>
+<p><a href="partial-bean.html">Partial-Bean</a></p>
+</li>
+<li>
+<p><a href="scheduler.html">Scheduler</a></p>
</li>
-</ul>
-</div>
-<a class="btn" href="data.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_test_control_optional">Test-Control (optional)</h3>
-<div class="paragraph">
-<p>Definition : This module allows to write CDI based tests easily.</p>
-</div>
-<a class="btn" href="test-control.html">View details »</a>
-</div>
-<div class="sect2">
-<h3 id="_scheduler_optional">Scheduler (optional)</h3>
-<div class="paragraph">
-<p>Definition : This module provides a simple integration with Quartz v2
-(per default) or any other scheduler which supports cron-expressions for
-job-classes.</p>
-</div>
-<a class="btn" href="scheduler.html">View details »</a>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_deltaspike_spi">DeltaSpike SPI</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>DeltaSpike Service Provider Interface (SPI)</p>
-</div>
-<a class="btn" href="spi.html">View details »</a>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_external">External</h2>
-<div class="sectionbody">
-<div class="sect2">
-<h3 id="_blogs">Blogs</h3>
-<div class="ulist">
-<ul>
<li>
-<p><a href="http://os890.blogspot.com/search/label/deltaspike" class="bare">http://os890.blogspot.com/search/label/deltaspike</a></p>
+<p><a href="security.html">Security</a></p>
+</li>
+<li>
+<p><a href="servlet.html">Servlet</a></p>
+</li>
+<li>
+<p><a href="test-control.html">Test-Control</a></p>
</li>
</ul>
</div>
-</div>
-<div class="sect2">
-<h3 id="_add_ons">Add-ons</h3>
+</li>
+<li>
+<p>Advanced Information</p>
<div class="ulist">
<ul>
<li>
-<p><a href="https://github.com/os890/ds-monitoring-addon">Monitoring- and Auditing</a></p>
+<p><a href="build.html">Build and Test DeltaSpike from Source</a></p>
</li>
<li>
-<p><a href="https://github.com/os890/ds-spring-bridge-addon">CDI/Spring Bridge</a></p>
+<p><a href="snapshots.html">Use DeltaSpike Snapshots</a></p>
</li>
<li>
-<p><a href="https://github.com/os890/ds-disruptor-addon">Fast events via Disruptor</a></p>
+<p><a href="https://deltaspike.apache.org/migration-guide.html">Migrate to DeltaSpike</a></p>
+</li>
+<li>
+<p><a href="source.html">Contribute to the DeltaSpike Source</a></p>
+</li>
+<li>
+<p><a href="spi.html">DeltaSpike Service Provider Interface (SPI)</a></p>
</li>
</ul>
</div>
-</div>
-<div class="sect2">
-<h3 id="_project_templates">Project Templates</h3>
+</li>
+<li>
+<p>Access More DeltaSpike Resources</p>
<div class="ulist">
<ul>
<li>
-<p><a href="https://github.com/os890/javase-cdi-ds-project-template">Java SE + CDI + DS</a></p>
-</li>
-<li>
-<p><a href="https://github.com/os890/javaweb-cdi-ds-project-template">JSF + CDI + DS (Servlet-Container)</a></p>
+<p><a href="articles.html">Articles and Blogs</a></p>
</li>
<li>
-<p><a href="https://github.com/os890/javaee_cdi_ejb_ds_project_template">EJB + CDI + DS (Module)</a></p>
+<p><a href="addons.html">Add-ons</a></p>
</li>
<li>
-<p><a href="https://github.com/os890/javaee_jsf_cdi_ejb_ds_project_template">JSF + EJB + CDI + DS (EE-Server)</a></p>
+<p><a href="external.html">External Examples</a></p>
</li>
</ul>
</div>
-</div>
-<div class="sect2">
-<h3 id="_examples">Examples</h3>
-<div class="paragraph">
-<p>See <a href="../examples.html#External">External Examples</a></p>
-</div>
-</div>
-</div>
+</li>
+</ul>
</div>
</div>
Modified: websites/staging/deltaspike/trunk/content/staging/documentation/jpa.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/staging/documentation/jpa.html (original)
+++ websites/staging/deltaspike/trunk/content/staging/documentation/jpa.html Sun Dec 14 23:27:55 2014
@@ -169,28 +169,65 @@ body {
<div id="toc" class="toc">
<ul class="sectlevel1">
+<li><a href="#_overview">Overview</a></li>
+<li><a href="#_configure_your_projects">Configure Your Projects</a>
+<ul class="sectlevel2">
+<li><a href="#_1_declare_jpa_module_dependencies">1. Declare JPA Module Dependencies</a></li>
+<li><a href="#_2_enable_the_transaction_interceptor">2. Enable the Transaction Interceptor</a></li>
+</ul>
+</li>
+<li><a href="#_use_the_module_features">Use the Module Features</a>
+<ul class="sectlevel2">
<li><a href="#__transactional">@Transactional</a></li>
<li><a href="#__transactionscoped">@TransactionScoped</a></li>
<li><a href="#_extended_persistence_contexts">Extended Persistence Contexts</a></li>
<li><a href="#_jta_support">JTA Support</a></li>
</ul>
+</li>
+</ul>
<hr>
<div class="sect1">
-<h2 id="__transactional">@Transactional</h2>
+<h2 id="_overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>This annotation is an alternative to transactional EJBs which allows to
-execute a method within a transaction. Before it’s possible to start
-using the annotation, it’s required to implement a CDI producer for an
-<code>EntityManager</code> and it’s needed to inject the <code>EntityManager</code> in the
-bean which uses <code>@Transactional</code>. As shown later on it’s also possible
-to use multiple qualifiers for using different `EntityManager`s.</p>
+<p>The JPA module provides a transactional context and scope, enabling execution of methods within transactions.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_configure_your_projects">Configure Your Projects</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p>
+</div>
+<div class="sect2">
+<h3 id="_1_declare_jpa_module_dependencies">1. Declare JPA Module Dependencies</h3>
+<div class="paragraph">
+<p>Add the JPA module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
+ <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
+ <span class="tag"><artifactId></span>deltaspike-jpa-module-api<span class="tag"></artifactId></span>
+ <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
+ <span class="tag"><scope></span>compile<span class="tag"></scope></span>
+<span class="tag"></dependency></span>
+
+<span class="tag"><dependency></span>
+ <span class="tag"><groupId></span>org.apache.deltaspike.modules<span class="tag"></groupId></span>
+ <span class="tag"><artifactId></span>deltaspike-jpa-module-impl<span class="tag"></artifactId></span>
+ <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
+ <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
+<span class="tag"></dependency></span></code></pre>
</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_2_enable_the_transaction_interceptor">2. Enable the Transaction Interceptor</h3>
<div class="paragraph">
-<p><strong>Hint:</strong> If you are using features described by this page with CDI 1.0
-(or DeltaSpike up to v1.1.0 with CDI 1.1+), you have
-to enable the transaction interceptor in your beans.xml file:</p>
+<p>For CDI 1.0 (or DeltaSpike v1.1.0 and earlier together with CDI 1.1+), you must enable the transaction interceptor in the project <code>beans.xml</code> file:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -202,17 +239,31 @@ to enable the transaction interceptor in
<span class="tag"></beans></span></code></pre>
</div>
</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_use_the_module_features">Use the Module Features</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="__transactional">@Transactional</h3>
+<div class="paragraph">
+<p>This annotation is an alternative to transactional EJBs which allows to
+execute a method within a transaction. Before it is possible to start
+using the annotation, it is required to implement a CDI producer for an
+<code>EntityManager</code> and it is needed to inject the <code>EntityManager</code> in the
+bean which uses <code>@Transactional</code>. As shown later on, it is also possible
+to use multiple qualifiers for using different `EntityManager`s.</p>
+</div>
<div class="paragraph">
<p>The following example shows a simple producer for an <code>EntityManager</code> and
the corresponding dispose-method. Producing it as request scoped bean
means that the dispose method will be called on finishing the request.
-As an alternative it’s possible to use a special scope called
+As an alternative it is possible to use a special scope called
<code>@TransactionScoped</code> provided by the same DeltaSpike module.</p>
</div>
-<div class="paragraph">
-<p>Producer for the default EntityManager (<strong>no EE-Server</strong>):</p>
-</div>
<div class="listingblock">
+<div class="title">Producer for the Default EntityManager (<strong>no EE-Server</strong>)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">EntityManagerProducer</span>
@@ -238,10 +289,8 @@ As an alternative it’s possible to
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Producer for the default EntityManager (<strong>EE-Server</strong>):</p>
-</div>
<div class="listingblock">
+<div class="title">Producer for the Default EntityManager (<strong>EE-Server</strong>)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">EntityManagerProducer</span>
@@ -271,10 +320,8 @@ As an alternative it’s possible to
<p>The following examples show how to use the <code>EntityManager</code> produced by
the example above.</p>
</div>
-<div class="paragraph">
-<p>Beans with transactional method:</p>
-</div>
<div class="listingblock">
+<div class="title">Beans with Transactional Method</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">TransactionalBean</span>
@@ -290,10 +337,8 @@ the example above.</p>
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Simple transactional bean (all methods transactional):</p>
-</div>
<div class="listingblock">
+<div class="title">Simple Transactional Bean (All Methods are Transactional)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="annotation">@Transactional</span>
@@ -307,13 +352,11 @@ the example above.</p>
</div>
</div>
<div class="paragraph">
-<p>As illustrated in the following example it’s also possible to use
+<p>As illustrated in the following example it is also possible to use
<code>@Transactional</code> for stereotypes.</p>
</div>
-<div class="paragraph">
-<p>Stereotype for transactional beans (+ usage):</p>
-</div>
<div class="listingblock">
+<div class="title">Stereotype for Transactional Beans (+ Usage)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Stereotype</span>
<span class="annotation">@Transactional</span>
@@ -334,16 +377,14 @@ the example above.</p>
</div>
</div>
<div class="paragraph">
-<p>Besides such simple usages, it’s also supported to use qualifiers to
+<p>Besides such simple usages, it is also supported to use qualifiers to
access multiple persistence-units in parallel. The default qualifier for
<code>@Transactional</code> is <code>@Any</code>. Therefore a transaction for every injected
entity manager will be started. The example afterwards shows how to
change this default behaviour.</p>
</div>
-<div class="paragraph">
-<p>Producer for multiple entity managers (+ usage):</p>
-</div>
<div class="listingblock">
+<div class="title">Producer for Multiple Entity Managers (+ Usage)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">EntityManagerProducer</span>
@@ -422,10 +463,8 @@ change this default behaviour.</p>
<p>The following example shows how to use only the specified
<code>EntityManager</code>/s</p>
</div>
-<div class="paragraph">
-<p>Activating entity managers manually:</p>
-</div>
<div class="listingblock">
+<div class="title">Activating Entity Managers Manually</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">MultiTransactionBean</span>
{
@@ -465,10 +504,8 @@ change this default behaviour.</p>
transaction handling is done on the entry point (after
FirstLevelTransactionBean#executeInTransaction).</p>
</div>
-<div class="paragraph">
-<p>Joining existing transaction in nested call:</p>
-</div>
<div class="listingblock">
+<div class="title">Joining Existing Transaction in Nested Call</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">FirstLevelTransactionBean</span>
@@ -503,15 +540,13 @@ FirstLevelTransactionBean#executeInTrans
<div class="paragraph">
<p>The final transaction handling for all <code>EntityManager</code> s is also done
after the outermost transactional method if <code>NestedTransactionBean</code> uses
-a different <code>EntityManager</code>. So it’s possible to catch an exception in
-<code>FirstLevelTransactionBean</code> e.g. to try an optional path instead of an
+a different <code>EntityManager</code>. So it is possible to catch an exception in
+<code>FirstLevelTransactionBean</code>, for example, to try an optional path instead of an
immediate rollback.</p>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="__transactionscoped">@TransactionScoped</h2>
-<div class="sectionbody">
+<div class="sect2">
+<h3 id="__transactionscoped">@TransactionScoped</h3>
<div class="paragraph">
<p><code>@Transactional</code> also starts a context which is available as long as the
transaction started by <code>@Transactional</code>. Besides other beans you can use
@@ -520,8 +555,8 @@ this scope for the <code>EntityManager</
<code>@Transactional</code>.</p>
</div>
<div class="paragraph">
-<p>Producer for the default EntityManager which should be used only for one
-transaction:</p>
+<div class="title">Producer for the Default EntityManager which should be Used Only for One</div>
+<p>Transaction</p>
</div>
<div class="listingblock">
<div class="content">
@@ -550,46 +585,39 @@ transaction:</p>
</div>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="_extended_persistence_contexts">Extended Persistence Contexts</h2>
-<div class="sectionbody">
+<div class="sect2">
+<h3 id="_extended_persistence_contexts">Extended Persistence Contexts</h3>
<div class="paragraph">
<p>Frameworks like MyFaces Orchestra provide a feature which allows keeping
-an <code>EntityManager</code> across multiple requests. That means it isn’t
+an <code>EntityManager</code> across multiple requests. That means it is not
required to call <code>EntityManager#merge</code> to add detached entities to the
-context. However, several application architectures don’t allow such an
+context. However, several application architectures do not allow such an
approach (due to different reasons like scalability). In theory that
sounds nice and it works pretty well for small to medium sized projects
-esp. if an application doesn’t rely on session replication in clusters.
+especially if an application does not rely on session replication in clusters.
That also means that such an approach restricts your target environment
from the very beginning. One of the base problems is that an
-<code>EntityManager</code> isn’t serializable. Beans which are scoped in a
+<code>EntityManager</code> is not serializable. Beans which are scoped in a
normal-scoped CDI context have to be serializable. So by default it
-isn’t allowed by CDI to provide a producer-method which exposes e.g. a
-conversation scoped <code>EntityManager</code> as it is. We <strong>don’t</strong> recommend to
-use this approach and therefore it isn’t available out-of-the-box.
+is not allowed by CDI to provide a producer-method which exposes, for example, a
+conversation scoped <code>EntityManager</code> as it is. We <strong>do not</strong> recommend this approach and therefore it is not available out-of-the-box.
However, if you really need this approach to avoid calling <code>#merge</code> for
-your detached entities, it’s pretty simple to add this functionality.</p>
-</div>
-<div class="paragraph">
-<p>Usage of a simple <code>ExtendedEntityManager</code></p>
+your detached entities, it is pretty simple to add this functionality.</p>
</div>
<div class="listingblock">
+<div class="title">Usage of a Simple <code>ExtendedEntityManager</code></div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Inject</span>
<span class="directive">private</span> EntityManager entityManager;</code></pre>
</div>
</div>
<div class="paragraph">
-<p>As you see the usage is the same. You <strong>don’t</strong> have to use
-<code>ExtendedEntityManager</code> at the injection point. It’s just needed in the
+<p>As you see the usage is the same. You <strong>do not</strong> have to use
+<code>ExtendedEntityManager</code> at the injection point. It is just needed in the
producer-method:</p>
</div>
-<div class="paragraph">
-<p>Producer for the default Extended-<code>EntityManager</code> (<strong>no EE-Server</strong>):</p>
-</div>
<div class="listingblock">
+<div class="title">Producer for the Default Extended-<code>EntityManager</code> (<strong>no EE-Server</strong>)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//...</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">ExtendedEntityManagerProducer</span>
@@ -615,10 +643,8 @@ producer-method:</p>
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Producer for the default Extended-<code>EntityManager</code> (<strong>EE-Server</strong>):</p>
-</div>
<div class="listingblock">
+<div class="title">Producer for the Default Extended-<code>EntityManager</code> (<strong>EE-Server</strong>)</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">ExtendedEntityManagerProducer</span>
@@ -644,10 +670,8 @@ producer-method:</p>
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Implementation of a simple <code>ExtendedEntityManager</code>:</p>
-</div>
<div class="listingblock">
+<div class="title">Implementation of a Simple <code>ExtendedEntityManager</code></div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Typed</span>()
<span class="directive">public</span> <span class="type">class</span> <span class="class">ExtendedEntityManager</span> <span class="directive">implements</span> EntityManager, <span class="predefined-type">Serializable</span>
@@ -673,26 +697,24 @@ producer-method:</p>
</div>
</div>
<div class="paragraph">
-<p>This approach just works if it <strong>doesn’t come to serialization</strong> of this
-wrapper e.g. in case of session-replication. If those beans get
+<p>This approach just works if it <strong>does not come to serialization</strong> of this
+wrapper, for example in case of session-replication. If those beans get
serialized, you have to overcome this restriction by storing the
persistence-unit-name and recreate the <code>EntityManager</code> via
<code>Persistence.createEntityManagerFactory(this.persistenceUnitName).createEntityManager();</code>
and sync it with the database before closing it on serialization.
Furthermore, you have to intercept some methods of the <code>EntityManager</code>
to merge detached entities automatically if those entities get
-serialized as well. However, as mentioned before <strong>we don’t recommend</strong>
+serialized as well. However, as mentioned before <strong>we do not recommend</strong>
such an approach.</p>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="_jta_support">JTA Support</h2>
-<div class="sectionbody">
+<div class="sect2">
+<h3 id="_jta_support">JTA Support</h3>
<div class="paragraph">
-<p>Per default the transaction-type used by <code>@Transactional`is
-'RESOURCE_LOCAL'. If you configure `transaction-type="JTA"`in the
-persistence.xml, you have to enable an alternative `TransactionStrategy</code>
+<p>By default the transaction-type used by <code>@Transactional</code> is
+<code>RESOURCE_LOCAL</code>. If you configure <code>transaction-type="JTA"</code> in the
+persistence.xml file, you have to enable an alternative <code>TransactionStrategy</code>
in the beans.xml which is called
<code>org.apache.deltaspike.jpa.impl.transaction.BeanManagedUserTransactionStrategy</code>.</p>
</div>
@@ -712,15 +734,23 @@ than the production settings, you can us
<code>org.apache.deltaspike.jpa.impl.transaction.EnvironmentAwareTransactionStrategy</code>
instead.</p>
</div>
-<div class="paragraph">
-<p><strong>Hint:</strong></p>
-</div>
-<div class="paragraph">
-<p>In case of some versions of Weld (or OpenWebBeans in BDA mode), you have
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+In case of some versions of Weld (or OpenWebBeans in BDA mode), you have
to configure it as global-alternative instead of an <code><alternatives></code> in
-beans.xml. That means you have to add e.g.:
-<code>globalAlternatives.org.apache.deltaspike.jpa.spi.transaction.TransactionStrategy=org.apache.deltaspike.jpa.impl.transaction.BeanManagedUserTransactionStrategy</code>
-to /META-INF/apache-deltaspike.properties</p>
+beans.xml. That means you have to add, for example,
+<code>globalAlternatives.org.apache.deltaspike.jpa.spi.transaction.TransactionStrategy
+=org.apache.deltaspike.jpa.impl.transaction.BeanManagedUserTransactionStrategy</code>
+to <code>/META-INF/apache-deltaspike.properties</code>
+</td>
+</tr>
+</table>
+</div>
</div>
</div>
</div>