You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by ar...@apache.org on 2004/05/04 01:14:45 UTC
cvs commit: db-ojb/forrest/src/documentation/content/xdocs/docu deployment.xml
arminw 2004/05/03 16:14:45
Modified: forrest/src/documentation/content/xdocs/docu deployment.xml
Log:
update doc, add section how to access API main classes in managed environments
Revision Changes Path
1.4 +82 -32 db-ojb/forrest/src/documentation/content/xdocs/docu/deployment.xml
Index: deployment.xml
===================================================================
RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/deployment.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- deployment.xml 28 Apr 2004 08:03:52 -0000 1.3
+++ deployment.xml 3 May 2004 23:14:45 -0000 1.4
@@ -339,9 +339,6 @@
org.apache.ojb.broker.accesslayer.ConnectionFactoryManagedImpl
...
-OJBTxManagerClass=org.apache.ojb.odmg.JTATxManager
-
-...
# set used application server TM access class
JTATransactionManagerClass=
org.apache.ojb.otm.transaction.factory.JBossTransactionManagerFactory]]></source>
@@ -351,10 +348,42 @@
<em>ConnectionFactory</em>
</link> implementation
was used to by-pass all forbidden method calls in managed environments.
+ </p>
+ <p>
The
<em>JTATransactionManagerClass</em> set the used implementation class for transaction
- manager lookup, necessary for participation in JTA transaction.
+ manager lookup, necessary for for <code>javax.transaction.TransactionManager</code>
+ lookup to participate in running
+ <em>JTA transaction</em> via
+ <code>javax.transaction.Synchronization</code> interface.
+ </p>
+ <p>
+ The ODMG-api needs some additional settings for use in managed environments
+ (only needed when odmg-api was used):
+ </p>
+ <source><![CDATA[
+...
+# only needed for odmg-api
+ImplementationClass=org.apache.ojb.odmg.ImplementationJTAImpl
+
+...
+# only needed for odmg-api
+OJBTxManagerClass=org.apache.ojb.odmg.JTATxManager]]></source>
+
+ <p>
+ The <em>ImplementationClass</em> specify the ODMG base class implementation. In
+ managed environments a specific implementation is used, able to participate in
+ <em>JTA transactions</em>.
+ </p>
+ <p>
+ The <em>OJBTxManagerClass</em> specify the used OJBTxManager implementation to
+ manage the transaction synchronization in managed enviroments.
</p>
+ <note>
+ Currently OJB integrate in managed environments via <code>javax.transaction.Synchronization</code>
+ interface. When the <em>JCA adapter</em> is finished (work in progress) integration will be more
+ smooth.
+ </note>
</section>
<section>
@@ -595,16 +624,37 @@
/db-ojb-1.X.jar
/all used libraries]]></source>
+
<note>
This described solution should be re-deployable in JBoss.
<strong>If you will get any problems, please let me know. All suggestions are welcome</strong>
</note>
</section>
+ <anchor id="howto-access"/>
+ <section>
+ <title>
+ <strong>8. How to access OJB API?</strong>
+ </title>
+ <p>
+ In managed environments it is possible to access OJB in same way used
+ in non-managed environments:
+ </p>
+ <source><![CDATA[
+// PB-api
+PersistenceBroker broker = PersistenceBrokerFactory.create...;
+
+//ODMG-api
+Implementation odmg = OJB.getInstance();]]></source>
+ <p>
+ But it is also possible to bind OJB api access classes to JNDI and
+ lookup the the api entry <link href="#bind-to-jndi">classes via JNDI</link>.
+ </p>
+ </section>
<section>
<title>
- <strong>8. OJB logging within JBoss</strong>
+ <strong>9. OJB logging within JBoss</strong>
</title>
<p>
Jboss use
@@ -664,7 +714,7 @@
To generate the sample beans call
</p>
<source><![CDATA[
- ant ejb-examples]]></source>
+ant ejb-examples]]></source>
<p>
This ant target copies the bean sources to
<code>[db-ojb]/target/srcejb</code> generates all needed bean classes and
@@ -680,12 +730,12 @@
<code>[db-ojb]/lib</code> directory (xdoclet version 1.2xx or higher):
</p>
<source><![CDATA[
- xdoclet-xxx.jar
- xdoclet-ejb-module-xxx.jar
- xdoclet-jboss-module-xxx.jar
- xdoclet-jmx-module-xxx.jar
- xdoclet-web-module-xxx.jar
- xdoclet-xjavadoc-module-xxx.jar]]></source>
+xdoclet-xxx.jar
+xdoclet-ejb-module-xxx.jar
+xdoclet-jboss-module-xxx.jar
+xdoclet-jmx-module-xxx.jar
+xdoclet-web-module-xxx.jar
+xdoclet-xjavadoc-module-xxx.jar]]></source>
<p>
If you using a different application server than JBoss, you have to modifiy the
<em>xdoclet</em> ant target in
@@ -842,7 +892,7 @@
</p>
</section>
-
+ <anchor id="bind-to-jndi"/>
<section>
<title>Make OJB accessible via JNDI</title>
<p>
@@ -862,8 +912,8 @@
</li>
<li>
Class
- <code>org.apache.ojb.odmg.OJBJ2EE_2</code> for ODMG-api. Make method
- <code>OJBJ2EE_2.getInstance()</code> accessible.
+ <code>org.apache.ojb.odmg.OJB</code> for ODMG-api. Make method
+ <code>OJB.getInstance()</code> accessible.
</li>
</ul>
@@ -882,21 +932,21 @@
<code>jboss-service.xml</code> file:
</p>
<source><![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
- <server>
- <mbean code="org.apache.ojb.jboss.PBFactory"
- name="DefaultDomain:service=PBAPI,name=ojb/PBAPI">
- <depends>jboss.jca:service=RARDeployer</depends>
- <attribute name="JndiName">ojb/PBAPI</attribute>
- </mbean>
-
- <mbean code="org.apache.ojb.jboss.ODMGFactory"
- name="DefaultDomain:service=ODMG,name=ojb/defaultODMG">
- <depends>jboss.jca:service=RARDeployer</depends>
- <attribute name="JndiName">ojb/defaultODMG</attribute>
- </mbean>
- </server>]]></source>
+<server>
+ <mbean code="org.apache.ojb.jboss.PBFactory"
+ name="DefaultDomain:service=PBAPI,name=ojb/PBAPI">
+ <depends>jboss.jca:service=RARDeployer</depends>
+ <attribute name="JndiName">ojb/PBAPI</attribute>
+ </mbean>
+
+ <mbean code="org.apache.ojb.jboss.ODMGFactory"
+ name="DefaultDomain:service=ODMG,name=ojb/defaultODMG">
+ <depends>jboss.jca:service=RARDeployer</depends>
+ <attribute name="JndiName">ojb/defaultODMG</attribute>
+ </mbean>
+</server>]]></source>
</section>
<section>
@@ -935,7 +985,7 @@
...
# Weblogic Transaction Manager Factory
JTATransactionManagerClass=
-org.apache.ojb.odmg.transaction.WeblogicTransactionManagerFactory</source>
+org.apache.ojb.broker.transaction.tm.WeblogicTransactionManagerFactory</source>
<p>
<strong>4.</strong> Modify the connection information in the repository.xml (specify the
datasource name). SequenceManager implementation depends on the used DB, more info
@@ -963,7 +1013,7 @@
The following step is only neccessary if you want to bind OJB main api classes to JNDI.
</note>
<p>
- <strong>5.</strong> Compile the following classes (see at the
+ <strong>[5.]</strong> Compile the following classes (see at the
<link href="#pb.factory">end of this section</link>) and add
them to the weblogic classpath. This allows to access the PB-api via
JNDI lookup. Register via the weblogic console the startup class
---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org