From hibernate-commits at lists.jboss.org Tue Feb 26 16:54:02 2008
Content-Type: multipart/mixed; boundary="===============1363488116812232370=="
MIME-Version: 1.0
From: hibernate-commits at lists.jboss.org
To: hibernate-commits at lists.jboss.org
Subject: [hibernate-commits] Hibernate SVN: r14366 -
 core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content.
Date: Tue, 26 Feb 2008 16:54:02 -0500
Message-ID: <E1JU7kQ-0000i9-HT@committer01.frg.pub.inap.atl.jboss.com>

--===============1363488116812232370==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: bstansberry(a)jboss.com
Date: 2008-02-26 16:54:02 -0500 (Tue, 26 Feb 2008)
New Revision: 14366

Modified:
   core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/conf=
iguration.xml
   core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/intr=
oduction.xml
Log:
Document JTA requirement

Modified: core/trunk/documentation/jbosscache2/src/main/docbook/en-US/conte=
nt/configuration.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/con=
figuration.xml	2008-02-26 18:53:26 UTC (rev 14365)
+++ core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/con=
figuration.xml	2008-02-26 21:54:02 UTC (rev 14366)
@@ -37,11 +37,20 @@
             <title>Basics</title>
             =

             <para>
-              There are four basic steps to configuring the =

+              There are five basic steps to configuring the =

               <literal>SessionFactory</literal>:
               =

             <itemizedlist>
+            =

                 <listitem>
+                  <para>
+                    Make sure your Hibernate is configured to use JTA tran=
sactions.
+                    See <xref linkend=3D"introduction-requirements-transac=
tions"/>
+                    for details.
+                  </para>
+                </listitem>
+                =

+                <listitem>
                 <para>
                    Tell Hibernate you whether to enable caching of entitie=
s and =

                    collections. No need to set this property if you don't:

Modified: core/trunk/documentation/jbosscache2/src/main/docbook/en-US/conte=
nt/introduction.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/int=
roduction.xml	2008-02-26 18:53:26 UTC (rev 14365)
+++ core/trunk/documentation/jbosscache2/src/main/docbook/en-US/content/int=
roduction.xml	2008-02-26 21:54:02 UTC (rev 14366)
@@ -65,6 +65,8 @@
     <sect1 id=3D"introduction-requirements" revision=3D"1">
        <title>Requirements</title>
        =

+       <sect2 id=3D"introduction-requirements-dependencies" revision=3D"1">
+       <title>Dependencies</title>
        <para>
         Second level caching with JBoss Cache 2 requires the use of JBoss
         Cache 2.1.0 or later. The core JBoss Cache project is used; the
@@ -104,7 +106,44 @@
          and tell the <literal>SessionFactory</literal> to use them; see =

          <xref linkend=3D"sessionfactory"/> for details.
        </para>
+       </sect2>
        =

+       <sect2 id=3D"introduction-requirements-transactions" revision=3D"1">
+       <title>JTA Transactional Support</title>
+       <para>
+        JBoss Cache requires integration with a JTA =

+        <literal>TransactionManager</literal> in order to meet the require=
ments
+        of the second level caching use case.  This means your Hibernate
+        application must be configured to use JTA:
+       </para> =

+        <itemizedlist>
+          <listitem>
+            <para>
+            You must configure a <literal>hibernate.transaction.manager_lo=
okup_class</literal>.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+            You must configure a <literal>hibernate.transaction.factory_cl=
ass</literal>, =

+            specifying a transaction factory that supports JTA. In practic=
e, this means
+            <literal>org.hibernate.transaction.JTATransactionFactory</lite=
ral> if
+            you are using JTA directly, or <literal>org.hibernate.transact=
ion.CMTTransactionFactory</literal>
+            if you are accessing Hibernate via a CMT session bean.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+            Finally, make sure <literal>hibernate.current_session_context_=
class</literal>
+            is either unset (backwards compatiblity), or set to <literal>"=
jta"</literal>.
+            </para>
+          </listitem>
+        </itemizedlist>
+        =

+       <para>
+        See the <emphasis>Hibernate Reference Documentation</emphasis> for
+        an in-depth discussion of using Hibernate with JTA
+       </para>
+       </sect2>
     </sect1>
 =

     <sect1 id=3D"introduction-configuration" revision=3D"1">


--===============1363488116812232370==--