[jboss-cvs] JBossAS SVN: r97867 - projects/docs/enterprise/EWP_5.0/Administration_And_Configuration_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Dec 15 21:19:14 EST 2009
Author: laubai
Date: 2009-12-15 21:19:14 -0500 (Tue, 15 Dec 2009)
New Revision: 97867
Modified:
projects/docs/enterprise/EWP_5.0/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml
Log:
Corrected tags in Alternative_DBs.xml.
Modified: projects/docs/enterprise/EWP_5.0/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml
===================================================================
--- projects/docs/enterprise/EWP_5.0/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml 2009-12-15 23:29:17 UTC (rev 97866)
+++ projects/docs/enterprise/EWP_5.0/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml 2009-12-16 02:19:14 UTC (rev 97867)
@@ -1,6 +1,6 @@
<?xml version='1.0'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
- ]>
+ ]>
<chapter id="alternative_DBs">
<title>Use Alternative Databases with JBoss Enterprise Application Platform</title>
@@ -10,13 +10,13 @@
<indexterm><primary>Configuration</primary><secondary>databases</secondary></indexterm>
JBoss utilizes the Hypersonic database as its default database. While this is good for development and prototyping, you or your company will probably require another database to be used for production. This chapter covers configuring JBoss Enterprise Application Platform to use alternative databases. We cover the procedures for all officially supported databases on the JBoss Enterprise Application Platform. They include: MySQL 5.0, MySQL 5.1, PostgreSQL 8.2.4, PostgreSQL 8.3.5, Oracle 10g, Oracle 11g R2, Oracle 11g R2 RAC, DB2 9.7, Sybase ASE 15.0, and MS SQL 2005 and 2008.
</para>
-
+
<para>Please note that in this chapter, we explain how to use alternative databases to support all services in JBoss Enterprise Application Platform. This includes all the system level services such as EJB and JMS. For individual applications (e.g., WAR or EAR) deployed in JBoss Enterprise Application Platform, you can still use any backend database by setting up the appropriate data source connection. </para>
<para>We assume that you have already installed the external database server, and have it running. You should create an empty database named <literal>jboss</literal>, accessible via the username / password pair <literal>jbossuser / jbosspass</literal>. The <literal>jboss</literal> database is used to store JBoss Enterprise Application Platform internal data -- JBoss Enterprise Application Platform will automatically create tables and data in it.</para>
-
+
</section>
-
+
<section>
<title>Install JDBC Drivers</title>
@@ -25,93 +25,93 @@
<itemizedlist>
- <listitem><para>MySQL JDBC drivers can be downloaded from the MySQL web site <ulink url="http://www.mysql.com/products/connector/">http://www.mysql.com/products/connector/</ulink>.</para></listitem>
- <listitem><para>PostgreSQL JDBC drivers can be downloaded from the Postgres web site <ulink url="http://jdbc.postgresql.org/">http://jdbc.postgresql.org/</ulink>.</para></listitem>
- <listitem><para>Oracle JDBC drivers can be downloaded from the Oracle web site <ulink url="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html">http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html </ulink>.</para></listitem>
- <listitem><para>IBM DB2 JDBC drivers can be downloaded from the IBM web site <ulink url="http://www-306.ibm.com/software/data/db2/java/">http://www-306.ibm.com/software/data/db2/java/</ulink>.
- </para></listitem>
+ <listitem><para>MySQL JDBC drivers can be downloaded from the MySQL web site <ulink url="http://www.mysql.com/products/connector/">http://www.mysql.com/products/connector/</ulink>.</para></listitem>
+ <listitem><para>PostgreSQL JDBC drivers can be downloaded from the Postgres web site <ulink url="http://jdbc.postgresql.org/">http://jdbc.postgresql.org/</ulink>.</para></listitem>
+ <listitem><para>Oracle JDBC drivers can be downloaded from the Oracle web site <ulink url="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html">http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html </ulink>.</para></listitem>
+ <listitem><para>IBM DB2 JDBC drivers can be downloaded from the IBM web site <ulink url="http://www-306.ibm.com/software/data/db2/java/">http://www-306.ibm.com/software/data/db2/java/</ulink>.
+ </para></listitem>
<listitem><para>Sybase JDBC drivers can be downloaded from the Sybase jConnect product page <ulink url="http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect">http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect</ulink></para></listitem>
<listitem><para>MS SQL Server JDBC drivers can be downloaded from the MSDN web site <ulink url="http://msdn.microsoft.com/data/jdbc/">http://msdn.microsoft.com/data/jdbc/</ulink>.</para></listitem>
</itemizedlist>
-
- <section><title>Special notes on Sybase</title>
- <para>
- Some of the services in JBoss uses null values for the default tables that are created.
- Sybase Adaptive Server should be configured to allow nulls by default.
+
+ <section><title>Special notes on Sybase</title>
+ <para>
+ Some of the services in JBoss uses null values for the default tables that are created.
+ Sybase Adaptive Server should be configured to allow nulls by default.
<screen><command>sp_dboption db_name, "allow nulls by default", true</command></screen>
-
- Refer to the Sybase manuals for more options.
- </para>
- <formalpara><title>Enable JAVA services</title>
- <para>
- To use any Java service like JMS, CMP, timers etc. configured with Sybase, Java should be enabled on Sybase Adaptive Server. To do this use:
+
+ Refer to the Sybase manuals for more options.
+ </para>
+ <formalpara><title>Enable JAVA services</title>
+ <para>
+ To use any Java service like JMS, CMP, timers etc. configured with Sybase, Java should be enabled on Sybase Adaptive Server. To do this use:
<screen><command>sp_configure "enable java",1</command></screen>
- Refer to the sybase manuals for more information.
- </para>
- </formalpara>
- <para>
- If Java is not enabled you might see this exception being thrown when you try to use any of the above services.
-<screen>com.sybase.jdbc2.jdbc.SybSQLException: Cannot run this command because Java services are not enabled. A user with System Administrator (SA) role must reconfigure the system to enable Java</screen>
- </para>
-
-
+ Refer to the sybase manuals for more information.
+ </para>
+ </formalpara>
+ <para>
+ If Java is not enabled you might see this exception being thrown when you try to use any of the above services.
+<screen>com.sybase.jdbc2.jdbc.SybSQLException: Cannot run this command because Java services are not enabled. A user with System Administrator (SA) role must reconfigure the system to enable Java</screen>
+ </para>
+
+
<formalpara><title>CMP Configuration</title>
- <para>
- To use Container Managed Persistence for user defined Java objects with Sybase Adaptive Server Enterprise, the Java classes should be installed in the database. The system table <literal>sysxtypes</literal> contains one row for each extended Java-SQL datatype. This table is only used for Adaptive Servers enabled for Java. Install Java classes using the <application>installjava</application> program.
-
-
+ <para>
+ To use Container Managed Persistence for user defined Java objects with Sybase Adaptive Server Enterprise, the Java classes should be installed in the database. The system table <literal>sysxtypes</literal> contains one row for each extended Java-SQL datatype. This table is only used for Adaptive Servers enabled for Java. Install Java classes using the <application>installjava</application> program.
+
+
<screen><command>installjava -f <jar-file-name> -S<sybase-server> -U<super-user> -P<super-pass> -D<db-name></command></screen>
-
- Refer to the <application>installjava</application> manual in Sybase for more options.
- </para>
- </formalpara>
-
- <note><title>Installing Java Classes</title>
-
- <orderedlist>
- <listitem>
- <para>
- You have to be a super-user with required privileges to install Java classes.
- </para>
- </listitem>
- <listitem>
- <para>
- The JAR file you are trying to install should be created without compression.
- </para>
- </listitem>
- <listitem>
- <para>
- Java classes that you install and use in the server must be compiled with JDK 1.2.2. If you compile a class with a later JDK, you will be able to install it in the server using the <application>installjava</application> utility, but you will get a <errorname>java.lang.ClassFormatError</errorname> exception when you attempt to use the class. This is because Sybase Adaptive Server uses an older JVM internally, and requires the Java classes to be compiled with the same.
- </para>
- </listitem>
- </orderedlist>
-
- </note>
+
+ Refer to the <application>installjava</application> manual in Sybase for more options.
+ </para>
+ </formalpara>
+
+ <note><title>Installing Java Classes</title>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ You have to be a super-user with required privileges to install Java classes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The JAR file you are trying to install should be created without compression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Java classes that you install and use in the server must be compiled with JDK 1.2.2. If you compile a class with a later JDK, you will be able to install it in the server using the <application>installjava</application> utility, but you will get a <errorname>java.lang.ClassFormatError</errorname> exception when you attempt to use the class. This is because Sybase Adaptive Server uses an older JVM internally, and requires the Java classes to be compiled with the same.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ </note>
</section>
<section id="Configuring_JDBC_DataSources">
- <title>Configuring JDBC DataSources</title>
-<!-- <para>
- Rather than configuring the connection manager factory related MBeans discussed in the previous section via a mbean services deployment descriptor, JBoss provides a simplified datasource centric descriptor. This is transformed into the standard <literal>jboss-service.xml</literal> MBean services deployment descriptor using a XSL transform applied by the <literal>org.jboss.deployment.XSLSubDeployer</literal> included in the <literal>jboss-jca.sar</literal> deployment. The simplified configuration descriptor is deployed the same as other deployable components. The descriptor must be named using a <literal>*-ds.xml</literal> pattern in order to be recognized by the <literal>XSLSubDeployer</literal>.
- </para> -->
- <para>
- The schema for the top-level datasource elements of the <filename>*-ds.xml</filename> configuration deployment file is shown in <xref linkend="Configuring_JDBC_DataSources-The_simplified_JCA_DataSource_configuration_descriptor_top_level_schema_elements" />.
- </para>
- <figure id="Configuring_JDBC_DataSources-The_simplified_JCA_DataSource_configuration_descriptor_top_level_schema_elements">
- <title>The simplified JCA DataSource configuration descriptor top-level schema elements</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- Multiple datasource configurations may be specified in a configuration deployment file. The child elements of the datasource root are:
- </para>
+ <title>Configuring JDBC DataSources</title>
+<!-- <para>
+ Rather than configuring the connection manager factory related MBeans discussed in the previous section via a mbean services deployment descriptor, JBoss provides a simplified datasource centric descriptor. This is transformed into the standard <literal>jboss-service.xml</literal> MBean services deployment descriptor using a XSL transform applied by the <literal>org.jboss.deployment.XSLSubDeployer</literal> included in the <literal>jboss-jca.sar</literal> deployment. The simplified configuration descriptor is deployed the same as other deployable components. The descriptor must be named using a <literal>*-ds.xml</literal> pattern in order to be recognized by the <literal>XSLSubDeployer</literal>.
+ </para> -->
+ <para>
+ The schema for the top-level datasource elements of the <filename>*-ds.xml</filename> configuration deployment file is shown in <xref linkend="Configuring_JDBC_DataSources-The_simplified_JCA_DataSource_configuration_descriptor_top_level_schema_elements" />.
+ </para>
+ <figure id="Configuring_JDBC_DataSources-The_simplified_JCA_DataSource_configuration_descriptor_top_level_schema_elements">
+ <title>The simplified JCA DataSource configuration descriptor top-level schema elements</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Multiple datasource configurations may be specified in a configuration deployment file. The child elements of the datasource root are:
+ </para>
<variablelist>
<varlistentry>
<term><literal>mbean</literal></term>
@@ -148,66 +148,66 @@
<varlistentry>
<term><literal>ha-local-tx-datasource</literal></term>
<listitem>
- <para>
- This element is identical to <literal>local-tx-datasource</literal>, with the addition of the experimental datasource failover capability, allowing JBoss to failover to an alternate database in the event of a database failure.
- </para>
- </listitem>
+ <para>
+ This element is identical to <literal>local-tx-datasource</literal>, with the addition of the experimental datasource failover capability, allowing JBoss to failover to an alternate database in the event of a database failure.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal>ha-xa-datasource</literal></term>
<listitem>
- <para>
- This element is identical to <literal>xa-datasource</literal>, with the addition of the experimental datasource failover capability, allowing JBoss to failover to an alternate database in the event of a database failure.
- </para>
- </listitem>
+ <para>
+ This element is identical to <literal>xa-datasource</literal>, with the addition of the experimental datasource failover capability, allowing JBoss to failover to an alternate database in the event of a database failure.
+ </para>
+ </listitem>
</varlistentry>
</variablelist>
- <figure id="Configuring_JDBC_DataSources-The_non_transactional_DataSource_configuration_schema">
- <title>The non-transactional DataSource configuration schema</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds_no_tx.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <figure id="Configuring_JDBC_DataSources-The_non_XA_DataSource_configuration_schema">
- <title>The non-XA DataSource configuration schema</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds_local_tx.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <figure id="Configuring_JDBC_DataSources-The_XA_DataSource_configuration_schema">
- <title>The XA DataSource configuration schema</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds_xa.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <figure id="Configuring_JDBC_DataSources-The_schema_for_the_experimental_non_XA_DataSource_with_failover">
- <title>The schema for the experimental non-XA DataSource with failover</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds_ha_local.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <figure id="Configuring_JDBC_DataSources-The_schema_for_the_experimental_XA_Datasource_with_failover">
- <title>The schema for the experimental XA Datasource with failover</title>
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/jboss_ds_ha_xa.jpg" />
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- Elements that are common to all datasources include:
- </para>
- <variablelist>
+ <figure id="Configuring_JDBC_DataSources-The_non_transactional_DataSource_configuration_schema">
+ <title>The non-transactional DataSource configuration schema</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds_no_tx.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure id="Configuring_JDBC_DataSources-The_non_XA_DataSource_configuration_schema">
+ <title>The non-XA DataSource configuration schema</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds_local_tx.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure id="Configuring_JDBC_DataSources-The_XA_DataSource_configuration_schema">
+ <title>The XA DataSource configuration schema</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds_xa.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure id="Configuring_JDBC_DataSources-The_schema_for_the_experimental_non_XA_DataSource_with_failover">
+ <title>The schema for the experimental non-XA DataSource with failover</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds_ha_local.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure id="Configuring_JDBC_DataSources-The_schema_for_the_experimental_XA_Datasource_with_failover">
+ <title>The schema for the experimental XA Datasource with failover</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/jboss_ds_ha_xa.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Elements that are common to all datasources include:
+ </para>
+ <variablelist>
<varlistentry>
<term><literal>jndi-name</literal></term>
<listitem>
@@ -450,8 +450,8 @@
</para>
</listitem></varlistentry>
</variablelist>
-
- </section>
+
+ </section>
</section>
<section>
@@ -513,48 +513,48 @@
<section>
<title>Common configuration for DataSources and ConnectionFactorys</title>
-
- <section>
+
+ <section>
<title>General</title>
- <variablelist>
+ <variablelist>
<varlistentry>
<term><literal><![CDATA[<mbean>]]></literal></term>
- <listitem>
- <para>
- A standard JBoss MBean deployment.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ A standard JBoss MBean deployment.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal><![CDATA[<depends>]]></literal></term>
- <listitem>
- <para>
- The <literal>ObjectName</literal> of an MBean service this <classname>ConnectionFactory</classname> or <classname>DataSource</classname> deployment depends upon.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The <literal>ObjectName</literal> of an MBean service this <classname>ConnectionFactory</classname> or <classname>DataSource</classname> deployment depends upon.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal><![CDATA[<jndi-name>]]></literal></term>
- <listitem>
- <para>
- The JNDI name where it is bound. This is prefixed with <literal>java:\</literal> by default.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ The JNDI name where it is bound. This is prefixed with <literal>java:\</literal> by default.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal><![CDATA[<use-java-context>]]></literal></term>
- <listitem>
- <para>
- Set this to <literal>false</literal> to drop the <literal>java:\</literal> context from the JNDI name.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Set this to <literal>false</literal> to drop the <literal>java:\</literal> context from the JNDI name.
+ </para>
+ </listitem>
</varlistentry>
- </variablelist>
- </section>
-
- <section>
- <title>XA</title>
+ </variablelist>
+ </section>
+
+ <section>
+ <title>XA</title>
<variablelist>
<varlistentry>
<term><literal><![CDATA[<xa-resource-timeout]]></literal></term>
@@ -565,49 +565,49 @@
</listitem>
</varlistentry>
</variablelist>
- </section>
-
-
- <section><title>Security parameters</title>
- <para>
-
- JCA Login Modules are used to inject security configuration into the connection when configured. When no parameters are set, the module uses the username and password specified in <filename>*-ds.xml</filename> for DataSources, or uses the <methodname>getConnection</methodname> or <methodname>createConnection</methodname> method without a username or password by default.
- </para>
+ </section>
+
+
+ <section><title>Security parameters</title>
+ <para>
+
+ JCA Login Modules are used to inject security configuration into the connection when configured. When no parameters are set, the module uses the username and password specified in <filename>*-ds.xml</filename> for DataSources, or uses the <methodname>getConnection</methodname> or <methodname>createConnection</methodname> method without a username or password by default.
+ </para>
<para>
The following parameters can be set:
- </para>
- <variablelist>
+ </para>
+ <variablelist>
<varlistentry>
<term><literal><![CDATA[<application-managed-security>]]></literal></term>
<listitem>
<para>
Uses the username and password passed on the <methodname>getConnection</methodname> or <methodname>createConnection</methodname> request by the application.
- </para>
- </listitem>
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal><![CDATA[<security-domain>]]></literal></term>
- <listitem>
- <para>
- Uses the identified login module configured in <filename>conf/login-module.xml</filename>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Uses the identified login module configured in <filename>conf/login-module.xml</filename>.
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal><![CDATA[security-domain-and-application]]></literal></term>
- <listitem>
- <para>
- Uses the identified login module configured in <filename>conf/login-module.xml</filename> and other connection request information supplied by the application, for example JMS Queues and Topics.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Uses the identified login module configured in <filename>conf/login-module.xml</filename> and other connection request information supplied by the application, for example JMS Queues and Topics.
+ </para>
+ </listitem>
</varlistentry>
- </variablelist>
-
-
- <section>
+ </variablelist>
+
+
+ <section>
<title>Pooling parameters</title>
-
- <variablelist>
+
+ <variablelist>
<varlistentry>
<term><literal><![CDATA[<no-tx-separate-pools>]]></literal></term>
<listitem>
@@ -684,36 +684,36 @@
</para>
</listitem></varlistentry>
</variablelist>
- </section>
-
- <section>
+ </section>
+
+ <section>
<title>Security and Pooling</title>
- <para>
- Unless the <classname>ResourceAdapter</classname> has <literal><![CDATA[<reauthentication-support>]]></literal>, using multiple security identities will create subpools for each identity.
- </para>
+ <para>
+ Unless the <classname>ResourceAdapter</classname> has <literal><![CDATA[<reauthentication-support>]]></literal>, using multiple security identities will create subpools for each identity.
+ </para>
<note><title>Note</title>
<para>
- The min and max pool size are per subpool, so be careful with these parameters if you have lots of identities.
+ The min and max pool size are per subpool, so be careful with these parameters if you have lots of identities.
</para>
</note>
- </section>
+ </section>
</section>
</section>
<section>
<title>Change Database for the JMS Services</title>
- <para>The JMS service in the JBoss Enterprise Application Platform uses relational databases to persist its messages. For improved performance, we should change the JMS service to take advantage of the external database. To do that, we need to replace the file <filename>$JBOSS_HOME/server/$PROFILE/deploy/messaging/$DATABASE-persistence-service.xml</filename> with the file <literal>${jboss.dist}/docs/examples/jms/${database}-persistence-service.xml</literal> depending on your external database.
+ <para>The JMS service in the JBoss Enterprise Application Platform uses relational databases to persist its messages. For improved performance, we should change the JMS service to take advantage of the external database. To do that, we need to replace the file <filename>$JBOSS_HOME/server/$PROFILE/deploy/messaging/$DATABASE-persistence-service.xml</filename> with the file <filename>$JBOSS_HOME/docs/examples/jms/$DATABASE-persistence-service.xml</filename> depending on your external database.
<!--To do that, we need to replace the file <literal><JBoss_Home>/server/all/deploy/jms-singleton/hsqldb-jdbc2-service.xml</literal> with a file in <literal><JBoss_Home>/docs/examples/jms/</literal> depending on your external database. Notice that if you are using the <literal>default</literal> server profile, the file path is <literal><JBoss_Home>/server/default/deploy/jms/hsqldb-jdbc2-service.xml</literal>.--></para>
-
+
<itemizedlist>
- <listitem><para>MySQL: <filename>mysql-persistence-service.xml</filename></para></listitem>
- <listitem><para>PostgreSQL: <filename>postgresql-persistence-service.xml</filename></para></listitem>
- <listitem><para>Oracle: <filename>oracle-persistence-service.xml</filename></para></listitem>
- <listitem><para>DB2: <filename>db2-persistence-service.xml</filename></para></listitem>
- <listitem><para>Sybase: <filename>sybase-persistence-service.xml</filename></para></listitem>
- <listitem><para>MS SQL Server: <filename>mssql-persistence-service.xml</filename></para></listitem>
+ <listitem><para>MySQL: <filename>mysql-persistence-service.xml</filename></para></listitem>
+ <listitem><para>PostgreSQL: <filename>postgresql-persistence-service.xml</filename></para></listitem>
+ <listitem><para>Oracle: <filename>oracle-persistence-service.xml</filename></para></listitem>
+ <listitem><para>DB2: <filename>db2-persistence-service.xml</filename></para></listitem>
+ <listitem><para>Sybase: <filename>sybase-persistence-service.xml</filename></para></listitem>
+ <listitem><para>MS SQL Server: <filename>mssql-persistence-service.xml</filename></para></listitem>
</itemizedlist>
<!-- <note>
@@ -722,93 +722,94 @@
</note>-->
</section>
- <!--HAJIME-->
+
+<!--HAJIME-->
<section>
<title>Support Foreign Keys in CMP Services</title>
- <para>Next, we need to go change the <literal><JBoss_Home>/server/all/conf/standardjbosscmp-jdbc.xml</literal> file so that the <literal>fk-constraint</literal> property is <literal>true</literal>. That is needed for all external databases we support on the JBoss Enterprise Application Platform. This file configures the database connection settings for the EJB2 CMP beans deployed in the JBoss Enterprise Application Platform.</para>
-
-<programlisting role="XML"><fk-constraint>true</fk-constraint></programlisting>
+ <para>Next, we need to go change the <filename>$JBOSS_HOME/server/$PROFILE/conf/standardjbosscmp-jdbc.xml</filename> file so that the <varname>fk-constraint</varname> property is <literal>true</literal>. That is needed for all external databases we support on the JBoss Enterprise Application Platform. This file configures the database connection settings for the EJB2 CMP beans deployed in the JBoss Enterprise Application Platform.</para>
+
+<programlisting role="XML"><![CDATA[<fk-constraint>true</fk-constraint>]]></programlisting>
</section>
<section>
<title>Specify Database Dialect for Java Persistence API</title>
- <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss Enterprise Application Platform. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <literal>${jboss.dist}/server/${server}/deployers/ejb3.deployer/META-INF/jpa-deployers-jboss-beans.xml</literal> file. To configure this file you need to uncomment the set of tags related to the map entry <literal>hibernate.dialect</literal> and change the values to the following based on the database you setup. <!--For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.--></para>
+ <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss Enterprise Application Platform. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <filename>$JBOSS_HOME/server/$PROFILE/deployers/ejb3.deployer/META-INF/jpa-deployers-jboss-beans.xml</filename> file. To configure this file you need to uncomment the set of tags related to the map entry <literal>hibernate.dialect</literal> and change the values to the following based on the database you setup. <!--For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.--></para>
<itemizedlist>
- <listitem>
- <para>
- Oracle 10g: org.hibernate.dialect.Oracle10gDialect
- </para>
- </listitem>
- <listitem>
- <para>
- Oracle 11g: org.hibernate.dialect.Oracle10gDialect
- </para>
- </listitem>
- <listitem>
- <para>
- Microsoft SQL Server 2005: org.hibernate.dialect.SQLServerDialect
- </para>
- </listitem>
- <listitem>
- <para>
- Microsoft SQL Server 2008: org.hibernate.dialect.SQLServerDialect
- </para>
- </listitem>
- <listitem>
- <para>
- PostgresSQL 8.2.3: org.hibernate.dialect.PostgreSQLDialect
- </para>
- </listitem>
- <listitem>
- <para>
- PostgresSQL 8.3.7: org.hibernate.dialect.PostgreSQLDialect
- </para>
- </listitem>
- <listitem>
- <para>
- MySQL 5.0: org.hibernate.dialect.MySQL5InnoDBDialect
- </para>
- </listitem>
- <listitem>
- <para>
- MySQL 5.1: org.hibernate.dialect.MySQL5InnoDBDialect
- </para>
- </listitem>
- <listitem>
- <para>
- DB2 9.1: org.hibernate.dialect.DB2Dialect
- </para>
- </listitem>
- <listitem>
- <para>
- Sybase ASE 15: org.hibernate.dialect.SybaseDialect
- </para>
- </listitem>
+ <listitem>
+ <para>
+ Oracle 10g: <literal>org.hibernate.dialect.Oracle10gDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Oracle 11g: <literal>org.hibernate.dialect.Oracle10gDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Microsoft SQL Server 2005: <literal>org.hibernate.dialect.SQLServerDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Microsoft SQL Server 2008: <literal>org.hibernate.dialect.SQLServerDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ PostgresSQL 8.2.3: <literal>org.hibernate.dialect.PostgreSQLDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ PostgresSQL 8.3.7: <literal>org.hibernate.dialect.PostgreSQLDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ MySQL 5.0: <literal>org.hibernate.dialect.MySQL5InnoDBDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ MySQL 5.1: <literal>org.hibernate.dialect.MySQL5InnoDBDialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ DB2 9.1: <literal>org.hibernate.dialect.DB2Dialect</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Sybase ASE 15: <literal>org.hibernate.dialect.SybaseDialect</literal>
+ </para>
+ </listitem>
</itemizedlist>
<!-- <note><title>DB2 7.2 with Universal JDBC Driver (Type 4)</title>
- <para>
- Large Objects (LOBs) are supported only with DB2 Version 8 servers and above with the universal JDBC driver.
- Hence JMS services which stores messages as BLOBS and Timer services which uses BLOB fields for storing objects do not work with the JDBC Type 4 driver and DB2 7.2.
- </para>
+ <para>
+ Large Objects (LOBs) are supported only with DB2 Version 8 servers and above with the universal JDBC driver.
+ Hence JMS services which stores messages as BLOBS and Timer services which uses BLOB fields for storing objects do not work with the JDBC Type 4 driver and DB2 7.2.
+ </para>
</note>
<note><title>DB2 7.2 with JDBC Type 2 driver</title>
- <para>
- All JBoss services work with the JDBC Type 2 driver and DB2 Version 7.2 servers.
- </para>
+ <para>
+ All JBoss services work with the JDBC Type 2 driver and DB2 Version 7.2 servers.
+ </para>
</note> -->
-
+
</section>
<section>
- <title>Change Other JBoss Enterprise Application Platform Services to Use the External Database</title>
+ <title>Change Other JBoss Enterprise Application Platform Services to use the External Database</title>
<para>Besides JMS, CMP, and JPA, we still need to hook up the rest of JBoss services with the external database. There are two ways to do it. One is easy but inflexible. The other is flexible but requires more steps. Now, let's discuss those two approaches respectively.</para>
@@ -816,20 +817,23 @@
<title>The Easy Way</title>
<para>
- The easy way is just to change the JNDI name for the external database to <literal>DefaultDS</literal>. Most JBoss services are hard-wired to use the <literal>DefaultDS</literal> by default. So, by changing the datasource name, we do not need to change the configuration for each service individually.
+ The easy way is just to change the JNDI name for the external database to <literal>DefaultDS</literal>. Most JBoss services are hard-wired to use the <literal>DefaultDS</literal> by default. So, by changing the DataSource name, we do not need to change the configuration for each service individually.
</para>
<para>
- To change the JNDI name, just open the <literal>*-ds.xml</literal> file for your external database, and change the value of the <literal>jndi-name</literal> property to <literal>DefaultDS</literal>. For instance, in <literal>mysql-ds.xml</literal>, you'd change MySqlDS to DefaultDS and so on. You will need to remove the <literal><JBoss_Home>/server/all/deploy/hsqldb-ds.xml</literal> file after you are done to avoid duplicated <literal>DefaultDS</literal> definition.
+ To change the JNDI name, just open the <filename>*-ds.xml</filename> file for your external database, and change the value of the <varname>jndi-name</varname> property to <literal>DefaultDS</literal>. For instance, in <filename>mysql-ds.xml</filename>, you would change <literal>MySqlDS</literal> to <literal>DefaultDS</literal> and so on. You will need to remove the <filename>$JBOSS_HOME/server/$PROFILE/deploy/hsqldb-ds.xml</filename> file after you are done to avoid duplicated <literal>DefaultDS</literal> definition.
</para>
<para>
- In the <literal>messaging/${database}-persistence-service.xml</literal> file, you should also change the datasource name in the <literal>depends</literal> tag for the <literal>PersistenceManagers</literal> MBean to <literal>DefaultDS</literal>. For instance, for <literal>mysql-persistence-service.xml</literal> file, we change the <literal>MySqlDS</literal> to <literal>DefaultDS</literal>.
-
+ In the <filename>messaging/$DATABASE-persistence-service.xml</filename> file, you should also change the datasource name in the <literal>depends</literal> tag for the <classname>PersistenceManagers</classname> MBean to <literal>DefaultDS</literal>. For instance, for <filename>mysql-persistence-service.xml</filename> file, we change the <literal>MySqlDS</literal> to <literal>DefaultDS</literal>.
+
</para>
-<programlisting role="XML">.. ...
-<mbean code="org.jboss.messaging.core.jmx.JDBCPersistenceManagerService" name="jboss.messaging:service=PersistenceManager" xmbean-dd="xmdesc/JDBCPersistenceManager-xmbean.xml">
-
-<depends>jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+<programlisting role="XML"><![CDATA[
+...
+
+<mbean code="org.jboss.messaging.core.jmx.JDBCPersistenceManagerService" name="jboss.messaging:service=PersistenceManager" xmbean-dd="xmdesc/JDBCPersistenceManager-xmbean.xml">
+
+<depends>jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+]]>
</programlisting>
</section>
@@ -839,30 +843,30 @@
<para>Changing the external datasource to <literal>DefaultDS</literal> is convenient. But if you have applications that assume the <literal>DefaultDS</literal> always points to the factory-default HSQL DB, that approach could break your application. Also, changing <literal>DefaultDS</literal> destination forces all JBoss services to use the external database. What if you want to use the external database only on some services?</para>
- <para>A safer and more flexible way to hook up JBoss Enterprise Application Platform services with the external datasource is to manually change the <literal>DefaultDS</literal> in all standard JBoss services to the datasource JNDI name defined in your <literal>*-ds.xml</literal> file (e.g., the <literal>MySqlDS</literal> in <literal>mysql-ds.xml</literal> etc.). Below is a complete list of files that contain <literal>DefaultDS</literal>. You can update them all to use the external database on all JBoss services or update some of them to use different combination of datasources for different services.</para>
+ <para>A safer and more flexible way to hook up JBoss Enterprise Application Platform services with the external DataSource is to manually change the <literal>DefaultDS</literal> in all standard JBoss services to the DataSource JNDI name defined in your <filename>*-ds.xml</filename> file (e.g., the <literal>MySqlDS</literal> in <filename>mysql-ds.xml</filename> etc.). Below is a complete list of files that contain <literal>DefaultDS</literal>. You can update them all to use the external database on all JBoss services or update some of them to use different combination of DataSources for different services.</para>
<itemizedlist>
- <listitem><para><literal>${jboss.dist}/server/${server}/conf/login-config.xml</literal>: This file is used in Java EE container managed security services.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/conf/login-config.xml</filename>: This file is used in Java EE container managed security services.</para></listitem>
- <listitem><para><literal>${jboss.dist}/server/${server}/conf/standardjbosscmp-jdbc.xml</literal>: This file configures the CMP beans in the EJB container.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/conf/standardjbosscmp-jdbc.xml</filename>: This file configures the CMP beans in the EJB container.</para></listitem>
<!-- <listitem><para><literal><JBoss_Home>/server/all/deploy/ejb-deployer.xml</literal>: This file configures the JBoss EJB deployer.</para></listitem>
-->
- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/ejb2-timer-service.xml</literal>: This file configures the EJB timer services.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/ejb2-timer-service.xml</filename>: This file configures the EJB timer services.</para></listitem>
<!-- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/snmp-adaptor.sar/attributes.xml</literal>: This file is used by the SNMP service.</para></listitem>
-->
- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/juddi-service.sar/META-INF/jboss-service.xml</literal>: This file configures the UUDI service.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/juddi-service.sar/META-INF/jboss-service.xml</filename>: This file configures the UUDI service.</para></listitem>
- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/juddi-service.sar/juddi.war/WEB-INF/jboss-web.xml</literal>: This file configures the UUDI service.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/juddi-service.sar/juddi.war/WEB-INF/jboss-web.xml</filename>: This file configures the UUDI service.</para></listitem>
- <listitem><para><literal><JBoss_Home>/server/all/deploy/juddi-service.sar/juddi.war/WEB-INF/juddi.properties</literal>: This file configures the UUDI service.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/juddi-service.sar/juddi.war/WEB-INF/juddi.properties</filename>: This file configures the UUDI service.</para></listitem>
- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/uuid-key-generator.sar/META-INF/jboss-service.xml</literal>: This file configures the UUDI service.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/uuid-key-generator.sar/META-INF/jboss-service.xml</filename>: This file configures the UUDI service.</para></listitem>
- <listitem><para><literal>${jboss.dist}/server/${server}/deploy/messaging/messaging-jboss-beans.xml</literal> and <literal>${jboss.dist}/server/${server}/deploy/messaging/persistence-service.xml</literal>: Those files configure the JMS persistence service as we discussed earlier.</para></listitem>
+ <listitem><para><filename>$JBOSS_HOME/server/$PROFILE/deploy/messaging/messaging-jboss-beans.xml</filename> and <filename>$JBOSS_HOME/server/$PROFILE/deploy/messaging/persistence-service.xml</filename>: Those files configure the JMS persistence service as we discussed earlier.</para></listitem>
<!-- ${jboss.dist}/server/${server}/deploy/schedule-manager-service.xml -->
</itemizedlist>
@@ -876,297 +880,401 @@
<para>In our setup discussed in this chapter, we rely on the JBoss Enterprise Application Platform to automatically create needed tables in the external database upon server startup. That works most of the time. But for databases like Oracle, there might be some minor issues if you try to use the same database server to back more than one JBoss Enterprise Application Platform instance.</para>
- <para>The Oracle database creates tables of the form <literal>schemaname.tablename</literal>. The <literal>TIMERS</literal> and <literal>HILOSEQUENCES</literal> tables needed by JBoss Enterprise Application Platform would not get created on a schema if the table already exists on a different schema. To work around this issue, you need to edit the <literal>${jboss.dist}/server/${server}/deploy/ejb2-timer-service.xml</literal> file to change the table name from <literal>TIMERS</literal> to something like <literal>schemaname2.tablename</literal>.</para>
+ <para>The Oracle database creates tables of the form <literal>schemaname.tablename</literal>. The <literal>TIMERS</literal> and <literal>HILOSEQUENCES</literal> tables needed by JBoss Enterprise Application Platform would not be created on a schema if the table already existed on a different schema. To work around this issue, you need to edit the <filename>$JBOSS_HOME/server/$PROFILE/deploy/ejb2-timer-service.xml</filename> file to change the table name from <literal>TIMERS</literal> to something like <literal>schemaname2.tablename</literal>.</para>
-<programlisting role="XML"><mbean code="org.jboss.ejb.txtimer.DatabasePersistencePolicy"
-name="jboss.ejb:service=EJBTimerService,persistencePolicy=database">
-<!-- DataSourceBinding ObjectName -->
-<depends optional-attribute-name="DataSource">
+<programlisting role="XML"><![CDATA[
+<mbean code="org.jboss.ejb.txtimer.DatabasePersistencePolicy"
+name="jboss.ejb:service=EJBTimerService,persistencePolicy=database">
+<!-- DataSourceBinding ObjectName -->
+<depends optional-attribute-name="DataSource">
jboss.jca:service=DataSourceBinding,name=DefaultDS
-</depends>
-<!-- The plugin that handles database persistence -->
-<attribute name="DatabasePersistencePlugin">
+</depends>
+<!-- The plugin that handles database persistence -->
+<attribute name="DatabasePersistencePlugin">
org.jboss.ejb.txtimer.GeneralPurposeDatabasePersistencePlugin
-</attribute>
-<!-- The timers table name -->
-<attribute name="TimersTable">TIMERS</attribute>
-</mbean> </programlisting>
+</attribute>
+<!-- The timers table name -->
+<attribute name="TimersTable">TIMERS</attribute>
+</mbean>
+]]></programlisting>
- <para>Similarly, you need to change the <literal><JBoss_Home>/server/all/deploy/uuid-key-generator.sar/META-INF/jboss-service.xml</literal> file to change the table name from <literal>HILOSEQUENCES</literal> to something like <literal>schemaname2.tablename</literal> as well.</para>
+ <para>Similarly, you need to change the <filename>$JBOSS_HOME/server/$PROFILE/deploy/uuid-key-generator.sar/META-INF/jboss-service.xml</filename> file to change the table name from <literal>HILOSEQUENCES</literal> to something like <literal>schemaname2.tablename</literal> as well.</para>
-<programlisting><!-- HiLoKeyGeneratorFactory -->
-<mbean code="org.jboss.ejb.plugins.keygenerator.hilo.HiLoKeyGeneratorFactory"
-name="jboss:service=KeyGeneratorFactory,type=HiLo">
-
-<depends>jboss:service=TransactionManager</depends>
-
-<!-- Attributes common to HiLo factory instances -->
-
-<!-- DataSource JNDI name -->
-<depends optional-attribute-name="DataSource">jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
-
-<!-- table name -->
-<attribute name="TableName">HILOSEQUENCES</attribute></programlisting>
+<programlisting><![CDATA[
+<!-- HiLoKeyGeneratorFactory -->
+<mbean code="org.jboss.ejb.plugins.keygenerator.hilo.HiLoKeyGeneratorFactory"
+name="jboss:service=KeyGeneratorFactory,type=HiLo">
+
+<depends>jboss:service=TransactionManager</depends>
+
+<!-- Attributes common to HiLo factory instances -->
+
+<!-- DataSource JNDI name -->
+<depends optional-attribute-name="DataSource">jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+
+<!-- table name -->
+<attribute name="TableName">HILOSEQUENCES</attribute>
+]]></programlisting>
</section>
-<section><title>DataSource configuration</title>
+ <section><title>DataSource configuration</title>
- <para>
- DataSources are defined inside a <datasources> element.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <no-tx-datasource> - a DataSource that does not take part in JTA transactions using a java.sql.Driver
- </para>
- </listitem>
- <listitem>
- <para>
- <local-tx-datasource> - a DataSource that does not support two phase commit using a java.sql.Driver
- </para>
- </listitem>
- <listitem>
- <para>
- <xa-datasource> - a DataSource that does support two phase commit using a javax.sql.XADataSource
- </para>
- </listitem>
- </itemizedlist>
+ <para>
+ DataSources are defined inside a <literal><![CDATA[<datasources>]]></literal> element.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><varname><![CDATA[<no-tx-datasource>]]></varname></term>
+ <listitem>
+ <para>
+ A DataSource that does not take part in JTA transactions using a <classname>java.sql.Driver</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<local-tx-datasource>]]></varname></term>
+ <listitem>
+ <para>
+ A DataSource that does not support two-phase commit using a <classname>java.sql.Driver</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<xa-datasource>]]></varname></term>
+ <listitem>
+ <para>
+ A DataSource that supports two-phase commit using a <classname>javax.sql.XADataSource</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ <section>
+ <title>Parameters specific for <classname>java.sql.Driver</classname> usage</title>
+ <variablelist>
+ <varlistentry>
+ <term><varname><![CDATA[<connection-url>]]></varname></term>
+ <listitem>
+ <para>
+ The JDBC driver connection URL string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<driver-class>]]></varname></term>
+ <listitem>
+ <para>
+ The JDBC driver class implementing <classname>java.sql.Driver</classname>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<connection-property>]]></varname></term>
+ <listitem>
+ <para>
+ Used to configure the connections retrieved from the <classname>java.sql.Driver</classname>. For example:
+ </para>
+ <programlisting role="XML"><![CDATA[
+<connection-property name="char.encoding">UTF-8</connection-property>
+ ]]></programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
- <section><title>Parameters specific for java.sql.Driver usage</title>
-<para>
-<itemizedlist>
- <listitem>
- <para>
- <connection-url> - the JDBC driver connection url string
- </para>
- </listitem>
- <listitem>
- <para>
- <driver-class> - the JDBC driver class implementing java.sql.Driver
- </para>
- </listitem>
- <listitem>
- <para>
- <connection-property> - used to configure the connections retrieved from the java.sql.Driver. For example:
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
-<programlisting role="XML"><connection-property name="char.encoding">UTF-8</connection-property></programlisting>
-
-
-</section>
-
<section>
- <title>Parameters specific for javax.sql.XADataSource usage</title>
+ <title>Parameters specific for <classname>javax.sql.XADataSource</classname> usage</title>
- <itemizedlist>
- <listitem>
- <para>
- <xa-datasource-class> - This is the class that implements the XADataSource
- </para>
- </listitem>
- <listitem>
- <para>
- <xa-datasource-property> - This contains that properties that are used to configure the XADataSource. For example:
- </para>
- </listitem>
- </itemizedlist>
-
-<programlisting role="XML"><xa-datasource-property name="IfxWAITTIME">10</xa-datasource-property>
-<xa-datasource-property name="IfxIFXHOST">myhost.mydomain.com</xa-datasource-property>
-<xa-datasource-property name="PortNumber">1557</xa-datasource-property>
-<xa-datasource-property name="DatabaseName">mydb</xa-datasource-property>
-<xa-datasource-property name="ServerName">myserver</xa-datasource-property>
-</programlisting>
-
-<itemizedlist>
- <listitem>
- <para>
- <isSameRM-override-value> - In order to fix issues with Oracle this property should be set to false
- </para>
- </listitem>
- <listitem>
- <para>
- <track-connection-by-tx/> - This property is deprecated and enabled by default in order to correct issues with Oracle
- </para>
- </listitem>
- <listitem>
- <para>
- <no-tx-separate-pools/> - This property will pool Transactional and non-Transactional connections separately and cause your total pool size to be twice the <literal>max-pool-size</literal>, as two pools will be created. This is used to fix issues with Oracle.
- </para>
- </listitem>
-</itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term><varname><![CDATA[<xa-datasource-class>]]></varname></term>
+ <listitem>
+ <para>
+ This is the class that implements the <classname>XADataSource</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<xa-datasource-property>]]></varname></term>
+ <listitem>
+ <para>
+ Contains that properties that are used to configure the <classname>XADataSource</classname>. For example:
+ </para>
+ <programlisting role="XML"><![CDATA[
+<xa-datasource-property name="IfxWAITTIME">10</xa-datasource-property>
+<xa-datasource-property name="IfxIFXHOST">myhost.mydomain.com</xa-datasource-property>
+<xa-datasource-property name="PortNumber">1557</xa-datasource-property>
+<xa-datasource-property name="DatabaseName">mydb</xa-datasource-property>
+<xa-datasource-property name="ServerName">myserver</xa-datasource-property>
+ ]]></programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<isSameRM-override-value>]]></varname></term>
+ <listitem>
+ <para>
+ In order to fix issues with Oracle this property should be set to <literal>false</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<track-connection-by-tx>]]></varname></term>
+ <listitem>
+ <para>
+ This property is deprecated and enabled by default in order to correct issues with Oracle.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<no-tx-separate-pools/>]]></varname></term>
+ <listitem>
+ <para>
+ This property will pool Transactional and non-Transactional connections separately and cause your total pool size to be twice the <varname>max-pool-size</varname>, as two pools will be created. This is used to fix issues with Oracle.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section>
<title>Common DataSource parameters</title>
- <itemizedlist>
- <listitem>
- <para>
- <jndi-name> - the JNDI name under which the DataSource should be bound.
- </para>
- </listitem>
- <listitem>
- <para>
- <use-java-context> - A boolean indicating if the jndi-name should be prefixed with java: which causes the DataSource to only be accessible from within the jboss server vm. The default is true.
- </para>
- </listitem>
- <listitem>
- <para>
- <user-name> - the user name used when creating the connection (not used when security is configured)
- </para>
- </listitem>
- <listitem>
- <para>
- <password> - the password used when creating the connection (not used when security is configured)
- </para>
- </listitem>
- <listitem>
- <para>
- <transaction-isolation> - the default transaction isolation of the connection (unspecified means use the default provided by the database):
- <itemizedlist>
- <listitem>
- <para>
- TRANSACTION_READ_UNCOMMITTED
- </para>
- </listitem>
- <listitem>
- <para>
- TRANSACTION_READ_COMMITTED
- </para>
- </listitem>
- <listitem>
- <para>
- TRANSACTION_REPEATABLE_READ
- </para>
- </listitem>
- <listitem>
- <para>
- TRANSACTION_SERIALIZABLE
- </para>
- </listitem>
- <listitem>
- <para>
- TRANSACTION_NONE
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <new-connection-sql> - an sql statement that is executed against each new connection. This can be used to set the connection schema, etc.
- </para>
- </listitem>
- <listitem>
- <para>
- <check-valid-connection-sql> - an sql statement that is executed before it is checked out from the pool to make sure it is still valid. If the sql fails, the connection is closed and new ones created.
- </para>
- </listitem>
- <listitem>
- <para>
- <valid-connection-checker-class-name> - a class that can check whether a connection is valid using a vendor specific mechanism
- </para>
- </listitem>
- <listitem>
- <para>
- <exception-sorter-class-name> - a class that looks at vendor specific messages to determine whether sql errors are fatal and thus the connection should be destroyed. If none specified, no errors will be treated as fatal.
- </para>
- </listitem>
- <listitem>
- <para>
- <track-statements> - (a) whether to monitor for unclosed Statements and ResultSets and issue warnings when the user forgets to close them (default nowarn)
- </para>
- </listitem>
- <listitem>
- <para>
- <prepared-statement-cache-size> - the number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in a LRU cache. The default is 0 (zero), meaning no cache.
- </para>
- </listitem>
- <listitem>
- <para>
- <share-prepared-statements> - (b) with prepared statement cache enabled whether two requests in the same transaction should return the same statement (from jboss-4.0.2 - default false).
- </para>
- </listitem>
- <listitem>
- <para>
- <set-tx-query-timeout> - whether to enable query timeout based on the length of time remaining until the transaction times out (default false - NOTE: This was NOT ported to 4.0.x until 4.0.3)
- </para>
- </listitem>
- <listitem>
- <para>
- <query-timeout> - a static configuration of the maximum of seconds before a query times out (since 4.0.3)
- </para>
- </listitem>
- <listitem>
- <para>
- <metadata/typemapping> - a pointer to the type mapping in conf/standardjbosscmp.xml (available from JBoss 4 and above)
- </para>
- </listitem>
- <listitem>
- <para>
- <validate-on-match> - Prior to JBoss 4.0.5, connection validation occurred when the JCA layer attempted to match a managed connection. With the addition of <background-validation> this is no longer required. Specifying <validate-on-match> forces the old behavior. NOTE: this is typically NOT used in conjunction with <background-validation>
- </para>
- </listitem>
- <listitem>
- <para>
- <prefill> - whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. This feature will appear in JBoss 4.0.5.
- </para>
- </listitem>
- <listitem>
- <para>
- <background-validation> - In JBoss 4.0.5, background connection validation as been added to reduce the overall load on the RDBMS system when validating a connection. When using this feature, JBoss will attempt to validate the current connections in the pool is a seperate thread (ConnectionValidator). Default is False.
- </para>
- </listitem>
- <listitem>
- <para>
- <idle-timeout-minutes> - indicates the maximum time a connection may be idle before being closed. Default is 15 minutes.
- </para>
- </listitem>
- <listitem>
- <para>
- <background-validation-minutes> - The interval, in minutes, that the ConnectionValidator will run. Default is 10 minutes. NOTE: It is prudent to set this value to something greater or less than the <idle-timeout-minutes>
- </para>
- </listitem>
- <listitem>
- <para>
- <url-delimiter> - From JBoss5 database failover is part of the main datasource config
- </para>
- </listitem>
- <listitem>
- <para>
- <url-property> - From JBoss5 database failover is part of the main datasource config
- </para>
- </listitem>
- <listitem>
- <para>
- <url-selector-strategy-class-name> - From JBoss5 ONLY database failover is part of the main datasource config
- </para>
- </listitem>
- <listitem>
- <para>
- <stale-connection-checker-class-name> - An implementation of org.jboss.resource.adapter.jdbc.StateConnectionChecker that will decide whether SQLExceptions that notify of bad connections throw org.jboss.resource.adapter.jdbc.StateConnectionException (from JBoss5)
- </para>
- </listitem>
- </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term><varname><![CDATA[<jndi-name>]]></varname></term>
+ <listitem>
+ <para>
+ The JNDI name under which the DataSource should be bound.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<use-java-context>]]></varname></term>
+ <listitem>
+ <para>
+ A boolean indicating if the <varname>jndi-name</varname> should be prefixed with <literal>java:\</literal>, which causes the DataSource to only be accessible from within the JBoss server VM. The default is <literal>true</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<user-name>]]></varname></term>
+ <listitem>
+ <para>
+ The user name used when creating the connection (not used when security is configured).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<password>]]></varname></term>
+ <listitem>
+ <para>
+ The password used when creating the connection (not used when security is configured).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<transaction-isolation>]]></varname></term>
+ <listitem>
+ <para>
+ The default transaction isolation of the connection (unspecified means use the default provided by the database):
+ </para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>
+ <literal>TRANSACTION_READ_UNCOMMITTED</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>TRANSACTION_READ_COMMITTED</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>TRANSACTION_REPEATABLE_READ</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>TRANSACTION_SERIALIZABLE</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>TRANSACTION_NONE</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<new-connection-sql>]]></varname></term>
+ <listitem>
+ <para>
+ An SQL statement that is executed against each new connection. This can be used to set the connection schema, etc.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<check-valid-connection-sql>]]></varname></term>
+ <listitem>
+ <para>
+ An SQL statement that is executed before it is checked out from the pool to make sure it is still valid. If the SQL fails, the connection is closed and new ones created.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<valid-connection-checker-class-name>]]></varname></term>
+ <listitem>
+ <para>
+ A class that can check whether a connection is valid using a vendor-specific mechanism.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<exception-sorter-class-name>]]></varname></term>
+ <listitem>
+ <para>
+ A class that looks at vendor specific messages to determine whether SQL errors are fatal and thus the connection should be destroyed. If none are specified, no errors will be treated as fatal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<track-statements>]]></varname></term>
+ <listitem>
+ <para>
+ Whether to monitor for unclosed <classname>Statement</classname>s and <classname>ResultSet</classname>s and issue warnings when the user forgets to close them. The default values is <literal>nowarn</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<prepared-statement-cache-size>]]></varname></term>
+ <listitem>
+ <para>
+ The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in a LRU cache. The default is <literal>0</literal> (zero), meaning no cache.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<share-prepared-statements>]]></varname></term>
+ <listitem>
+ <para>
+ If prepared statement cache is enabled, this defines whether two requests in the same transaction should return the same statement. The default is <literal>false</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<set-tx-query-timeout>]]></varname></term>
+ <listitem>
+ <para>
+ Whether to enable query timeout based on the length of time remaining until the transaction times out. The default value is <literal>false</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<query-timeout>]]></varname></term>
+ <listitem>
+ <para>
+ A static configuration of the maximum number of seconds before a query times out.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<metadata/typemapping>]]></varname></term>
+ <listitem>
+ <para>
+ A pointer to the type mapping in <filename>conf/standardjbosscmp.xml</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<validate-on-match>]]></varname></term>
+ <listitem>
+ <para>
+ Prior to JBoss 4.0.5, connection validation occurred when the JCA layer attempted to match a managed connection. With the addition of <varname><![CDATA[<background-validation>]]></varname>, this is no longer required. Specifying <varname><![CDATA[<validate-on-match>]]></varname> forces the old behavior. This is typically NOT used in conjunction with <varname><![CDATA[<background-validation>]]></varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<prefill>]]></varname></term>
+ <listitem>
+ <para>
+ Whether to attempt to prefill the connection pool to the minimum number of connections. Only supporting pools (OnePool) support this feature. A warning will appear in the logs if the pool does not support this.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<background-validation>]]></varname></term>
+ <listitem>
+ <para>
+ Background connection validation has been added to reduce the overall load on the RDBMS system when validating a connection. When using this feature, JBoss will attempt to validate the current connections in the pool as a seperate thread (<classname>ConnectionValidator</classname>). The default value is <literal>false</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<idle-timeout-minutes>]]></varname></term>
+ <listitem>
+ <para>
+ Indicates the maximum time in minutes that a connection can be idle before being closed. The default is <literal>15</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<background-validation-minutes>]]></varname></term>
+ <listitem>
+ <para>
+ The interval, in minutes, that the <classname>ConnectionValidator</classname> will run. The default is <literal>10</literal>. This value should be set to something greater or less than the <varname><![CDATA[<idle-timeout-minutes>]]></varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<url-delimiter>]]></varname></term>
+ <listitem>
+ <para>
+ As of JBoss 5.x, database failover is part of the main DataSource configuration.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<url-property>]]></varname></term>
+ <listitem>
+ <para>
+ As of JBoss 5.x, database failover is part of the main DataSource configuration.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<url-selector-strategy-class-name>]]></varname></term>
+ <listitem>
+ <para>
+ As of JBoss 5.x, database failover is part of the main DataSource configuration.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname><![CDATA[<stale-connection-checker-class-name>]]></varname></term>
+ <listitem>
+ <para>
+ An implementation of <classname>org.jboss.resource.adapter.jdbc.StateConnectionChecker</classname> that will decide whether a <exceptionname>SQLException</exceptionname> that notifies of bad connections throw <classname>org.jboss.resource.adapter.jdbc.StateConnectionException</classname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>
- From JBoss Enterprise Application Platform 3.2.6 and above, <literal>track-statements</literal> has a new option:
+ From JBoss Enterprise Application Platform 3.2.6 and above, <varname>track-statements</varname> has a new option:
</para>
-<programlisting role="XML"><track-statements>nowarn</track-statements</programlisting>
+<programlisting role="XML"><![CDATA[
+<track-statements>nowarn</track-statements>
+]]></programlisting>
-<para>This option closes Statements and ResultSets without a warning. It is also the new default value.</para>
+<para>This <literal>nowarn</literal> option closes <classname>Statement</classname>s and <classname>ResultSet</classname>s without a warning. It is also the new default value.</para>
<para>
- The purpose is to workaround questionable driver behavior where the driver applies auto-commit semantics to local transactions.
+ The purpose is to work around questionable driver behavior where the driver applies auto-commit semantics to local transactions:
</para>
<programlisting role="JAVA">Connection c = dataSource.getConnection(); // auto-commit == false
PreparedStatement ps1 = c.prepareStatement(...);
@@ -1175,102 +1283,104 @@
ResultSet rs2 = ps2.executeQuery();</programlisting>
<para>
- Assuming the prepared statements are the same. For some drivers, ps2.executeQuery() will automatically close rs1 so we actually need two real prepared statements behind the scenes. This *should* only be for the auto-commit semantic where re-running the query starts a new transaction automatically. For drivers that follow the spec, you can set it to true to share the same real prepared statement.
+ This assumes that the prepared statements are the same. For some drivers, <methodname>ps2.executeQuery()</methodname> will automatically close <literal>rs1</literal>, so we actually need two real prepared statements behind the scenes. This should only be for the auto-commit semantic, where re-running the query starts a new transaction automatically. For drivers that follow the specification, you can set it to <literal>true</literal> to share the same real prepared statement.
</para>
</section>
<section><title>Generic Datasource Sample</title>
-<programlisting role="XML"><datasources>
-<local-tx-datasource>
-<jndi-name>GenericDS</jndi-name>
-<connection-url>[jdbc: url for use with Driver class]</connection-url>
-<driver-class>[fully qualified class name of java.sql.Driver implementation]</driver-class>
-<user-name>x</user-name>
-<password>y</password>
-<!-- you can include connection properties that will get passed in
-the DriverManager.getConnection(props) call-->
-<!-- look at your Driver docs to see what these might be -->
-<connection-property name="char.encoding">UTF-8</connection-property>
-<transaction-isolation>TRANSACTION_SERIALIZABLE</transaction-isolation>
-
-<!--pooling parameters-->
-<min-pool-size>5</min-pool-size>
-<max-pool-size>100</max-pool-size>
-<blocking-timeout-millis>5000</blocking-timeout-millis>
-<idle-timeout-minutes>15</idle-timeout-minutes>
-<!-- sql to call when connection is created
-<new-connection-sql>some arbitrary sql</new-connection-sql>
--->
-
-<!-- sql to call on an existing pooled connection when it is obtained from pool
-<check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql>
--->
-
-<set-tx-query-timeout/>
-<query-timeout>300</query-timeout> <!-- maximum of 5 minutes for queries -->
-
-<!-- pooling criteria. USE AT MOST ONE-->
-<!-- If you don't use JAAS login modules or explicit login
+<programlisting role="XML"><![CDATA[
+<datasources>
+<local-tx-datasource>
+<jndi-name>GenericDS</jndi-name>
+<connection-url>[jdbc: url for use with Driver class]</connection-url>
+<driver-class>[fully qualified class name of java.sql.Driver implementation]</driver-class>
+<user-name>x</user-name>
+<password>y</password>
+<!-- you can include connection properties that will get passed in
+the DriverManager.getConnection(props) call-->
+<!-- look at your Driver docs to see what these might be -->
+<connection-property name="char.encoding">UTF-8</connection-property>
+<transaction-isolation>TRANSACTION_SERIALIZABLE</transaction-isolation>
+
+<!--pooling parameters-->
+<min-pool-size>5</min-pool-size>
+<max-pool-size>100</max-pool-size>
+<blocking-timeout-millis>5000</blocking-timeout-millis>
+<idle-timeout-minutes>15</idle-timeout-minutes>
+<!-- sql to call when connection is created
+<new-connection-sql>some arbitrary sql</new-connection-sql>
+-->
+
+<!-- sql to call on an existing pooled connection when it is obtained from pool
+<check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql>
+-->
+
+<set-tx-query-timeout/>
+<query-timeout>300</query-timeout> <!-- maximum of 5 minutes for queries -->
+
+<!-- pooling criteria. USE AT MOST ONE-->
+<!-- If you don't use JAAS login modules or explicit login
getConnection(usr,pw) but rely on user/pw specified above,
-don't specify anything here -->
+don't specify anything here -->
-<!-- If you supply the usr/pw from a JAAS login module -->
-<security-domain>MyRealm</security-domain>
-
-<!-- if your app supplies the usr/pw explicitly getConnection(usr, pw) -->
-<application-managed-security/>
+<!-- If you supply the usr/pw from a JAAS login module -->
+<security-domain>MyRealm</security-domain>
+
+<!-- if your app supplies the usr/pw explicitly getConnection(usr, pw) -->
+<application-managed-security/>
-<!--Anonymous depends elements are copied verbatim into the ConnectionManager mbean config-->
-<depends>myapp.service:service=DoSomethingService</depends>
-
-</local-tx-datasource>
-
-<!-- you can include regular mbean configurations like this one -->
-<mbean code="org.jboss.tm.XidFactory"
-name="jboss:service=XidFactory">
-<attribute name="Pad">true</attribute>
-</mbean>
+<!--Anonymous depends elements are copied verbatim into the ConnectionManager mbean config-->
+<depends>myapp.service:service=DoSomethingService</depends>
+
+</local-tx-datasource>
+
+<!-- you can include regular mbean configurations like this one -->
+<mbean code="org.jboss.tm.XidFactory"
+name="jboss:service=XidFactory">
+<attribute name="Pad">true</attribute>
+</mbean>
-<!-- Here's an xa example -->
-<xa-datasource>
-<jndi-name>GenericXADS</jndi-name>
-<xa-datasource-class>[fully qualified name of class implementing javax.sql.XADataSource goes here]</xa-datasource-class>
-<xa-datasource-property name="SomeProperty">SomePropertyValue</xa-datasource-property>
-<xa-datasource-property name="SomeOtherProperty">SomeOtherValue</xa-datasource-property>
+<!-- Here's an xa example -->
+<xa-datasource>
+<jndi-name>GenericXADS</jndi-name>
+<xa-datasource-class>[fully qualified name of class implementing javax.sql.XADataSource goes here]</xa-datasource-class>
+<xa-datasource-property name="SomeProperty">SomePropertyValue</xa-datasource-property>
+<xa-datasource-property name="SomeOtherProperty">SomeOtherValue</xa-datasource-property>
-<user-name>x</user-name>
-<password>y</password>
-<transaction-isolation>TRANSACTION_SERIALIZABLE</transaction-isolation>
+<user-name>x</user-name>
+<password>y</password>
+<transaction-isolation>TRANSACTION_SERIALIZABLE</transaction-isolation>
-<!--pooling parameters-->
-<min-pool-size>5</min-pool-size>
-<max-pool-size>100</max-pool-size>
-<blocking-timeout-millis>5000</blocking-timeout-millis>
-<idle-timeout-minutes>15</idle-timeout-minutes>
-<!-- sql to call when connection is created
-<new-connection-sql>some arbitrary sql</new-connection-sql>
--->
+<!--pooling parameters-->
+<min-pool-size>5</min-pool-size>
+<max-pool-size>100</max-pool-size>
+<blocking-timeout-millis>5000</blocking-timeout-millis>
+<idle-timeout-minutes>15</idle-timeout-minutes>
+<!-- sql to call when connection is created
+<new-connection-sql>some arbitrary sql</new-connection-sql>
+-->
-<!-- sql to call on an existing pooled connection when it is obtained from pool
-<check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql>
--->
+<!-- sql to call on an existing pooled connection when it is obtained from pool
+<check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql>
+-->
-<!-- pooling criteria. USE AT MOST ONE-->
-<!-- If you don't use JAAS login modules or explicit login
+<!-- pooling criteria. USE AT MOST ONE-->
+<!-- If you don't use JAAS login modules or explicit login
getConnection(usr,pw) but rely on user/pw specified above,
-don't specify anything here -->
+don't specify anything here -->
-<!-- If you supply the usr/pw from a JAAS login module -->
-<security-domain/>
+<!-- If you supply the usr/pw from a JAAS login module -->
+<security-domain/>
-<!-- if your app supplies the usr/pw explicitly getConnection(usr, pw) -->
-<application-managed-security/>
+<!-- if your app supplies the usr/pw explicitly getConnection(usr, pw) -->
+<application-managed-security/>
-</xa-datasource>
+</xa-datasource>
-</datasources></programlisting>
+</datasources>
+]]></programlisting>
</section>
@@ -1331,20 +1441,24 @@
<section>
<title>Configuring a DataSource for remote usage</title>
<para>
- From JBoss-4.0.0 and above, there is support for accessing a DataSource from a remote client. The one change that is necessary for the client to be able to lookup the DataSource from JNDI is to specify use-java-context=false as shown here:
+ As of JBoss-4.0.0, there is support for accessing a DataSource from a remote client. The one change that is necessary for the client to be able to lookup the DataSource from JNDI is to specify <code>use-java-context=false</code>, as shown here:
</para>
-<programlisting role="XML"><datasources>
-<local-tx-datasource>
-<jndi-name>GenericDS</jndi-name>
-<use-java-context>false</use-java-context>
-<connection-url>...</connection-url>
-</programlisting>
+<programlisting role="XML"><![CDATA[
+<datasources>
+<local-tx-datasource>
+<jndi-name>GenericDS</jndi-name>
+<use-java-context>false</use-java-context>
+<connection-url>...</connection-url>
+]]></programlisting>
<para>
- This results in the DataSource being bound under the JNDI name "GenericDS" instead of the default of "java:/GenericDS" which restricts the lookup to the same VM as the jboss server.
+ This results in the DataSource being bound under the JNDI name <literal>GenericDS</literal> instead of the default of <literal>java:/GenericDS</literal>, which restricts the lookup to the same VM as the JBoss server.
</para>
-<note><title>Note</title>
-<para>JBoss does not recommend using this feature on a production environment. It requires accessing a connection pool remotely and this is an anti-pattern as connections are not serializable. Besides, transaction propagation is not supported and it could lead to connection leaks if the remote clients are unreliable (i.e crashes, network failure). If you do need to access a datasource remotely, JBoss recommends accessing it via a remote session bean facade.</para>
+<note>
+ <title>This feature is not recommended in a production environment.</title>
+ <para>
+ It requires accessing a connection pool remotely and this is an anti-pattern, as connections are not serializable. Additionally, transaction propagation is not supported and it could lead to connection leaks if the remote clients are unreliable (i.e crashes, network failure). If you do need to access a DataSource remotely, JBoss recommends accessing it via a remote session bean facade.
+ </para>
</note>
</section>
@@ -1352,48 +1466,48 @@
<section><title>Configuring a DataSource to use login modules</title>
<para>
- Add the security-domain parameter to the *-ds.xml file.
+ Add the <varname>security-domain</varname> parameter to the <filename>*-ds.xml</filename> file.
</para>
-<programlisting role="XML"><datasources>
-<local-tx-datasource>
+<programlisting role="XML"><![CDATA[
+<datasources>
+<local-tx-datasource>
...
-<security-domain>MyDomain</security-domain>
+<security-domain>MyDomain</security-domain>
...
-</local-tx-datasource>
-</datasources>
-</programlisting>
+</local-tx-datasource>
+</datasources>
+]]></programlisting>
<para>
- Add an application-policy to the login-config.xml file. The authentication section should include the configuration for your login-module. For example, if you want to encrypt the database password, use the SecureIdentityLoginModule login module.
+ Add an application-policy to the <filename>login-config.xml</filename> file. The authentication section should include the configuration for your login module. For example, if you want to encrypt the database password, use the <classname>SecureIdentityLoginModule</classname> login module.
</para>
-<programlisting role="XML"><application-policy name="MyDomain">
-<authentication>
-<login-module code="org.jboss.resource.security.SecureIdentityLoginModule" flag="required">
-<module-option name="username">scott</module-option>
-<module-option name="password">-170dd0fbd8c13748</module-option>
-<module-option name="managedConnectionFactoryName">
+<programlisting role="XML"><![CDATA[
+<application-policy name="MyDomain">
+<authentication>
+<login-module code="org.jboss.resource.security.SecureIdentityLoginModule" flag="required">
+<module-option name="username">scott</module-option>
+<module-option name="password">-170dd0fbd8c13748</module-option>
+<module-option name="managedConnectionFactoryName">
jboss.jca:service=LocalTxCM,name=OracleDSJAAS
-</module-option>
-</login-module>
-</authentication>
-</application-policy></programlisting>
+</module-option>
+</login-module>
+</authentication>
+</application-policy>
+]]></programlisting>
<para>
- In case you plan to fetch the data source connection from a web application, make sure authentication is turned on for the web application. This is in order for the Subject to be populated. If you wish for users to be able to connect anonymously, an additional login module needs to be added to the application-policy, in order to populate the security credentials. Add the UsersRolesLoginModule as the first login module in the chain. The usersProperties and rolesProperties parameters can be directed to dummy files.
+ In case you plan to fetch the DataSource connection from a web application, make sure authentication is turned on for the web application. This is in order for the <literal>Subject</literal> to be populated. If you wish for users to be able to connect anonymously, an additional login module needs to be added to the application policy, in order to populate the security credentials. Add the <classname>UsersRolesLoginModule</classname> as the first login module in the chain. The <varname>usersProperties</varname> and <varname>rolesProperties</varname> parameters can be directed to dummy files.
</para>
-<programlisting role="XML"><login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" flag="required">
-<module-option name="unauthenticatedIdentity">nobody</module-option>
-<module-option name="usersProperties">props/users.properties</module-option>
-<module-option name="rolesProperties">props/roles.properties</module-option>
-</login-module>
-</programlisting>
+<programlisting role="XML"><![CDATA[
+<login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" flag="required">
+<module-option name="unauthenticatedIdentity">nobody</module-option>
+<module-option name="usersProperties">props/users.properties</module-option>
+<module-option name="rolesProperties">props/roles.properties</module-option>
+</login-module>
+]]></programlisting>
</section>
-
-
-
-
</chapter>
More information about the jboss-cvs-commits
mailing list