[jboss-cvs] JBossAS SVN: r108617 - in projects/docs/community/6: JCA_Guide and 2 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sun Oct 17 00:22:24 EDT 2010
Author: jeff.zhang
Date: 2010-10-17 00:22:21 -0400 (Sun, 17 Oct 2010)
New Revision: 108617
Added:
projects/docs/community/6/JCA_Guide/
projects/docs/community/6/JCA_Guide/en-US/
projects/docs/community/6/JCA_Guide/en-US/Author_Group.xml
projects/docs/community/6/JCA_Guide/en-US/Book_Info.xml
projects/docs/community/6/JCA_Guide/en-US/JCA_Alternative_DBs.xml
projects/docs/community/6/JCA_Guide/en-US/JCA_Guide.xml
projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Introduction.xml
projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Reference.xml
projects/docs/community/6/JCA_Guide/en-US/JCA_Pooling.xml
projects/docs/community/6/JCA_Guide/en-US/images/
projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-7.jpg
projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-8.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_connection_factories.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_local.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_xa.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_local_tx.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx_connection_factory.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_tx_connection_factory.jpg
projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_xa.jpg
projects/docs/community/6/JCA_Guide/pom.xml
Log:
[JBAS-8019] jca document for as 6, version 1
Added: projects/docs/community/6/JCA_Guide/en-US/Author_Group.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/Author_Group.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/Author_Group.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,9 @@
+<?xml version='1.0'?>
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ ]>
+<authorgroup>
+ <author>
+ <firstname>Jeff</firstname>
+ <surname>Zhang</surname>
+ </author>
+</authorgroup>
Added: projects/docs/community/6/JCA_Guide/en-US/Book_Info.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/Book_Info.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/Book_Info.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,17 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
+
+<bookinfo>
+<title>JBoss AS 6.0 JCA Guide</title>
+ <subtitle>JCA with JBoss Application Server 6</subtitle>
+ <productname>JBoss Application Server</productname>
+ <productnumber>6.0</productnumber>
+ <pubdate>Oct 2010</pubdate>
+ <abstract>
+ <para>
+ This book is the JBoss Application Server 6 JCA Guide.
+ </para>
+ </abstract>
+ <!-- <subtitle>Authors</subtitle>-->
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
Added: projects/docs/community/6/JCA_Guide/en-US/JCA_Alternative_DBs.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/JCA_Alternative_DBs.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/JCA_Alternative_DBs.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,1224 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ ]>
+
+<chapter id="alternative_DBs">
+ <title>Use Alternative Databases with JBoss AS</title>
+ <section>
+ <title>How to Use Alternative Databases</title>
+ <para>
+ <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 AS to use alternative databases. We cover the procedures for all officially supported databases on the JBoss Application Server. They include: MySQL 5.0, PostgreSQL 8.1, Oracle 9i and 10g R2, DB2 7.2 and 8, Sybase ASE 12.5, as well as MS SQL 2005.
+ </para>
+
+ <para>Please note that in this chapter, we explain how to use alternative databases to support all services in JBoss AS. This includes all the system level services such as EJB and JMS. For individual applications (e.g., WAR or EAR) deployed in JBoss AS, 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 AS internal data -- JBoss AS will automatically create tables and data in it.</para>
+
+ </section>
+
+ <section>
+ <title>Install JDBC Drivers</title>
+
+ <para>For the JBoss Application Server and our applications to use the external database, we also need to install the database's JDBC driver. The JDBC driver is a JAR file, which you'll need to copy into your JBoss AS's <literal><JBoss_Home>/server/all/lib</literal> directory. Replace <literal>all</literal> with the server configuration you are using if needed. This file is loaded when JBoss starts up. So if you have the JBoss AS running, you'll need to shut down and restart. The availability of JDBC drivers for different databases are as follows.
+ </para>
+
+
+ <itemizedlist>
+ <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.
+
+<screen><command>sp_dboption db_name, "allow nulls by default", true</command></screen>
+
+ Refer 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>
+
+
+<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 'sysxtypes' 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 installjava program.
+
+
+<screen><command>installjava -f <jar-file-name> -S<sybase-server> -U<super-user> -P<super-pass> -D<db-name></command></screen>
+
+ Refer the installjava 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 installjava utility, but you will get a java.lang.ClassFormatError exception when you attempt to use the class. This is because Sybase Adaptive Server uses an older JVM internally, and hence 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 <literal>*-ds.xml</literal> 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 datasources root are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">mbean</emphasis>: Any number mbean elements may be specified to define MBean services that should be included in the <literal>jboss-service.xml</literal> descriptor that results from the transformation. This may be used to configure services used by the datasources.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">no-tx-datasource</emphasis>: This element is used to specify the (<literal>org.jboss.resource.connectionmanager</literal>) <literal>NoTxConnectionManager</literal> service configuration. <literal>NoTxConnectionManager</literal> is a JCA connection manager with no transaction support. The <literal>no-tx-datasource</literal> child element schema is given in <xref linkend="Configuring_JDBC_DataSources-The_non_transactional_DataSource_configuration_schema" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">local-tx-datasource</emphasis>: This element is used to specify the (<literal>org.jboss.resource.connectionmanager</literal>) <literal>LocalTxConnectionManager</literal> service configuration. <literal>LocalTxConnectionManager</literal> implements a <literal>ConnectionEventListener</literal> that implements <literal>XAResource</literal> to manage transactions through the transaction manager. To ensure that all work in a local transaction occurs over the same <literal>ManagedConnection</literal>, it includes a xid to <literal>ManagedConnection</literal> map. When a Connection is requested or a transaction started with a connection handle in use, it checks to see if a <literal>ManagedConnection</literal> already exists enrolled in the global transaction and uses it if found. Otherwise, a free <literal>ManagedConnection</literal> has its <literal>LocalTransaction</literal> started and is used. The <literal>local-tx-datasource</literal> child element!
schema is given in <xref linkend="Configuring_JDBC_DataSources-The_non_XA_DataSource_configuration_schema" />
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">xa-datasource</emphasis>: This element is used to specify the (<literal>org.jboss.resource.connectionmanager</literal>) <literal>XATxConnectionManager</literal> service configuration. <literal>XATxConnectionManager</literal> implements a <literal>ConnectionEventListener</literal> that obtains the <literal>XAResource</literal> to manage transactions through the transaction manager from the adaptor <literal>ManagedConnection</literal>. To ensure that all work in a local transaction occurs over the same <literal>ManagedConnection</literal>, it includes a xid to <literal>ManagedConnection</literal> map. When a <literal>Connection</literal> is requested or a transaction started with a connection handle in use, it checks to see if a <literal>ManagedConnection</literal> already exists enrolled in the global transaction and uses it if found. Otherwise, a free <literal>ManagedConnection</literal> has its <literal>LocalTransaction</literal> started and is !
used. The <literal>xa-datasource</literal> child element schema is given in <xref linkend="Configuring_JDBC_DataSources-The_XA_DataSource_configuration_schema" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">ha-local-tx-datasource</emphasis>: 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>
+ <listitem>
+ <para>
+ <emphasis role="bold">ha-xa-datasource</emphasis>: 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>
+ </itemizedlist>
+ <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>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">jndi-name</emphasis>: The JNDI name under which the <literal>DataSource</literal> wrapper will be bound. Note that this name is relative to the <literal>java:/</literal> context, unless <literal>use-java-context</literal> is set to false. <literal>DataSource</literal> wrappers are not usable outside of the server VM, so they are normally bound under the <literal>java:/</literal>, which isn't shared outside the local VM.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">use-java-context</emphasis>: If this is set to false the the datasource will be bound in the global JNDI context rather than the <literal>java:</literal> context.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">user-name</emphasis>: This element specifies the default username used when creating a new connection. The actual username may be overridden by the application code <literal>getConnection</literal> parameters or the connection creation context JAAS Subject.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">password</emphasis>: This element specifies the default password used when creating a new connection. The actual password may be overridden by the application code <literal>getConnection</literal> parameters or the connection creation context JAAS Subject.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">application-managed-security</emphasis>: Specifying this element indicates that connections in the pool should be distinguished by application code supplied parameters, such as from <literal>getConnection(user, pw)</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">security-domain</emphasis>: Specifying this element indicates that connections in the pool should be distinguished by JAAS Subject based information. The content of the <literal>security-domain</literal> is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS <literal>login-config.xml</literal> descriptor <literal>application-policy/name</literal> attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">security-domain-and-application</emphasis>: Specifying this element indicates that connections in the pool should be distinguished both by application code supplied parameters and JAAS Subject based information. The content of the <literal>security-domain</literal> is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS <literal>login-config.xml</literal> descriptor <literal>application-policy/name</literal> attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">min-pool-size</emphasis>: This element specifies the minimum number of connections a pool should hold. These pool instances are not created until an initial request for a connection is made. This default to 0.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">max-pool-size</emphasis>: This element specifies the maximum number of connections for a pool. No more than the <literal>max-pool-size</literal> number of connections will be created in a pool. This defaults to 20.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">blocking-timeout-millis</emphasis>: This element specifies the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 5000.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">idle-timeout-minutes</emphasis>: This element specifies the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the <literal>IdleRemover</literal> scan time, which is 1/2 the smallest idle-timeout-minutes of any pool.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">new-connection-sql</emphasis>: This is a SQL statement that should be executed when a new connection is created. This can be used to configure a connection with database specific settings not configurable via connection properties.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">check-valid-connection-sql</emphasis>: This is a SQL statement that should be run on a connection before it is returned from the pool to test its validity to test for stale pool connections. An example statement could be: <literal>select count(*) from x</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">exception-sorter-class-name</emphasis>: This specifies a class that implements the <literal>org.jboss.resource.adapter.jdbc.ExceptionSorter</literal> interface to examine database exceptions to determine whether or not the exception indicates a connection error. Current implementations include:
+ </para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>
+ org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ org.jboss.resource.adapter.jdbc.vendor.SybaseExceptionSorter
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ org.jboss.resource.adapter.jdbc.vendor.InformixExceptionSorte
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">valid-connection-checker-class-name</emphasis>: This specifies a class that implements the <literal>org.jboss.resource.adapter.jdbc.ValidConnectionChecker</literal> interface to provide a <literal>SQLException isValidConnection(Connection e)</literal> method that is called with a connection that is to be returned from the pool to test its validity. This overrides the <literal>check-valid-connection-sql</literal> when present. The only provided implementation is <literal>org.jboss.resource.adapter.jdbc.vendor.OracleValidConnectionChecker</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">track-statements</emphasis>: This boolean element specifies whether to check for unclosed statements when a connection is returned to the pool. If true, a warning message is issued for each unclosed statement. If the log4j category <literal>org.jboss.resource.adapter.jdbc.WrappedConnection</literal> has trace level enabled, a stack trace of the connection close call is logged as well. This is a debug feature that can be turned off in production.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">prepared-statement-cache-size</emphasis>: This element specifies the number of prepared statements per connection in an LRU cache, which is keyed by the SQL query. Setting this to zero disables the cache.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">depends</emphasis>: The <literal>depends</literal> element specifies the JMX <literal>ObjectName</literal> string of a service that the connection manager services depend on. The connection manager service will not be started until the dependent services have been started.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">type-mapping</emphasis>: This element declares a default type mapping for this datasource. The type mapping should match a <literal>type-mapping/name</literal> element from <literal>standardjbosscmp-jdbc.xml</literal>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Additional common child elements for both <literal>no-tx-datasource</literal> and <literal>local-tx-datasource</literal> include:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">connection-url</emphasis>: This is the JDBC driver connection URL string, for example, <literal>jdbc:hsqldb:hsql://localhost:1701</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">driver-class</emphasis>: This is the fully qualified name of the JDBC driver class, for example, <literal>org.hsqldb.jdbcDriver</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connection-property</emphasis>: The <literal>connection-property</literal> element allows you to pass in arbitrary connection properties to the <literal>java.sql.Driver.connect(url, props)</literal> method. Each <literal>connection-property</literal> specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Elements in common to the <literal>local-tx-datasource</literal> and <literal>xa-datasource</literal> are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">transaction-isolation</emphasis>: This element specifies the <literal>java.sql.Connection</literal> transaction isolation level to use. The constants defined in the Connection interface are the possible element content values and include:
+ </para>
+ <itemizedlist spacing="compact">
+ <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>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">no-tx-separate-pools</emphasis>: The presence of this element indicates that two connection pools are required to isolate connections used with JTA transaction from those used without a JTA transaction. The pools are lazily constructed on first use. Its use case is for Oracle (and possibly other vendors) XA implementations that don't like using an XA connection with and without a JTA transaction.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The unique <literal>xa-datasource</literal> child elements are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">track-connection-by-tx</emphasis>: Specifying a true value for this element makes the connection manager keep an xid to connection map and only put the connection back in the pool when the transaction completes and all the connection handles are closed or disassociated (by the method calls returning). As a side effect, we never suspend and resume the xid on the connection's <literal>XAResource</literal>. This is the same connection tracking behavior used for local transactions.
+ </para>
+ <para>
+ The XA spec implies that any connection may be enrolled in any transaction using any xid for that transaction at any time from any thread (suspending other transactions if necessary). The original JCA implementation assumed this and aggressively delisted connections and put them back in the pool as soon as control left the EJB they were used in or handles were closed. Since some other transaction could be using the connection the next time work needed to be done on the original transaction, there is no way to get the original connection back. It turns out that most <literal>XADataSource</literal> driver vendors do not support this, and require that all work done under a particular xid go through the same connection.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">xa-datasource-class</emphasis>: The fully qualified name of the <literal>javax.sql.XADataSource</literal> implementation class, for example, <literal>com.informix.jdbcx.IfxXADataSource</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">xa-datasource-property</emphasis>: The <literal>xa-datasource-property</literal> element allows for specification of the properties to assign to the <literal>XADataSource</literal> implementation class. Each property is identified by the name attribute and the property value is given by the <literal>xa-datasource-property</literal> element content. The property is mapped onto the <literal>XADataSource</literal> implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the <literal>java.beans.PropertyEditor</literal> for the type.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">isSameRM-override-value</emphasis>: A boolean flag that allows one to override the behavior of the <literal>javax.transaction.xa.XAResource.isSameRM(XAResource xaRes)</literal> method behavior on the XA managed connection. If specified, this value is used unconditionally as the <literal>isSameRM(xaRes)</literal> return value regardless of the <literal>xaRes</literal> parameter.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The failover options common to <literal>ha-xa-datasource</literal> and <literal>ha-local-tx-datasource</literal> are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">url-delimeter</emphasis>: This element specifies a character used to separate multiple JDBC URLs.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">url-property</emphasis>: In the case of XA datasources, this property specifies the name of the <literal>xa-datasource-property</literal> that contains the list of JDBC URLs to use.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+</section>
+
+<section>
+ <title>Creating a DataSource for the External Database</title>
+
+ <para>JBoss AS connects to relational databases via datasources. These datasource definitions can be found in the <literal><JBoss_Home>/server/all/deploy</literal> directory. The datasource definitions are deployable just like WAR and EAR files. The datasource files can be recognized by looking for the XML files that end in <literal>*-ds.xml</literal>.</para>
+
+<note><title>Datasource definition files</title>
+<para>The datasource definition files for all supported external databases can be found in the <literal><JBoss_Home>/docs/examples/jca</literal> directory.</para>
+</note>
+
+ <itemizedlist>
+ <listitem><para>MySQL: <literal>mysql-ds.xml</literal></para></listitem>
+ <listitem><para>PostgreSQL: <literal>postgres-ds.xml</literal></para></listitem>
+ <listitem><para>Oracle: <literal>oracle-ds.xml</literal></para></listitem>
+ <listitem><para>DB2: <literal>db2-ds.xml</literal></para></listitem>
+ <listitem><para>Sybase: <literal>sybase-ds.xml</literal></para></listitem>
+ <listitem><para>MS SQL Server: <literal>mssql-ds.xml</literal></para></listitem>
+ </itemizedlist>
+
+ <para>The following code snippet shows the <literal>mysql-ds.xml</literal> file as an example. All the other <literal>*-ds.xml</literal> files are very similiar. You will need to change the <literal>connection-url</literal>, as well as the <literal>user-name</literal> / <literal>password</literal>, to fit your own database server installation.</para>
+
+<programlisting role="XML"><datasources>
+<local-tx-datasource>
+<jndi-name>MySqlDS</jndi-name>
+<connection-url>jdbc:mysql://localhost:3306/jboss</connection-url>
+<driver-class>com.mysql.jdbc.Driver</driver-class>
+<user-name>jbossuser</user-name>
+<password>jbosspass</password>
+<exception-sorter-class-name>
+org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter
+</exception-sorter-class-name>
+<!-- should only be used on drivers after 3.22.1 with "ping" support
+<valid-connection-checker-class-name>
+org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker
+</valid-connection-checker-class-name>
+-->
+<!-- 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 -
+ MySQLValidConnectionChecker is preferred for newer drivers
+<check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql>
+ -->
+
+<!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml (optional) -->
+ <metadata>
+ <type-mapping>mySQL</type-mapping>
+ </metadata>
+ </local-tx-datasource>
+
+</datasources></programlisting>
+
+<para>Once you customized the <literal>*-ds.xml</literal> file to connect to your external database, you need to copy it to the <literal><JBoss_Home>/server/all/deploy</literal> directory. The database connection is now available through the JNDI name specified in the <literal>*-ds.xml</literal> file.</para>
+</section>
+
+<section><title>Common configuration for DataSources and ConnectionFactorys</title>
+
+ <section><title>General</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis><mbean></emphasis> - a standard jboss mbean deployment
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><depends></emphasis> - the ObjectName of an MBean service this ConnectionFactory or DataSource deployment depends upon
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><jndi-name></emphasis> - the jndi name where it is bound. This is prefixed with java by default:
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><use-java-context></emphasis> - set this to false to drop the java: context from the jndi name
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>XA</title>
+ <para>
+ <emphasis><xa-resource-timeout></emphasis> - the number of seconds passed to
+ <screen>XAResource.setTranasctionTimeout()</screen>
+ when not zero. This feature is available on JBoss AS 4.0.3 and above.
+ </para>
+ </section>
+
+
+ <section><title>Security parameters</title>
+ <para>
+
+ JCA Login Modules - are used to inject security configuration into the connection when configured
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>nothing</emphasis> - uses the user/password specified in <filename>-ds.xml</filename> for DataSources or the <literal>getConnection/createConnection</literal> method without a <literal>user/password</literal> (the default).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><application-managed-security></emphasis> - uses the user/password passed on the <literal>getConnection</literal> or <literal>createConnection</literal> request by the application.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><security-domain></emphasis> - uses the identified login module configured in <filename>conf/login-module.xml</filename>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><security-domain-and-application></emphasis> - uses the identified login module configured in <filename>conf/login-module.xml</filename> and other connection request information supplied by the application, e.g. queue or topic in JMS.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+
+ <section><title>Pooling parameters</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis><no-tx-separate-pools></emphasis> - whether separate subpools should be created for connections inside and outside JTA transactions (default false).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><min-pool-size></emphasis> - the minimum number of connections in the pool (default 0 - zero)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><max-pool-size></emphasis> - the maximum number of connections in the pool (default 20)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><blocking-timeout-millis></emphasis> - the length of time to wait for a connection to become available when all the connections are checked out (default 5000 == 5 seconds, from 3.2.4 it is 30000 == 30 seconds)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><idle-timeout-minutes></emphasis> - the number of minutes after which unused connections are closed (default 15 minutes)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><track-connection-by-tx></emphasis> - whether the connection should be <emphasis>"locked"</emphasis> to the transaction, returning it to the pool at the end of the transaction; in pre-JBoss-5.x releases the default value for Local connection factories is true and false for XA; since JBoss-5.x the default value is true for both Local and XA and the element is deprecated.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><interleaving/></emphasis> - enables interleaving for XA connection factories (this feature was added in JBoss-5.x)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><prefill></emphasis> - 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 is available in JBoss 4.0.5 and above.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><background-validation></emphasis> - In JBoss 4.0.5, background connection validation was 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 (ConnectionValidator).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><background-validation-minutes></emphasis> - The interval, in minutes, that the ConnectionValidator will run. NOTE: It is prudent to set this value to something greater or less than the <emphasis><idle-timeout-minutes></emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis><use-fast-fail></emphasis> - Whether or not to continue to attempt to acquire a connection from the pool even if the nth attempt has failed. False by default. This is to address performance issues where SQL validation may take significant time and resources to execute.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
+ <section><title>Security and Pooling</title>
+ <para>
+ Unless the ResourceAdapter has <emphasis><reauthentication-support></emphasis> 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.
+</para>
+</note>
+
+ </section>
+
+
+</section>
+
+
+
+
+
+
+ </section>
+
+ <section>
+ <title>Change Database for the JMS Services</title>
+
+ <para>The JMS service in the JBoss AS 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 <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: <literal>mysql-jdbc2-service.xml</literal></para></listitem>
+ <listitem><para>PostgreSQL: <literal>postgres-jdbc2-service.xml</literal></para></listitem>
+ <listitem><para>Oracle: <literal>oracle-jdbc2-service.xml</literal></para></listitem>
+ <listitem><para>DB2: <literal>db2-jdbc2-service.xml</literal></para></listitem>
+ <listitem><para>Sybase: <literal>sybase-jdbc2-service.xml</literal></para></listitem>
+ <listitem><para>MS SQL Server: <literal>mssql-jdbc2-service.xml</literal></para></listitem>
+ </itemizedlist>
+
+ <note>
+ <title>What about the hsqldb-jdbc-state-service.xml file?</title>
+ <para>Despite its name, the <literal>hsqldb-jdbc-state-service.xml</literal> file applies to all databases. So, there is no need to use a special <literal>jdbc-state-service.xml</literal> for each database.</para>
+ </note>
+
+ </section>
+
+ <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 Application Server. This file configures the database connection settings for the EJB2 CMP beans deployed in the JBoss AS.</para>
+
+<programlisting role="XML"><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 AS. 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_Home>/server/all/deploy/ejb3.deployer/META-INF/persistence.properties</literal> file. You need to un-comment the <literal>hibernate.dialect</literal> property and change its value 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 9i: org.hibernate.dialect.Oracle9iDialect</para></listitem>
+ <listitem><para>Oracle 10g: org.hibernate.dialect.Oracle10gDialect</para></listitem>
+ <listitem><para>Microsoft SQL Server 2005: org.hibernate.dialect.SQLServerDialect</para></listitem>
+ <listitem><para>PostgresSQL 8.1: org.hibernate.dialect.PostgreSQLDialect</para></listitem>
+ <listitem><para>MySQL 5.0: org.hibernate.dialect.MySQL5Dialect</para></listitem>
+ <listitem><para>DB2 8.0: org.hibernate.dialect.DB2Dialect</para></listitem>
+ <listitem><para>Sybase ASE 12.5: org.hibernate.dialect.SybaseDialect</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>
+ </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>
+ </note>
+
+
+
+ </section>
+
+ <section>
+ <title>Change Other JBoss AS 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>
+
+ <section>
+ <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.
+ </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.
+ </para>
+ <para>
+ In the <literal>jms/*-jdbc2-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-jdbc2-service.xml</literal> file, we change the <literal>MySqlDS</literal> to <literal>DefaultDS</literal>.
+
+ </para>
+
+
+
+ <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.</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 <literal>MySqlDS</literal> to <literal>DefaultDS</literal> 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.</para>
+
+ <para>In the <literal>jms/*-jdbc2-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-jdbc2-service.xml</literal> file, we change the <literal>MySqlDS</literal> to <literal>DefaultDS</literal>.</para>
+
+<programlisting role="XML">.. ...
+<mbean code="org.jboss.mq.pm.jdbc2.PersistenceManager"
+ name="jboss.mq:service=PersistenceManager"%gt;
+ <depends optional-attribute-name="ConnectionManager">
+ jboss.jca:service=DataSourceBinding,name=DefaultDS
+ </depends>
+... ...
+</programlisting>
+
+ </section>
+
+ <section>
+ <title>The More Flexible Way</title>
+
+ <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 AS 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>
+
+ <itemizedlist>
+ <listitem><para><literal><JBoss_Home>/server/all/conf/login-config.xml</literal>: This file is used in Java EE container managed security services.</para></listitem>
+
+ <listitem><para><literal><JBoss_Home>/server/all/conf/standardjbosscmp-jdbc.xml</literal>: 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_Home>/server/all/deploy/schedule-manager-service.xml</literal>: This file configures the EJB timer services.</para></listitem>
+
+ <listitem><para><literal><JBoss_Home>/server/all/deploy/snmp-adaptor.sar/attributes.xml</literal>: This file is used by the SNMP service.</para></listitem>
+
+ <listitem><para><literal><JBoss_Home>/server/all/deploy/juddi-service.sar/META-INF/jboss-service.xml</literal>: This file configures the UUDI service.</para></listitem>
+
+ <listitem><para><literal><JBoss_Home>/server/all/deploy/juddi-service.sar/juddi.war/WEB-INF/jboss-web.xml</literal>: 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><literal><JBoss_Home>/server/all/deploy/uuid-key-generator.sar/META-INF/jboss-service.xml</literal>: This file configures the UUDI service.</para></listitem>
+
+ <listitem><para><literal><JBoss_Home>/server/all/jms/hsqldb-jdbc-state-service.xml</literal> and <literal><JBoss_Home>/server/all/deploy-hasingleton/jms/hsqldb-jdbc-state-service.xml</literal>: Those files configure the JMS persistence service as we discussed earlier.</para></listitem>
+
+ </itemizedlist>
+
+ </section>
+
+</section>
+
+ <section>
+ <title>A Special Note About Oracle DataBases</title>
+
+ <para>In our setup discussed in this chapter, we rely on the JBoss AS 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 AS 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 AS 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_Home>/server/all/deploy/ejb-deployer.xml</literal> 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">
+ jboss.jca:service=DataSourceBinding,name=DefaultDS
+</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>
+
+ <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>
+
+<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>
+
+
+ </section>
+
+<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>
+
+</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>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xa-datasource-class> - the class implementing the XADataSource
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xa-datasource-property> - properties 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> - set to false to fix problems with Oracle
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <track-connection-by-tx/> - set to fix problems with Oracle (not necessarily in JBoss-5.x where it is enabled by default and the element is deprecated)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <no-tx-separate-pools/> - Pool Transactional and non-Transactional connections separately. Using this option will cause your total pool size to be twice max-pool-size because two actual pools will be created. Used to fix problems with Oracle.
+ </para>
+ </listitem>
+</itemizedlist>
+</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>
+
+ <para>
+ From JBoss AS 3.2.6 and above, <literal>track-statements</literal> has a new option:
+ </para>
+<programlisting role="XML"><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>
+ The purpose is to workaround 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(...);
+ResultSet rs1 = ps1.executeQuery();
+PreparedStatement ps2 = c.prepareStatement(...);
+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.
+ </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
+getConnection(usr,pw) but rely on user/pw specified above,
+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/>
+
+<!--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>
+
+<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>
+-->
+
+<!-- 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
+getConnection(usr,pw) but rely on user/pw specified above,
+don't specify anything here -->
+
+<!-- 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/>
+
+</xa-datasource>
+
+</datasources></programlisting>
+
+ </section>
+
+
+<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:
+</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>
+
+ <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.
+ </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>
+
+</section>
+
+
+<section><title>Configuring a DataSource to use login modules</title>
+ <para>
+ Add the security-domain parameter to the *-ds.xml file.
+ </para>
+
+<programlisting role="XML"><datasources>
+<local-tx-datasource>
+...
+<security-domain>MyDomain</security-domain>
+...
+</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.
+ </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">jboss.jca:service=LocalTxCM,name=OracleDSJAAS</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.
+ </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>
+
+</section>
+
+
+
+
+</chapter>
Added: projects/docs/community/6/JCA_Guide/en-US/JCA_Guide.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/JCA_Guide.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/JCA_Guide.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<book>
+
+<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+
+<part id="Introduction">
+ <title>Introduction</title>
+ <xi:include href="JCA_Guide_Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+
+<part id="JCA_Config">
+ <title>Configuration</title>
+ <xi:include href="JCA_Alternative_DBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="JCA_Pooling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+
+<part id="JCA_Reference">
+ <title>Reference</title>
+ <xi:include href="JCA_Guide_Reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+
+</book>
Added: projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Introduction.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Introduction.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Introduction.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+
+<chapter id="jca-intro.chapt">
+ <title>JCA Introduce</title>
+ <section id="jca_introduce">
+ <title>JCA Overview</title>
+
+ <para>The Java Connector Architecture (JCA) defines a standard architecture for connecting
+ the Java EE platform to heterogeneous Enterprise Information Systems (EIS).
+ Examples of EISs include Enterprise Resource Planning (ERP), mainframe transaction processing (TP),
+ databases and messaging systems.</para>
+
+ <para>The connector architecture defines a set of scalable, secure, and transactional
+ mechanisms that enable the integration of EISs with application servers and
+ enterprise applications.</para>
+
+ <para>The connector architecture also defines a Common Client Interface (CCI) for EIS
+ access. The CCI defines a client API for interacting with heterogeneous EISs.</para>
+
+ <para>The connector architecture enables an EIS vendor to provide a standard resource
+ adapter for its EIS. A resource adapter is a system-level software driver that is used
+ by a Java application to connect to an EIS. The resource adapter plugs into an
+ application server and provides connectivity between the EIS, the application server,
+ and the enterprise application. The resource adapter serves as a protocol adapter
+ that allows any arbitrary EIS communication protocol to be used for connectivity.
+ An application server vendor extends its system once to support the connector
+ architecture and is then assured of seamless connectivity to multiple EISs. Likewise,
+ an EIS vendor provides one standard resource adapter which has the capability to
+ plug in to any application server that supports the connector architecture.</para>
+
+ </section>
+
+ <section id="jca_whatsnew">
+ <title>What's New</title>
+
+ <para>New feature:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ How the JCA layer registers XA datasource for XA Resource Recovery with the JBoss TS project. See
+<xref linkend="XARecoveryinJCA" />.
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
+
Added: projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Reference.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Reference.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/JCA_Guide_Reference.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,727 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+
+<chapter id="Connectors_on_JBoss">
+ <title>Connectors on JBoss</title>
+ <subtitle>The JCA Configuration and Architecture</subtitle>
+ <para>
+ This chapter discusses the JBoss server implementation of the JavaEE Connector Architecture (JCA). JCA is a resource manager integration API whose goal is to standardize access to non-relational resources in the same way the JDBC API standardized access to relational data. The purpose of this chapter is to introduce the utility of the JCA APIs and then describe the architecture of JCA in JBoss
+ </para>
+ <section id="Connectors_on_JBoss-An_Overview_of_the_JBoss_JCA_Architecture">
+ <title>An Overview of the JBoss JCA Architecture</title>
+ <para>
+ The JBoss JCA framework provides the application server architecture extension required for the use of JCA resource adaptors. This is primarily a connection pooling and management extension along with a number of MBeans for loading resource adaptors into the JBoss server.
+ </para>
+ <para>
+ There are three coupled MBeans that make up a RAR deployment. These are the <literal>org.jboss.resource.deployment.RARDeployment</literal>, <literal>org.jboss.resource.connectionmanager.RARDeployment</literal>, and <literal>org.jboss.resource.connectionmanager.BaseConnectionManager2</literal>. The <literal>org.jboss.resource.deployment.RARDeployment</literal> is simply an encapsulation of the metadata of a RAR <literal>META-INF/ra.xml</literal> descriptor. It exposes this information as a DynamicMBean simply to make it available to the <literal>org.jboss.resource.connectionmanager.RARDeployment</literal> MBean.
+ </para>
+ <para>
+ The RARDeployer service handles the deployment of archives files containing resource adaptors (RARs). It creates the <literal>org.jboss.resource.deployment.RARDeployment</literal> MBeans when a RAR file is deployed. Deploying the RAR file is the first step in making the resource adaptor available to application components. For each deployed RAR, one or more connection factories must be configured and bound into JNDI. This task performed using a JBoss service descriptor that sets up a <literal>org.jboss.resource.connectionmanager.BaseConnectionManager2</literal> MBean implementation with a <literal>org.jboss.resource.connectionmgr.RARDeployment</literal> dependent.
+ </para>
+ <section id="An_Overview_of_the_JBoss_JCA_Architecture-BaseConnectionManager2_MBean">
+ <title>BaseConnectionManager2 MBean</title>
+ <para>
+ The <literal>org.jboss.resource.connectionmanager.BaseConnectionManager2</literal> MBean is a base class for the various types of connection managers required by the JCA spec. Subclasses include <literal>NoTxConnectionManager</literal>, <literal>LocalTxConnectionManager</literal> and <literal>XATxConnectionManager</literal>. These correspond to resource adaptors that support no transactions, local transaction and XA transaction respectively. You choose which subclass to use based on the type of transaction semantics you want, provided the JCA resource adaptor supports the corresponding transaction capability.
+ </para>
+ <para>
+ The common attributes supported by the BaseConnectionManager2 MBean are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">ManagedConnectionPool</emphasis>: This specifies the ObjectName of the MBean representing the pool for this connection manager. The MBean must have an <literal>ManagedConnectionPool</literal> attribute that is an implementation of the <literal>org.jboss.resource.connectionmanager.ManagedConnectionPool</literal> interface. Normally it will be an embedded MBean in a depends tag rather than an <literal>ObjectName</literal> reference to an existing MBean. The default MBean for use is the <literal>org.jboss.resource.connectionmanager.JBossManagedConnectionPool</literal>. Its configurable attributes are discussed below.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">CachedConnectionManager</emphasis>: This specifies the <literal>ObjectName</literal> of the <literal>CachedConnectionManager</literal> MBean implementation used by the connection manager. Normally this is specified using a depends tag with the <literal>ObjectName</literal> of the unique <literal>CachedConnectionManager</literal> for the server. The name <literal>jboss.jca:service=CachedConnectionManager</literal> is the standard setting to use.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">SecurityDomainJndiName</emphasis>: This specifies the JNDI name of the security domain to use for authentication and authorization of resource connections. This is typically of the form <literal>java:/jaas/<domain></literal> where the <literal><domain></literal> value is the name of an entry in the <literal>conf/login-config.xml</literal> JAAS login module configuration file. This defines which JAAS login modules execute to perform authentication.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">JaasSecurityManagerService</emphasis>: This is the <literal>ObjectName</literal> of the security manager service. This should be set to the security manager MBean name as defined in the <literal>conf/jboss-service.xml</literal> descriptor, and currently this is <literal>jboss.security:service=JaasSecurityManager</literal>. This attribute will likely be removed in the future.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="An_Overview_of_the_JBoss_JCA_Architecture-RARDeployment_MBean">
+ <title>RARDeployment MBean</title>
+ <para>
+ The <literal>org.jboss.resource.connectionmanager.RARDeployment</literal> MBean manages configuration and instantiation <literal>ManagedConnectionFactory</literal> instance. It does this using the resource adaptor metadata settings from the RAR <literal>META-INF/ra.xml</literal> descriptor along with the <literal>RARDeployment</literal> attributes. The configurable attributes are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">OldRarDeployment</emphasis>: This is the <literal>ObjectName</literal> of the <literal>org.jboss.resource.RarDeployment</literal> MBean that contains the resource adaptor metadata. The form of this name is <literal>jboss.jca:service=RARDeployment,name=<ra-display-name></literal> where the <literal><ra-display-name></literal> is the <literal>ra.xml</literal> descriptor <literal>display-name</literal> attribute value. The <literal>RARDeployer</literal> creates this when it deploys a RAR file. This attribute will likely be removed in the future.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">ManagedConnectionFactoryProperties</emphasis>: This is a collection of (name, type, value) triples that define attributes of the <literal>ManagedConnectionFactory</literal> instance. Therefore, the names of the attributes depend on the resource adaptor <literal>ManagedConnectionFactory</literal> instance. The following example shows the structure of the content of this attribute.
+ </para>
+<programlisting><properties>
+ <config-property>
+ <config-property-name>Attr0Name</config-property-name>
+ <config-property-type>Attr0Type</config-property-type>
+ <config-property-value>Attr0Value</config-property-value>
+ </config-property>
+ <config-property>
+ <config-property-name>Attr1Name</config-property-name>
+ <config-property-type>Attr2Type</config-property-type>
+ <config-property-value>Attr2Value</config-property-value>
+ </config-property>
+ ...
+</properties>
+</programlisting>
+ <para>
+ <literal>AttrXName</literal> is the Xth attribute name, <literal>AttrXType</literal> is the fully qualified Java type of the attribute, and <literal>AttrXValue</literal> is the string representation of the value. The conversion from string to <literal>AttrXType</literal> is done using the <literal>java.beans.PropertyEditor</literal> class for the <literal>AttrXType</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">JndiName</emphasis>: This is the JNDI name under which the resource adaptor will be made available. Clients of the resource adaptor use this name to obtain either the <literal>javax.resource.cci.ConnectionFactory</literal> or resource adaptor specific connection factory. The full JNDI name will be <literal>java:/<JndiName></literal> meaning that the <literal>JndiName</literal> attribute value will be prefixed with <literal>java:/</literal>. This prevents use of the connection factory outside of the JBoss server VM. In the future this restriction may be configurable.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="An_Overview_of_the_JBoss_JCA_Architecture-JBossManagedConnectionPool_MBean">
+ <title>JBossManagedConnectionPool MBean</title>
+ <para>
+ The <literal>org.jboss.resource.connectionmanager.JBossManagedConnectionPool</literal> MBean is a connection pooling MBean. It is typically used as the embedded MBean value of the <literal>BaseConnectionManager2</literal><literal>ManagedConnectionPool</literal> attribute. When you setup a connection manager MBean you typically embed the pool configuration in the connection manager descriptor. The configurable attributes of the <literal>JBossManagedConnectionPool</literal> are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">ManagedConnectionFactoryName</emphasis>: This specifies the <literal>ObjectName</literal> of the MBean that creates <literal>javax.resource.spi.ManagedConnectionFactory</literal> instances. Normally this is configured as an embedded MBean in a depends element rather than a separate MBean reference using the <literal>RARDeployment</literal> MBean. The MBean must provide an appropriate <literal>startManagedConnectionFactory</literal> operation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">MinSize</emphasis>: This attribute indicates the minimum number of connections this pool should hold. These are not created until a <literal>Subject</literal> is known from a request for a connection. <literal>MinSize</literal> connections will be created for each sub-pool.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">MaxSize</emphasis>: This attribute indicates the maximum number of connections for a pool. No more than MaxSize connections will be created in each sub-pool.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">BlockingTimeoutMillis</emphasis>: This attribute indicates the maximum time to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">IdleTimeoutMinutes</emphasis>: This attribute indicates the maximum time a connection may be idle before being closed. The actual maximum time depends also on the idle remover thread scan time, which is 1/2 the smallest idle timeout of any pool.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">NoTxSeparatePools</emphasis>: Setting this to true doubles the available pools. One pool is for connections used outside a transaction the other inside a transaction. The actual pools are lazily constructed on first use. This is only relevant when setting the pool parameters associated with the <literal>LocalTxConnectionManager</literal> and <literal>XATxConnectionManager</literal>. Its use case is for Oracle (and possibly other vendors) XA implementations that don't like using an XA connection with and without a JTA transaction.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Criteria</emphasis>: This attribute indicates if the JAAS <literal>javax.security.auth.Subject</literal> from security domain associated with the connection, or app supplied parameters (such as from <literal>getConnection(user, pw)</literal>) are used to distinguish connections in the pool. The allowed values are:
+ </para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>
+ <emphasis role="bold">ByContainer</emphasis>: use <literal>Subject</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">ByApplication</emphasis>: use application supplied parameters only
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">ByContainerAndApplication</emphasis>: use both
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">ByNothing</emphasis>: all connections are equivalent, usually if adapter supports reauthentication
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="An_Overview_of_the_JBoss_JCA_Architecture-CachedConnectionManager_MBean">
+ <title>CachedConnectionManager MBean</title>
+ <para>
+ The <literal>org.jboss.resource.connectionmanager.CachedConnectionManager</literal> MBean manages associations between meta-aware objects (those accessed through interceptor chains) and connection handles, as well as between user transactions and connection handles. Normally there should only be one such MBean, and this is configured in the core <literal>jboss-service.xml</literal> descriptor. It is used by <literal>CachedConnectionInterceptor</literal>, JTA <literal>UserTransaction</literal> implementation and all <literal>BaseConnectionManager2</literal> instances. The configurable attributes of the <literal>CachedConnectionManager</literal> MBean are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">SpecCompliant</emphasis>: Enable this boolean attribute for spec compliant non-shareable connections reconnect processing. This allows a connection to be opened in one call and used in another. Note that specifying this behavior disables connection close processing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Debug</emphasis>: Enable this boolean property for connection close processing. At the completion of an EJB method invocation, unclosed connections are registered with a transaction synchronization. If the transaction ends without the connection being closed, an error is reported and JBoss closes the connection. This is a development feature that should be turned off in production for optimal performance.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">TransactionManagerServiceName</emphasis>: This attribute specifies the JMX <literal>ObjectName</literal> of the JTA transaction manager service. Connection close processing is now synchronized with the transaction manager and this attribute specifies the transaction manager to use.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="An_Overview_of_the_JBoss_JCA_Architecture-A_Sample_Skeleton_JCA_Resource_Adaptor">
+ <title>A Sample Skeleton JCA Resource Adaptor</title>
+ <para>
+ To conclude our discussion of the JBoss JCA framework we will create and deploy a single non-transacted resource adaptor that simply provides a skeleton implementation that stubs out the required interfaces and logs all method calls. We will not discuss the details of the requirements of a resource adaptor provider as these are discussed in detail in the JCA specification. The purpose of the adaptor is to demonstrate the steps required to create and deploy a RAR in JBoss, and to see how JBoss interacts with the adaptor.
+ </para>
+ <para>
+ The adaptor we will create could be used as the starting point for a non-transacted file system adaptor. The source to the example adaptor can be found in the <literal>src/main/org/jboss/book/jca/ex1</literal> directory of the book examples. A class diagram that shows the mapping from the required <literal>javax.resource.spi</literal> interfaces to the resource adaptor implementation is given in <xref linkend="A_Sample_Skeleton_JCA_Resource_Adaptor-The_file_system_RAR_class_diagram" />.
+ </para>
+ <figure id="A_Sample_Skeleton_JCA_Resource_Adaptor-The_file_system_RAR_class_diagram">
+ <title>The file system RAR class diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/javaee_chap7-7.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ We will build the adaptor, deploy it to the JBoss server and then run an example client against an EJB that uses the resource adaptor to demonstrate the basic steps in a complete context. We'll then take a look at the JBoss server log to see how the JBoss JCA framework interacts with the resource adaptor to help you better understand the components in the JCA system level contract.
+ </para>
+ <para>
+ To build the example and deploy the RAR to the JBoss server <literal>deploy/lib</literal> directory, execute the following Ant command in the book examples directory.
+ </para>
+<programlisting>[examples]$ ant -Dchap=jca build-chap</programlisting>
+ <para>
+ The deployed files include a <literal>jca-ex1.sar</literal> and a <literal>notxfs-service.xml</literal> service descriptor. The example resource adaptor deployment descriptor is shown in <xref linkend="A_Sample_Skeleton_JCA_Resource_Adaptor-The_nontransactional_file_system_resource_adaptor_deployment_descriptor." />.
+ </para>
+ <example id="A_Sample_Skeleton_JCA_Resource_Adaptor-The_nontransactional_file_system_resource_adaptor_deployment_descriptor."><title>The nontransactional file system resource adaptor deployment descriptor.</title>
+<programlisting><?xml version="1.0" encoding="UTF-8"?>
+<connector xmlns="http://java.sun.com/xml/ns/connector
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
+ http://java.sun.com/xml/ns/j2ee/connector_1_5.xsd" version="1.5">
+ <display-name>File System Adapter</display-name>
+ <vendor-name>JBoss</vendor-name>
+ <eis-type>FileSystem</eis-type>
+ <resourceadapter-version>1.0</resourceadapter-version>
+ <license>
+ <description>LGPL</description>
+ <license-required>false</license-required>
+ </license>
+ <resourceadapter>
+ <resourceadapter-class>
+ org.jboss.resource.deployment.DummyResourceAdapter
+ </resourceadapter-class>
+ <outbound-resourceadapter>
+ <connection-definition>
+ <emphasis role="bold"><managedconnectionfactory-class> org.jboss.book.jca.ex1.ra.FSManagedConnectionFactory </managedconnectionfactory-class></emphasis>
+ <config-property>
+ <config-property-name>FileSystemRootDir</config-property-name>
+ <config-property-type>java.lang.String</config-property-type>
+ <config-property-value>/tmp/db/fs_store</config-property-value>
+ </config-property>
+ <config-property>
+ <config-property-name>UserName</config-property-name>
+ <config-property-type>java.lang.String</config-property-type>
+ <config-property-value/>
+ </config-property>
+ <config-property>
+ <config-property-name>Password</config-property-name>
+ <config-property-type>java.lang.String</config-property-type>
+ <config-property-value/>
+ </config-property>
+ <emphasis role="bold"><connectionfactory-interface> org.jboss.book.jca.ex1.ra.DirContextFactory </connectionfactory-interface> <connectionfactory-impl-class> org.jboss.book.jca.ex1.ra.DirContextFactoryImpl </connectionfactory-impl-class> <connection-interface> javax.naming.directory.DirContext </connection-interface> <connection-impl-class> org.jboss.book.jca.ex1.ra.FSDirContext </connection-impl-class></emphasis>
+ </connection-definition>
+ <transaction-support>NoTransaction</transaction-support>
+ <authentication-mechanism>
+ <authentication-mechanism-type>BasicPassword</authentication-mechanism-type>
+ <credential-interface>
+ javax.resource.spi.security.PasswordCredential
+ </credential-interface>
+ </authentication-mechanism>
+ <emphasis role="bold"><reauthentication-support>true</reauthentication-support></emphasis>
+ </outbound-resourceadapter>
+ <security-permission>
+ <description> Read/Write access is required to the contents of the
+ FileSystemRootDir </description>
+ <security-permission-spec> permission java.io.FilePermission
+ "/tmp/db/fs_store/*", "read,write";
+ </security-permission-spec>
+ </security-permission>
+ </resourceadapter>
+</connector>
+</programlisting>
+ </example><para>
+ The key items in the resource adaptor deployment descriptor are highlighted in bold. These define the classes of the resource adaptor, and the elements are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">managedconnectionfactory-class</emphasis>: The implementation of the <literal>ManagedConnectionFactory</literal> interface, <literal>org.jboss.book.jca.ex1.ra.FSManagedConnectionFactory</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connectionfactory-interface</emphasis>: This is the interface that clients will obtain when they lookup the connection factory instance from JNDI, here a proprietary resource adaptor value, <literal>org.jboss.book.jca.ex1.ra.DirContextFactory</literal>. This value will be needed when we create the JBoss <literal>ds.xml</literal> to use the resource.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connectionfactory-impl-class</emphasis>: This is the class that provides the implementation of the <literal>connectionfactory-interface</literal>, <literal>org.jboss.book.jca.ex1.ra.DirContextFactoryImpl</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connection-interface</emphasis>: This is the interface for the connections returned by the resource adaptor connection factory, here the JNDI <literal>javax.naming.directory.DirContext</literal> interface.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connection-impl-class</emphasis>: This is he class that provides the <literal>connection-interface</literal> implementation, <literal>org.jboss.book.jca.ex1.ra.FSDirContext</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">transaction-support</emphasis>: The level of transaction support, here defined as <literal>NoTransaction</literal>, meaning the file system resource adaptor does not do transactional work.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The RAR classes and deployment descriptor only define a resource adaptor. To use the resource adaptor it must be integrated into the JBoss application server using a <literal>ds.xml</literal> descriptor file. An example of this for the file system adaptor is shown in <xref linkend="A_Sample_Skeleton_JCA_Resource_Adaptor-The_notxfs_ds.xml_resource_adaptor_MBeans_service_descriptor." />.
+ </para>
+ <example id="A_Sample_Skeleton_JCA_Resource_Adaptor-The_notxfs_ds.xml_resource_adaptor_MBeans_service_descriptor."><title>The notxfs-ds.xml resource adaptor MBeans service descriptor.</title>
+<programlisting><!DOCTYPE connection-factories PUBLIC
+ "-//JBoss//DTD JBOSS JCA Config 1.5//EN"
+ "http://www.jboss.org/j2ee/dtd/jboss-ds_1_5.dtd">
+<!--
+ The non-transaction FileSystem resource adaptor service configuration
+-->
+<connection-factories>
+ <no-tx-connection-factory>
+ <jndi-name>NoTransFS</jndi-name>
+ <rar-name>jca-ex1.rar</rar-name>
+ <connection-definition>
+ org.jboss.book.jca.ex1.ra.DirContextFactory
+ </connection-definition>
+ <config-property name="FileSystemRootDir"
+ type="java.lang.String">/tmp/db/fs_store</config-property>
+ </no-tx-connection-factory>
+</connection-factories>
+</programlisting>
+ </example><para>
+ The main attributes are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">jndi-name</emphasis>: This specifies where the connection factory will be bound into JNDI. For this deployment that binding will be <literal>java:/NoTransFS</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">rar-name</emphasis>: This is the name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like <literal>myapplication.ear#my.rar</literal>. In this example, it is simply <literal>jca-ex1.rar</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">connection-definition</emphasis>: This is the connection factory interface class. It should match the <literal>connectionfactory-interface</literal> in the <literal>ra.xml</literal> file. Here our connection factory interface is <literal>org.jboss.book.jca.ex1.ra.DirContextFactory</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">config-property</emphasis>: This can be used to provide non-default settings to the resource adaptor connection factory. Here the <literal>FileSystemRootDir</literal> is being set to <literal>/tmp/db/fs_store</literal>. This overrides the default value in the <literal>ra.xml</literal> file.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ To deploy the RAR and connection manager configuration to the JBoss server, run the following:
+ </para>
+<programlisting>[examples]$ ant -Dchap=jca config</programlisting>
+ <para>
+ The server console will display some logging output indicating that the resource adaptor has been deployed.
+ </para>
+ <para>
+ Now we want to test access of the resource adaptor by a JavaEE component. To do this we have created a trivial stateless session bean that has a single method called <literal>echo</literal>. Inside of the <literal>echo</literal> method the EJB accesses the resource adaptor connection factory, creates a connection, and then immediately closes the connection. The <literal>echo</literal> method code is shown below.
+ </para>
+ <example id="A_Sample_Skeleton_JCA_Resource_Adaptor-The_stateless_session_bean_echo_method_code_that_shows_the_access_of_the_resource_adaptor_connection_factory."><title>The stateless session bean echo method code that shows the access of the resource adaptor connection factory.</title>
+<programlisting>public String echo(String arg)
+{
+ log.info("echo, arg="+arg);
+ try {
+ InitialContext ctx = new InitialContext();
+ Object ref = ctx.lookup("java:comp/env/ra/DirContextFactory");
+ log.info("echo, ra/DirContextFactory=" + ref);
+
+ DirContextFactory dcf = (DirContextFactory) ref;
+ log.info("echo, found dcf=" + dcf);
+
+ DirContext dc = dcf.getConnection();
+ log.info("echo, lookup dc=" + dc);
+
+ dc.close();
+ } catch(NamingException e) {
+ log.error("Failed during JNDI access", e);
+ }
+ return arg;
+}
+</programlisting>
+ </example><para>
+ The EJB is not using the CCI interface to access the resource adaptor. Rather, it is using the resource adaptor specific API based on the proprietary <literal>DirContextFactory</literal> interface that returns a JNDI <literal>DirContext</literal> object as the connection object. The example EJB is simply exercising the system contract layer by looking up the resource adaptor connection factory, creating a connection to the resource and closing the connection. The EJB does not actually do anything with the connection, as this would only exercise the resource adaptor implementation since this is a non-transactional resource.
+ </para>
+ <para>
+ Run the test client which calls the <literal>EchoBean.echo</literal> method by running Ant as follows from the examples directory:
+ </para>
+<programlisting>[examples]$ ant -Dchap=jca -Dex=1 run-example</programlisting>
+ <para>
+ You'll see some output from the bean in the system console, but much more detailed logging output can be found in the <literal>server/production/log/server.log</literal> file. Don't worry if you see exceptions. They are just stack traces to highlight the call path into parts of the adaptor. To help understand the interaction between the adaptor and the JBoss JCA layer, we'll summarize the events seen in the log using a sequence diagram. <xref linkend="A_Sample_Skeleton_JCA_Resource_Adaptor-A_sequence_diagram_illustrating_the_key_interactions_between_the_JBoss_JCA_framework_and_the_example_resource_adaptor_that_result_when_the_EchoBean_accesses_the_resource_adaptor_connection_factory." /> is a sequence diagram that summarizes the events that occur when the <literal>EchoBean</literal> accesses the resource adaptor connection factory from JNDI and creates a connection.
+ </para>
+ <figure id="A_Sample_Skeleton_JCA_Resource_Adaptor-A_sequence_diagram_illustrating_the_key_interactions_between_the_JBoss_JCA_framework_and_the_example_resource_adaptor_that_result_when_the_EchoBean_accesses_the_resource_adaptor_connection_factory.">
+ <title>A sequence diagram illustrating the key interactions between the JBoss JCA framework and the example resource adaptor that result when the EchoBean accesses the resource adaptor connection factory.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/javaee_chap7-8.jpg" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The starting point is the client's invocation of the <literal>EchoBean.echo</literal> method. For the sake of conciseness of the diagram, the client is shown directly invoking the EchoBean.echo method when in reality the JBoss EJB container handles the invocation. There are three distinct interactions between the <literal>EchoBean</literal> and the resource adaptor; the lookup of the connection factory, the creation of a connection, and the close of the connection.
+ </para>
+ <para>
+ The lookup of the resource adaptor connection factory is illustrated by the 1.1 sequences of events. The events are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ the echo method invokes the <literal>getConnection</literal> method on the resource adaptor connection factory obtained from the JNDI lookup on the <literal>java:comp/env/ra/DirContextFactory</literal> name which is a link to the <literal>java:/NoTransFS</literal> location.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <literal>DirContextFactoryImpl</literal> class asks its associated <literal>ConnectionManager</literal> to allocate a connection. It passes in the <literal>ManagedConnectionFactory</literal> and <literal>FSRequestInfo</literal> that were associated with the <literal>DirContextFactoryImpl</literal> during its construction.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <literal>ConnectionManager</literal> invokes its <literal>getManagedConnection</literal> method with the current <literal>Subject</literal> and <literal>FSRequestInfo</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <literal>ConnectionManager</literal> asks its object pool for a connection object. The <literal>JBossManagedConnectionPool$BasePool</literal> is get the key for the connection and then asks the matching <literal>InternalPool</literal> for a connection.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Since no connections have been created the pool must create a new connection. This is done by requesting a new managed connection from the <literal>ManagedConnectionFactory</literal>. The <literal>Subject</literal> associated with the pool as well as the <literal>FSRequestInfo</literal> data are passed as arguments to the <literal>createManagedConnection</literal> method invocation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <literal>ConnectionFactory</literal> creates a new <literal>FSManagedConnection</literal> instance and passes in the <literal>Subject</literal> and <literal>FSRequestInfo</literal> data.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ a <literal>javax.resource.spi.ConnectionListener</literal> instance is created. The type of listener created is based on the type of <literal>ConnectionManager</literal>. In this case it is an <literal>org.jboss.resource.connectionmgr.BaseConnectionManager2$NoTransactionListener</literal> instance.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the listener registers as a <literal>javax.resource.spi.ConnectionEventListener</literal> with the <literal>ManagedConnection</literal> instance created in 1.2.1.1.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the <literal>ManagedConnection</literal> is asked for the underlying resource manager connection. The <literal>Subject</literal> and <literal>FSRequestInfo</literal> data are passed as arguments to the <literal>getConnection</literal> method invocation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The resulting connection object is cast to a <literal>javax.naming.directory.DirContext</literal> instance since this is the public interface defined by the resource adaptor.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After the <literal>EchoBean</literal> has obtained the <literal>DirContext</literal> for the resource adaptor, it simply closes the connection to indicate its interaction with the resource manager is complete.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ This concludes the resource adaptor example. Our investigation into the interaction between the JBoss JCA layer and a trivial resource adaptor should give you sufficient understanding of the steps required to configure any resource adaptor. The example adaptor can also serve as a starting point for the creation of your own custom resource adaptors if you need to integrate non-JDBC resources into the JBoss server environment.
+ </para>
+ </section>
+
+ </section>
+
+
+<section id="XARecoveryinJCA">
+ <title>XA Recovery in the JCA layer</title>
+
+ <para>Describes the design of how the JCA layer registers XA datasource for XA Resource Recovery with the JBoss TS project.</para>
+
+ <section id="JCA_XARecovery_Goals">
+ <title>Goals</title>
+ <para>The goal of the feature is to register XA datasource with the JBoss TS project through the <code>org.jboss.tm.XAResourceRecovery</code> interface.</para>
+
+
+ <para>This is done by register the component that implements the above with the <code>org.jboss.tm.XAResourceRecoveryRegistry</code>
+ component through its addXAResourceRecovery() / removeXAResourceRecovery() methods.</para>
+
+ <para>The XAResourceRecovery interface contains the method</para>
+
+ <programlisting>
+<![CDATA[
+/**
+* Provides XAResource(s) to the transaction system for recovery purposes.
+*
+* @return An array of XAResource objects for use in transaction recovery
+* In most cases the implementation will need to return only a single XAResource in the array.
+* For more sophisticated cases, such as where multiple different connection types are supported,
+* it may be necessary to return more than one.
+*
+* The Resource should be instantiated in such a way as to carry the necessary permissions to
+* allow transaction recovery. For some deployments it may therefore be necessary or desirable to
+* provide resource(s) based on e.g. database connection parameters such as username other than those
+* used for the regular application connections to the same resource manager.
+*/
+public XAResource[] getXAResources()
+]]>
+ </programlisting>
+
+ <para>which must return a single XAResource that represents the datasource.</para>
+ </section>
+ <section id="JCA_XARecovery_Requirements">
+ <title>Requirements</title>
+ <para>The JCA specification states that XA recovery is done through</para>
+
+
+<code>ManagedConnection mc = mcf.createManagedConnection(subject, null)</code>
+
+
+ <para>where "mcf" is the ManagedConnectionFactory and "subject" represents the javax.security.auth.Subject instance.</para>
+
+
+ <para>This ties into the above with</para>
+
+
+<code>XAResource xaResource = mc.getXAResource()</code>
+
+
+ <para>In order to provide additional information to JBoss TS we can use an instance of the <code>org.jboss.tm.XAResourceWrapper</code> interface.</para>
+
+ </section>
+ <section id="JCA_XARecovery_Design">
+ <title>Design</title>
+ <para>First some considerations:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ The current JCA container is based on the JBoss JMX architecture, so we must use a mix of JBoss Microcontainer and JBoss JMX in order to implement this feature.
+ </listitem>
+ <listitem>
+ We must create a new -ds.xml which can contain the needed security information for recovery.
+ </listitem>
+ <listitem>
+ We should keep changes as local as possible such that the patch overhead is minimal.
+ </listitem>
+ </itemizedlist>
+
+ </section>
+ <section id="JCA_XARecovery_MC_JMX">
+ <title>MC vs. JMX</title>
+ <para>We will bridge the JBoss Microcontainer components with the JBoss JMX components using the
+
+<code>org.jboss.system.metadata</code>
+
+ package in our builders.</para>
+
+ </section>
+ <section id="JCA_XARecovery_DsXML">
+ <title>New -ds.xml file</title>
+ <para>We will create a jboss-ds_5_1.dtd (EAP 5.1) / jboss-ds_6_0.dtd (AS 6) which has the additional fields of</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ recover-user-name
+ </listitem>
+ <listitem>
+ recover-password
+ </listitem>
+ <listitem>
+ recover-security-domain
+ </listitem>
+ <listitem>
+ no-recover
+ </listitem>
+ </itemizedlist>
+
+ <para>The first two will represent a user and password pair which has the credentials to perform the recovery operation. The third likewise, but using a security domain instead. The last field is to exclude a datasource from recovery.</para>
+
+
+ <para>The fields should have a fall back value of their non-recover counterparts - e.g. user-name, password and security-domain.</para>
+
+ </section>
+ <section id="JCA_XARecovery_Min_Changes">
+ <title>Minimal changes</title>
+ <para>We should limit the main changes to</para>
+
+<code>org.jboss.resource.connectionmanager.ManagedConnectionFactoryDeployment</code>
+
+ <para>which controls the ManagedConnectionFactory for the resource adapter.</para>
+
+ </section>
+ <section id="JCA_XARecovery_Implementation">
+ <title>Implementation</title>
+ <para>We will make the following changes:</para>
+<code>org/jboss/resource/metadata/mcf/XADataSourceDeploymentMetaData</code>
+
+ <para>Add support for the new fields in jboss-ds_5_1.dtd / jboss-ds_6_0.dtd</para>
+
+<code>org/jboss/resource/metadata/mcf/RecoverSecurityDomainMetaData</code>
+
+ <para>will represent recover-security-domain.</para>
+
+<code>org/jboss/resource/deployers/builder/ManagedConnectionFactoryBuilder</code>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Make the "SubjectFactory" MC bean a required dependency
+ </listitem>
+ <listitem>
+ Make the "jboss:service=TransactionManager" JMX bean a required dependency (EAP)
+ </listitem>
+ <listitem>
+ Make the "RecoveryManager" MC bean a required dependency (AS)
+ </listitem>
+ <listitem>
+
+ Pass the JMX ObjectName for the connection manager to the generated
+ <code>ManagedConnectionFactoryDeployment</code> in the constructor
+<code>org/jboss/resource/connectionmanager/ManagedConnectionFactoryDeployment</code>
+ </listitem>
+ <listitem>
+ startService()
+ <itemizedlist spacing="compact">
+ <listitem>
+ If XA datasource and XAResourceRecovery is defined
+ <itemizedlist spacing="compact">
+ <listitem>
+ Extract the recover user name, password and security domain from the configuration
+ </listitem>
+ <listitem>
+ Fall back to standard values
+ </listitem>
+ <listitem>
+ Register with XAResourceRecovery
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ stopService()
+ <itemizedlist spacing="compact">
+ <listitem>
+ If we are registered for recovery
+ <itemizedlist spacing="compact">
+ <listitem>
+ Unregister with XAResourceRecovery
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ getXAResources()
+ <itemizedlist spacing="compact">
+ <listitem>
+ Get the subject
+ </listitem>
+ <listitem>
+ Get the ManagedConnection
+ </listitem>
+ <listitem>
+ Get the XAResource
+ </listitem>
+ <listitem>
+ If possible create a XAResourceWrapperImpl based on the values from the connection manager
+ </listitem>
+ <listitem>
+ Return
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ getSubject()
+ <itemizedlist spacing="compact">
+ <listitem>
+ If no security domain is defined
+ <itemizedlist spacing="compact">
+ <listitem>
+ Create a SimplePrincipal
+ </listitem>
+ <listitem>
+ Create a PasswordCredential
+ </listitem>
+ <listitem>
+ Assign ManagedConnectionFactory to PasswordCredential
+ </listitem>
+ <listitem>
+ Add above to Subject
+ </listitem>
+ <listitem>
+ Return
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ If security domain is defined
+ <itemizedlist spacing="compact">
+ <listitem>
+ Use Unauthenticated subject to access security domain
+ </listitem>
+ <listitem>
+ Get Subject from security domain
+ </listitem>
+ <listitem>
+ Return
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para>The implementation can be tested using the XA recovery test cases in the JBoss Application Server test suite.</para>
+
+ </section>
+ <section id="JCA_XARecovery_Availability">
+ <title>Availability</title>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ JBoss Enterprise Application Platform 5.1 or higher
+ </listitem>
+ <listitem>
+ JBoss Application Server 6.0.0.M4 or higher
+ </listitem>
+ </itemizedlist>
+ </section>
+</section>
+</chapter>
+
Added: projects/docs/community/6/JCA_Guide/en-US/JCA_Pooling.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/en-US/JCA_Pooling.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/en-US/JCA_Pooling.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,233 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ ]>
+
+<chapter id="pooling">
+<title>Pooling</title>
+<section><title>Strategy</title>
+<para>
+ <indexterm><primary>Pooling</primary><secondary>JBossJCA</secondary></indexterm>
+<ulink url="http://www.jboss.org/wiki/JBossJCA">JBossJCA</ulink> uses a <literal>ManagedConnectionPool</literal> to perform the pooling. The <literal>ManagedConnectionPool</literal> is made up of subpools depending upon the strategy chosen and other pooling parameters.
+</para>
+
+<informaltable frame="all">
+<tgroup cols="5"><tbody>
+<row>
+<entry>
+<para>xml</para>
+</entry>
+<entry>
+<para>mbean</para>
+</entry>
+<entry>
+<para>Internal Name</para>
+</entry>
+<entry>
+<para>Description</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para/>
+</entry>
+<entry>
+<para>ByNothing</para>
+</entry>
+<entry>
+<para>OnePool</para>
+</entry>
+<entry>
+<para>A single pool of equivalent connections</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><application-managed-security/></para>
+</entry>
+<entry>
+<para>ByApplication</para>
+</entry>
+<entry>
+<para>PoolByCRI</para>
+</entry>
+<entry>
+<para>Use the connection properties from allocateConnection()</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain/></para>
+</entry>
+<entry>
+<para>ByContainer</para>
+</entry>
+<entry>
+<para>PoolBySubject</para>
+</entry>
+<entry>
+<para>A pool per Subject, e.g. preconfigured or EJB/Web login subjects</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain-and-applicaton/></para>
+</entry>
+<entry>
+<para>ByContainerAndApplicaton</para>
+</entry>
+<entry>
+<para>PoolBySubjectAndCri</para>
+</entry>
+<entry>
+<para>A per Subject and connection property combination</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row></tbody></tgroup>
+</informaltable>
+
+<note><title>Note</title>
+<para>The xml names imply this is just about security. This is misleading. </para>
+</note>
+
+<para>
+For <security-domain-and-application/> the Subject always overrides any user/password from createConnection(user, password) in the CRI: </para>
+
+<screen>(
+ConnectionRequestInfo
+) </screen>
+</section>
+
+
+<section><title>Transaction stickness</title>
+<para>
+You can force the same connection from a (sub-)pool to get reused throughout a transaction with the <track-connection-by-tx/> flag
+</para>
+
+<note><title>Note</title>
+<para>This is the only supported behaviour for <emphasis>"local"</emphasis> transactions. This element is deprecated in JBoss-5.x where transaction stickiness is enabled by default. XA users can explicitly enable interleaving with <interleaving/> element.</para>
+</note>
+</section>
+
+<section><title>Workaround for Oracle</title>
+<para>Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts using <no-tx-separate-pools/>.</para>
+</section>
+
+<section><title>Pool Access</title>
+<para>
+The pool is designed for concurrent usage.
+</para>
+
+<para>
+Upto <max-pool-size/> threads can be inside the pool at the same time (or using connections from a pool).
+</para>
+<para>
+Once this limit is reached, threads wait for the <blocking-timeout-seconds/> to use the pool before throwing a <ulink url="http://www.jboss.org/wiki/WhatDoesTheMessageNoManagedConnectionsAvailableMean">No Managed Connections Available</ulink>
+</para>
+</section>
+
+<section><title>Pool Filling</title>
+<para>
+The number of connections in the pool is controlled by the pool sizes.
+</para>
+<itemizedlist>
+<listitem>
+<para><min-pool-size/> - When the number of connections falls below this size, new connections are created</para>
+</listitem>
+<listitem>
+<para><max-pool-size/> - No more than this number of connections are created</para>
+</listitem>
+<listitem>
+<para><prefill/> - Feature Request has been implemented for 4.0.5. Note: the only pooling strategy that supports this feature is OnePool?, or ByNothing? pooling criteria.</para>
+</listitem>
+</itemizedlist>
+<para>
+The pool filling is done by a separate "Pool Filler" thread rather than blocking application threads.</para>
+</section>
+
+<section><title>Idle Connections</title>
+<para>
+You can configure connections to be closed when they are idle. e.g. If you just had a peak period and now want to reap the unused ones. This is done via the <idle-timeout-minutes/>.</para>
+
+<para>
+Idle checking is done on a separate "Idle Remover" thread on an LRU (least recently used) basis. The check is done every idle-timeout-minutes divided by 2 for connections unused for idle-timeout-minutes.</para>
+<para>
+The pool itself operates on an MRU (most recently used) basis. This allows the excess connections to be easily identified.
+</para>
+<para>
+Should closing idle connections cause the pool to fall below the min-pool-size, new/fresh connections are created.
+</para>
+<note><title>Note</title>
+<para>If you have long running transactions and you use interleaving (i.e. don't track-connection-by-tx) make sure the idle timeout is greater than the transaction timeout. When interleaving the connection is returned to the pool for others to use. If however nobody does use it, it would be a candidate for removal before the transaction is committed.
+</para>
+</note>
+</section>
+
+<section><title>Dead connections</title>
+<para>
+The JDBC protocol does not provide a natural <literal>connectionErrorOccured()</literal> event when a connection is broken. To support dead/broken connection checking there are a number of plugins.</para>
+
+<section><title>Valid connection checking</title>
+<para>
+The simplest format is to just run a "quick" sql statement:
+
+<screen><check-valid-connection-sql>select 1 from dual</check-valid-connection-sql></screen>
+
+before handing the connection to the application. If this fails, another connection is selected until there are no more connections at which point new connections are constructed.
+</para>
+
+<para>
+The potentially more performant check is to use vendor specific features, e.g. Oracle's or MySQL's pingDatabase() via the
+<screen><valid-connection-checker-class-name/></screen>
+</para>
+</section>
+
+<section><title>Errors during SQL queries</title>
+<para>
+You can check if a connection broke during a query by the looking the error codes or messages of the SQLException for FATAL errors rather than normal SQLExceptions. These codes/messages can be vendor specific, e.g.
+<screen><exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter</exception-sorter-class-name></screen>
+
+For
+
+<screen>FATAL</screen>
+
+errors the connection will be closed.</para>
+</section>
+
+<section><title>Changing/Closing/Flushing the pool</title>
+
+<itemizedlist>
+<listitem>
+<para><ulink url="http://www.jboss.org/wiki/HowDoIChangeThePoolingParameters">change or flush()</ulink> the pool</para>
+</listitem>
+<listitem>
+<para>closing/undeploying the pool will do a flush first</para>
+</listitem>
+</itemizedlist>
+
+</section>
+
+<section><title>Other pooling</title>
+<para><ulink url="http://www.jboss.org/wiki/IWantToPluginACustomThirdpartyDataSource">Thirdparty Pools</ulink> - only if you know what you are doing</para>
+
+</section>
+</section>
+
+
+
+
+
+</chapter>
Added: projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-7.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-7.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-8.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/javaee_chap7-8.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_connection_factories.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_connection_factories.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_local.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_local.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_xa.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_ha_xa.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_local_tx.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_local_tx.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx_connection_factory.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_no_tx_connection_factory.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_tx_connection_factory.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_tx_connection_factory.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_xa.jpg
===================================================================
(Binary files differ)
Property changes on: projects/docs/community/6/JCA_Guide/en-US/images/jboss_ds_xa.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: projects/docs/community/6/JCA_Guide/pom.xml
===================================================================
--- projects/docs/community/6/JCA_Guide/pom.xml (rev 0)
+++ projects/docs/community/6/JCA_Guide/pom.xml 2010-10-17 04:22:21 UTC (rev 108617)
@@ -0,0 +1,107 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.jboss.jbossas</groupId>
+ <artifactId>jca-guide-${translation}</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <packaging>jdocbook</packaging>
+ <name>JCA Guide (${translation})</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.1.2</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-docbook-xslt</artifactId>
+ <version>1.1.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.0.0</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <!--minmemory>1024m</minmemory>
+ <maxmemory>1024m</maxmemory -->
+ <sourceDocumentName>JCA_Guide.xml</sourceDocumentName>
+ <sourceDirectory>en-US</sourceDirectory>
+ <imageResource>
+ <directory>en-US</directory>
+ <includes>
+ <include>images/*</include>
+ </includes>
+ </imageResource>
+ <!-- <cssResource>
+ <directory>src/main/css</directory>
+ </cssResource> -->
+ <!--put back css -->
+
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <!--<stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource>-->
+ <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
+ <finalName>JCA_Guide.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <!--<stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>-->
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+
+ <format>
+ <formatName>html_single</formatName>
+ <!--<stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>-->
+ <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+
+ <!--<format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/main-eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>-->
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <!-- <xmlTransformerType>saxon</xmlTransformerType>-->
+ <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme -->
+ <!-- could also locate the docbook dependency and inspect its version... -->
+ <!--docbookVersion>1.72.0</docbookVersion -->
+ <!--
+ <docbookVersion>1.72.0</docbookVersion>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ -->
+ <!--<javax.xml.parsers.DocumentBuilderFactory>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</javax.xml.parsers.DocumentBuilderFactory>
+ <javax.xml.parsers.SAXParserFactory>org.apache.xerces.jaxp.SAXParserFactoryImpl</javax.xml.parsers.SAXParserFactory>
+ <javax.xml.validation.SchemaFactory:http\://www.w3.org/2001/XMLSchema>org.apache.xerces.jaxp.validation.XMLSchemaFactory</javax.xml.validation.SchemaFactory:http\://www.w3.org/2001/XMLSchema>-->
+ <!-- </transformerParameters> -->
+ </options>
+ </configuration>
+ </plugin>
+</plugins>
+</build>
+
+<properties>
+ <translation>en-US</translation>
+</properties>
+</project>
More information about the jboss-cvs-commits
mailing list