[jboss-cvs] JBossAS SVN: r112492 - in projects/jboss-jca/tags: IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Nov 30 10:29:38 EST 2011
Author: jesper.pedersen
Date: 2011-11-30 10:29:38 -0500 (Wed, 30 Nov 2011)
New Revision: 112492
Added:
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml
Removed:
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml
projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml
Log:
IronJacamar 1.1.0.Alpha4
Deleted: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en-US/modules/codegenerator.xml 2011-11-30 14:53:53 UTC (rev 112489)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -1,493 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="codegenerator">
- <title>Code generator</title>
-
- <section id="codegenerator_introduction">
- <title>Introduction</title>
-
- <para>The IronJacamar project includes a resource adapter code generator which can
- generate a complete code skeleton that will help developers get started with
- their development tasks.</para>
-
- </section>
-
- <section id="codegenerator_functionality">
- <title>Functionality</title>
-
- <para>The code generator will generate a resource adapter code skeleton based
- on the user input. The code generator supports</para>
-
- <itemizedlist spacing="compact">
- <listitem>
- Resource adapter using JCA 1.6 annotations
- </listitem>
- <listitem>
- Resource adapter using JCA 1.6 metadata
- </listitem>
- <listitem>
- Resource adapter using JCA 1.5
- </listitem>
- <listitem>
- Resource adapter using JCA 1.0
- </listitem>
- <listitem>
- Apache Ant build environment
- </listitem>
- <listitem>
- Apache Ant + Ivy build environment
- </listitem>
- <listitem>
- Apache Maven build environment
- </listitem>
- <listitem>
- Test suite environment
- </listitem>
- </itemizedlist>
-
- </section>
-
- <section id="codegenerator_running">
- <title>Running the tool</title>
-
- <para>The code generator can be run on the command line by</para>
-
- <programlisting>
-./codegenerator.sh
- </programlisting>
-
- <para>from the <code>doc/codegenerator</code> directory.</para>
-
- <para>The code generator supports the following arguments</para>
-
- <table frame="all">
- <title>Code generator arguments</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Argument</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>-o</code></entry>
- <entry>
- Specifies the output directory for the code skeleton.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The developer must then answer various questions regarding the
- properties of the resource adapter.</para>
-
- <section id="codegenerator_input">
- <title>Developer Input</title>
-
- <para>This section describes the questions that are ask of the developer
- in order to generate the code.</para>
-
- <table frame="all">
- <title>Developer input</title>
- <tgroup cols="4" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="1*"/>
- <colspec colname="c3" colwidth="3*"/>
- <colspec colname="c4" colwidth="1*"/>
- <thead>
- <row>
- <entry align="left">Question</entry>
- <entry align="left">Spec</entry>
- <entry align="left">Desciption</entry>
- <entry align="left">Type</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- Profile version (1.6/1.5/1.0)
- </entry>
- <entry>All</entry>
- <entry>
- Defines which Java EE Connector Architecture specification that
- the resource adapter should target
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>
- Type (O/Outbound/I/Inbound/B/Bidirectional)
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- Defines if the resource adapter should contain outbound communication., inbound communication
- or both
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>
- Transaction support (N/NoTransaction/L/LocalTransaction/X/XATransaction)
- </entry>
- <entry>All</entry>
- <entry>
- The transaction support level
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>
- Package name
- </entry>
- <entry>All</entry>
- <entry>
- The package name of the resource adapter
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>
- Use annotations (Y/Yes/N/No)
- </entry>
- <entry>JCA 1.6+</entry>
- <entry>
- Should annotations be used for specifying the structure. If 'No' is selected a <code>META-INF/ra.xml</code>
- is generated
- </entry>
- <entry></entry>
- </row>
- <row>
- <entry>
- Include a ResourceAdapter (Y/Yes/N/No)
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- Should an instance of a resource adapter class be included in the archive
- </entry>
- <entry>Outbound</entry>
- </row>
- <row>
- <entry>
- Resource adapter class name
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- The class name of the resource adapter
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Managed connection factory class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the managed connection factory
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Managed connection class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the managed connection
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Connection interface class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the connection interface
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Connection implementation class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the connection implementation
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Connection factory interface class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the connection factory interface
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Connection factory implementation class name
- </entry>
- <entry>All</entry>
- <entry>
- The class name of the connection factory implementation
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Resource adapter config properties
- </entry>
- <entry>All</entry>
- <entry>
- Include a configuration properties in the resource adapter instance
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Managed connection factory config properties
- </entry>
- <entry>All</entry>
- <entry>
- Include a configuration properties in the managed connection factory instance
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Use ResourceAdapterAssociation (Y/Yes/N/No)
- </entry>
- <entry>All</entry>
- <entry>
- Associate the managed connection factory instance with the resource adapter instance
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Use CCI (Y/Yes/N/No)
- </entry>
- <entry>All</entry>
- <entry>
- Use the Common Client Interface for the connection / connection factory in the 'Outbound' part
- of the resource adapter
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- MessageListener interface name
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- The name of the message listener interface for the activation
- </entry>
- <entry>Inbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- ActivationSpec class name
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- The class name of the activation specification instance
- </entry>
- <entry>Inbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- ActivationSpec config properties
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- Include configuration properties in the activation specification instance
- </entry>
- <entry>Inbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Activation class name
- </entry>
- <entry>JCA 1.5+</entry>
- <entry>
- The class name of the activation instance
- </entry>
- <entry>Inbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Add methods to connection interface (Y/Yes/N/No) [N]:
- </entry>
- <entry>All</entry>
- <entry>
- Use for add methods to connection interface
- </entry>
- <entry>Outbound or Bidirectional</entry>
- </row>
- <row>
- <entry>
- Build environment [A/Ant/I/Ant+Ivy/M/Maven]
- </entry>
- <entry>All</entry>
- <entry>
- Type of build environment
- </entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- </section>
-
- <section id="codegenerator_code">
- <title>Generated code</title>
-
- <para>The generated code will consist of the classes making up the resource adapter
- and a test suite environment based on the embedded distribution.</para>
-
- <section id="codegenerator_ant">
- <title>Apache Ant build environment</title>
- <para>The following targets are supported in the Apache Ant build environment</para>
-
- <table frame="all">
- <title>Apache Ant build environment</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Target</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>compile</code></entry>
- <entry>
- Compiles all the files
- </entry>
- </row>
- <row>
- <entry><code>rar</code></entry>
- <entry>
- Builds the resource adapter archive
- </entry>
- </row>
- <row>
- <entry><code>prepare-test</code></entry>
- <entry>
- Prepares the test environment
- </entry>
- </row>
- <row>
- <entry><code>test</code></entry>
- <entry>
- Executes the tests
- </entry>
- </row>
- <row>
- <entry><code>docs</code></entry>
- <entry>
- Generates the documentation
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section id="codegenerator_ant_ivy">
- <title>Apache Ant + Ivy build environment</title>
- <para>The following targets are supported in the Apache Ant + Ivy build environment</para>
-
- <table frame="all">
- <title>Apache Ant + Ivy build environment</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Target</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>compile</code></entry>
- <entry>
- Compiles all the files
- </entry>
- </row>
- <row>
- <entry><code>rar</code></entry>
- <entry>
- Builds the resource adapter archive
- </entry>
- </row>
- <row>
- <entry><code>prepare-test</code></entry>
- <entry>
- Prepares the test environment
- </entry>
- </row>
- <row>
- <entry><code>test</code></entry>
- <entry>
- Executes the tests
- </entry>
- </row>
- <row>
- <entry><code>docs</code></entry>
- <entry>
- Generates the documentation
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section id="codegenerator_maven">
- <title>Apache Maven build environment</title>
- <para>The following targets are supported in the Apache Maven build environment</para>
-
- <table frame="all">
- <title>Apache Maven build environment</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Target</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>compile</code></entry>
- <entry>
- Compiles all the files
- </entry>
- </row>
- <row>
- <entry><code>test</code></entry>
- <entry>
- Executes the tests
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- </section>
-
-</chapter>
Copied: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml (from rev 112490, projects/jboss-jca/trunk/doc/userguide/en-US/modules/codegenerator.xml)
===================================================================
--- projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml (rev 0)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/codegenerator.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -0,0 +1,493 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="codegenerator">
+ <title>Code generator</title>
+
+ <section id="codegenerator_introduction">
+ <title>Introduction</title>
+
+ <para>The IronJacamar project includes a resource adapter code generator which can
+ generate a complete code skeleton that will help developers get started with
+ their development tasks.</para>
+
+ </section>
+
+ <section id="codegenerator_functionality">
+ <title>Functionality</title>
+
+ <para>The code generator will generate a resource adapter code skeleton based
+ on the user input. The code generator supports</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Resource adapter using JCA 1.6 annotations
+ </listitem>
+ <listitem>
+ Resource adapter using JCA 1.6 metadata
+ </listitem>
+ <listitem>
+ Resource adapter using JCA 1.5
+ </listitem>
+ <listitem>
+ Resource adapter using JCA 1.0
+ </listitem>
+ <listitem>
+ Apache Ant build environment
+ </listitem>
+ <listitem>
+ Apache Ant + Ivy build environment
+ </listitem>
+ <listitem>
+ Apache Maven build environment
+ </listitem>
+ <listitem>
+ Test suite environment
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
+ <section id="codegenerator_running">
+ <title>Running the tool</title>
+
+ <para>The code generator can be run on the command line by</para>
+
+ <programlisting>
+./codegenerator.sh
+ </programlisting>
+
+ <para>from the <code>doc/codegenerator</code> directory.</para>
+
+ <para>The code generator supports the following arguments</para>
+
+ <table frame="all">
+ <title>Code generator arguments</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Argument</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>-o</code></entry>
+ <entry>
+ Specifies the output directory for the code skeleton.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The developer must then answer various questions regarding the
+ properties of the resource adapter.</para>
+
+ <section id="codegenerator_input">
+ <title>Developer Input</title>
+
+ <para>This section describes the questions that are asked
+ in order to generate the code.</para>
+
+ <table frame="all">
+ <title>Developer input</title>
+ <tgroup cols="4" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="1*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <colspec colname="c4" colwidth="1*"/>
+ <thead>
+ <row>
+ <entry align="left">Question</entry>
+ <entry align="left">Spec</entry>
+ <entry align="left">Desciption</entry>
+ <entry align="left">Type</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ Profile version (1.6/1.5/1.0)
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Defines which Java EE Connector Architecture specification that
+ the resource adapter should target
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ Type (O/Outbound/I/Inbound/B/Bidirectional)
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ Defines if the resource adapter should contain outbound communication., inbound communication
+ or both
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ Transaction support (N/NoTransaction/L/LocalTransaction/X/XATransaction)
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The transaction support level
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ Package name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The package name of the resource adapter
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ Use annotations (Y/Yes/N/No)
+ </entry>
+ <entry>JCA 1.6+</entry>
+ <entry>
+ Should annotations be used for specifying the structure. If 'No' is selected a <code>META-INF/ra.xml</code>
+ is generated
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ Include a ResourceAdapter (Y/Yes/N/No)
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ Should an instance of a resource adapter class be included in the archive
+ </entry>
+ <entry>Outbound</entry>
+ </row>
+ <row>
+ <entry>
+ Resource adapter class name
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ The class name of the resource adapter
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Managed connection factory class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the managed connection factory
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Managed connection class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the managed connection
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Connection interface class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the connection interface
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Connection implementation class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the connection implementation
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Connection factory interface class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the connection factory interface
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Connection factory implementation class name
+ </entry>
+ <entry>All</entry>
+ <entry>
+ The class name of the connection factory implementation
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Resource adapter config properties
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Include a configuration properties in the resource adapter instance
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Managed connection factory config properties
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Include a configuration properties in the managed connection factory instance
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Use ResourceAdapterAssociation (Y/Yes/N/No)
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Associate the managed connection factory instance with the resource adapter instance
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Use CCI (Y/Yes/N/No)
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Use the Common Client Interface for the connection / connection factory in the 'Outbound' part
+ of the resource adapter
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ MessageListener interface name
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ The name of the message listener interface for the activation
+ </entry>
+ <entry>Inbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ ActivationSpec class name
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ The class name of the activation specification instance
+ </entry>
+ <entry>Inbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ ActivationSpec config properties
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ Include configuration properties in the activation specification instance
+ </entry>
+ <entry>Inbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Activation class name
+ </entry>
+ <entry>JCA 1.5+</entry>
+ <entry>
+ The class name of the activation instance
+ </entry>
+ <entry>Inbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Add methods to connection interface (Y/Yes/N/No) [N]:
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Use for add methods to connection interface
+ </entry>
+ <entry>Outbound or Bidirectional</entry>
+ </row>
+ <row>
+ <entry>
+ Build environment [A/Ant/I/Ant+Ivy/M/Maven]
+ </entry>
+ <entry>All</entry>
+ <entry>
+ Type of build environment
+ </entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ </section>
+
+ <section id="codegenerator_code">
+ <title>Generated code</title>
+
+ <para>The generated code will consist of the classes making up the resource adapter
+ and a test suite environment based on the embedded distribution.</para>
+
+ <section id="codegenerator_ant">
+ <title>Apache Ant build environment</title>
+ <para>The following targets are supported in the Apache Ant build environment</para>
+
+ <table frame="all">
+ <title>Apache Ant build environment</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Target</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>compile</code></entry>
+ <entry>
+ Compiles all the files
+ </entry>
+ </row>
+ <row>
+ <entry><code>rar</code></entry>
+ <entry>
+ Builds the resource adapter archive
+ </entry>
+ </row>
+ <row>
+ <entry><code>prepare-test</code></entry>
+ <entry>
+ Prepares the test environment
+ </entry>
+ </row>
+ <row>
+ <entry><code>test</code></entry>
+ <entry>
+ Executes the tests
+ </entry>
+ </row>
+ <row>
+ <entry><code>docs</code></entry>
+ <entry>
+ Generates the documentation
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="codegenerator_ant_ivy">
+ <title>Apache Ant + Ivy build environment</title>
+ <para>The following targets are supported in the Apache Ant + Ivy build environment</para>
+
+ <table frame="all">
+ <title>Apache Ant + Ivy build environment</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Target</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>compile</code></entry>
+ <entry>
+ Compiles all the files
+ </entry>
+ </row>
+ <row>
+ <entry><code>rar</code></entry>
+ <entry>
+ Builds the resource adapter archive
+ </entry>
+ </row>
+ <row>
+ <entry><code>prepare-test</code></entry>
+ <entry>
+ Prepares the test environment
+ </entry>
+ </row>
+ <row>
+ <entry><code>test</code></entry>
+ <entry>
+ Executes the tests
+ </entry>
+ </row>
+ <row>
+ <entry><code>docs</code></entry>
+ <entry>
+ Generates the documentation
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="codegenerator_maven">
+ <title>Apache Maven build environment</title>
+ <para>The following targets are supported in the Apache Maven build environment</para>
+
+ <table frame="all">
+ <title>Apache Maven build environment</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Target</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>compile</code></entry>
+ <entry>
+ Compiles all the files
+ </entry>
+ </row>
+ <row>
+ <entry><code>test</code></entry>
+ <entry>
+ Executes the tests
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+
+</chapter>
Deleted: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en-US/modules/configuration.xml 2011-11-30 14:53:53 UTC (rev 112489)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -1,641 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="configuration">
- <title>Configuration</title>
-
- <para>The configuration for the IronJacamar container is located in the config/ directory.</para>
-
- <section id="logging">
- <title>Logging service</title>
-
- <para>The IronJacamar container uses JBoss Logging framework as the implementation.</para>
-
- <para>The configuration is done in the</para>
-
- <programlisting>
-config/logging.properties
- </programlisting>
-
- <para>file.</para>
-
- <para>Consult the <ulink url="http://www.jboss.org/community/wiki/JBossBootLogging">
- JBoss Logging documentation</ulink> on how the service can be configured.</para>
-
- </section>
-
- <section id="transaction">
- <title>Transaction service</title>
-
- <para>The IronJacamar container uses the JBoss Transaction Manager as its transaction implementation.</para>
-
- <para>The configuration is done in the</para>
-
- <programlisting>
-config/transaction.xml
- </programlisting>
-
- <para>file.</para>
-
- <para>Consult the JBoss Transaction documentation on how the service can be configured.</para>
-
- </section>
-
- <section id="jca">
- <title>JCA</title>
-
- <section id="jca_deployer">
- <title>Deployer</title>
-
- <para>The IronJacamar deployer is configured in the</para>
-
- <programlisting>
-config/bootstrap/jca.xml
- </programlisting>
-
- <para>file.</para>
-
- <section id="jca_deployer_configuration">
- <title>Configuration</title>
-
- <para>The configuration of the resource adapter deployer chain is handled
- by a <code>org.jboss.jca.deployers.fungal.RAConfiguration</code> bean.</para>
-
- <programlisting language="xml">
-<![CDATA[
-<bean name="RAConfiguration"
- class="org.jboss.jca.deployers.fungal.RAConfiguration">
- <property name="ArchiveValidation">true</property>
- <property name="ArchiveValidationFailOnWarn">false</property>
- <property name="ArchiveValidationFailOnError">true</property>
- <property name="BeanValidation">true</property>
- <property name="PrintStream">
- <inject bean="JBossStdioContext" property="Out"/>
- </property>
- <property name="DefaultBootstrapContext">
- <inject bean="DefaultBootstrapContext"/>
- </property>
- <property name="JndiStrategy"><inject bean="JndiStrategy"/></property>
- <property name="TransactionManager">
- <inject bean="RealTransactionManager"/>
- </property>
- <property name="MetadataRepository"><inject bean="MDR"/></property>
-</bean>
- ]]>
- </programlisting>
-
-
- <table frame="all">
- <title>Resource adapter deployer configuration</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>ArchiveValidation</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Toggle archive validation for the deployment units.
- <para>Default: <code>true</code></para>
- </entry>
- </row>
- <row>
- <entry><code>ArchiveValidation​FailOnWarn</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Should an archive validation warning report fail the deployment.
- <para>Default: <code>false</code></para>
- </entry>
- </row>
- <row>
- <entry><code>ArchiveValidation​FailOnError</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Should an archive validation error report fail the deployment.
- <para>Default: <code>true</code></para>
- </entry>
- </row>
- <row>
- <entry><code>BeanValidation</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Toggle bean validation (JSR-303) for the deployment units.
- <para>Default: <code>true</code></para>
- </entry>
- </row>
- <row>
- <entry><code>DefaultBootstrap​Context</code></entry>
- <entry><code>org.jboss.jca.​core.api.bootstrap.​CloneableBootstrap​Context</code></entry>
- <entry>
- Specifies the default bootstrap context for resource adapters
- </entry>
- </row>
- <row>
- <entry><code>BootstrapContexts</code></entry>
- <entry><code>Map<String, ​org.jboss.jca.​core.api.bootstrap.​CloneableBootstrap​Context></code></entry>
- <entry>
- Bootstrap context map (unique name to a cloneable bootstrap context) which allows
- developers to bind (through <code>jboss-ra.xml</code>) their resource adapter to
- a specific bootstrap context instance.
- </entry>
- </row>
- <row>
- <entry><code>PrintStream</code></entry>
- <entry><code>java.io.PrintStream</code></entry>
- <entry>
- Specifies which print stream that should be used to handle the <code>LogWriter</code>s
- </entry>
- </row>
- <row>
- <entry><code>MetadataRepository</code></entry>
- <entry><code>org.jboss.jca.​core.spi.mdr.​MetadataRepository</code></entry>
- <entry>
- The metadata repository
- </entry>
- </row>
- <row>
- <entry><code>ResourceAdapterRepository</code></entry>
- <entry><code>org.jboss.jca.​core.spi.rar.​ResourceAdapterRepository</code></entry>
- <entry>
- The metadata repository
- </entry>
- </row>
- <row>
- <entry><code>ScopeDeployment</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Should each deployment be scoped (isolated) from the container. This feature allows
- deployment of libraries of a different version than used in the container environment.
- <para>Default: <code>false</code></para>
- </entry>
- </row>
- <row>
- <entry><code>JndiStrategy</code></entry>
- <entry><code>org.jboss.jca.​core.spi.naming.​JndiStrategy</code></entry>
- <entry>
- Specifies the JNDI strategy policy for binding the connection factories into
- the naming environment
-
- <para>The JNDI strategies are located in the <code>org.jboss.jca.core.naming</code>
- package</para>
- <itemizedlist spacing="compact">
- <listitem>
- <code>NoopJndiStrategy</code>: A no operation JNDI strategy
- which doesn't bind/unbind any objects
- </listitem>
- <listitem>
- <code>SimpleJndiStrategy</code>: A simple JNDI strategy
- which can bind/unbind a single connection factory
- </listitem>
- <listitem>
- <code>ExplicitJndiStrategy</code>: A JNDI strategy
- which can requires explicit JNDI names to bind/unbind a connection factory
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- <section id="jca_deployer_radeployer">
- <title>Resource adapter deployer</title>
-
- <para>The initial deployer for resource adapter archives is handled
- by a <code>org.jboss.jca.deployers.fungal.RADeployer</code> bean.</para>
-
- <programlisting language="xml">
-<![CDATA[
-<bean name="RADeployer"
- interface="com.github.fungal.spi.deployers.Deployer"
- class="org.jboss.jca.deployers.fungal.RADeployer">
- <property name="Configuration"><inject bean="RAConfiguration"/></property>
- <depends>BeanValidation</depends>
- <depends>JBossStdioContextSelector</depends>
-</bean>
- ]]>
- </programlisting>
-
- <para>This deployer will register the resource adapters with the metadata repository in
- the system.</para>
-
-
- <table frame="all">
- <title>Resource adapter deployer</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>Configuration</code></entry>
- <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
- <entry>
- The configuration for the deployer
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- <section id="jca_deployer_raxmldeployer">
- <title>Resource adapter metadata deployer</title>
-
- <para>The deployer for deploying our <code>-ra.xml</code> deployment descriptor is handled
- by a <code>org.jboss.jca.deployers.fungal.RaXmlDeployer</code> bean.</para>
-
- <para>The deployment descriptor is defined by the <code>resource-adapters-1_0.xsd</code> schema.</para>
-
- <programlisting language="xml">
-<![CDATA[
-<bean name="RaXmlDeployer"
- interface="com.github.fungal.spi.deployers.Deployer"
- class="org.jboss.jca.deployers.fungal.RaXmlDeployer">
- <property name="Configuration"><inject bean="DeployerConfiguration"/></property>
- <property name="Kernel"><inject bean="Kernel"/></property>
- <depends>BeanValidation</depends>
- <depends>JBossStdioContextSelector</depends>
-</bean>
- ]]>
- </programlisting>
-
- <para>This deployer will activate resource adapters based on the deployment information.</para>
-
-
- <table frame="all">
- <title>Resource adapter metadata deployer</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>Configuration</code></entry>
- <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
- <entry>
- The configuration for the deployer
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- <section id="jca_deployer_raactivator">
- <title>Resource adapter activator</title>
-
- <para>The deployer chain features an activator for resource adapter archives is handled
- by the <code>org.jboss.jca.deployers.fungal.RAActivator</code> bean.</para>
-
- <programlisting language="xml">
-<![CDATA[
-<bean name="RAActivator"
- class="org.jboss.jca.deployers.fungal.RAActivator">
- <property name="Configuration"><inject bean="RAConfiguration"/></property>
- <property name="Kernel"><inject bean="Kernel"/></property>
- <property name="ExcludeArchives">
- <set elementClass="java.lang.String">
- <value>jdbc-local.rar</value>
- <value>jdbc-xa.rar</value>
- </set>
- </property>
- <depends>BeanValidation</depends>
- <depends>JBossStdioContextSelector</depends>
-</bean>
- ]]>
- </programlisting>
-
- <para>This activator will activate any resource adapters which hasn't been activated yet
- unless they are in the excluded list.</para>
-
-
- <table frame="all">
- <title>Resource adapter activator</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>Configuration</code></entry>
- <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
- <entry>
- The configuration for the deployer
- </entry>
- </row>
- <row>
- <entry><code>Enabled</code></entry>
- <entry><code>boolean</code></entry>
- <entry>
- Should the activator be enabled. Default is <code>true</code>
- </entry>
- </row>
- <row>
- <entry><code>Kernel</code></entry>
- <entry><code>com.github.fungal.​api.Kernel</code></entry>
- <entry>
- The kernel instance
- </entry>
- </row>
- <row>
- <entry><code>ExcludeArchives</code></entry>
- <entry><code>java.util.Set</code></entry>
- <entry>
- A set of resource adapter archives which should be excluded
- from activation
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- </section>
-
- <section id="jca_security">
- <title>Security</title>
-
- <para>The Java EE Connector Architecture 1.6 specification allows units of
- <code>javax.resource.spi.Work</code> to be executed in a specific security context.</para>
-
- <para>This is done through the use of Java Authentication Service Provider Interface for Containers (JSR-196)
- call backs using the <code>javax.security.auth.callback.Callback</code> interface.</para>
-
- <para>The support is activated by letting the work instance implement the</para>
-
- <programlisting>
-javax.resource.spi.work.WorkContextProvider
- </programlisting>
-
- <para>interface and returning an instance of <code>javax.resource.spi.work.SecurityContext</code>.</para>
-
- <para>There is currently support for injecting a user/roles setup based on the files</para>
-
- <programlisting>
-config/users.properties
-config/roles.properties
- </programlisting>
-
- <para>The format of the <code>users.properties</code> file is</para>
-
- <programlisting>
-username1=password1
-username2=password2
- </programlisting>
-
- <para>The format of the <code>roles.properties</code> file is</para>
-
- <programlisting>
-username1=role1,role2
-username2=role3,role4
- </programlisting>
-
- <para>The user/roles setup can be configured through the <code>UsersRoles</code> bean in the
- <code>config/bootstrap/jca.xml</code> file.</para>
-
- <programlisting language="xml">
- <![CDATA[
-<!-- Users / roles -->
-<bean name="UsersRoles"
- interface="org.jboss.jca.core.spi.security.Callback"
- class="org.jboss.jca.core.security.UsersRoles">
- <property name="UsersProperties">${iron.jacamar.home}/config/users.properties</property>
- <property name="RolesProperties">${iron.jacamar.home}/config/roles.properties</property>
-</bean>
- ]]>
- </programlisting>
-
- <para>There is support for creating a basic security domain which can provide
- a <code>javax.security.auth.Subject</code> instance to deployments that
- are using <code><security-domain></code> or
- <code><security-domain-and-application></code> in their setup.</para>
-
- <para>A security domain can be configured through</para>
-
- <programlisting language="xml">
- <![CDATA[
-<!-- SubjectFactory -->
-<bean name="DefaultSecurityDomain"
- interface="org.jboss.security.SubjectFactory"
- class="org.jboss.jca.core.security.DefaultSubjectFactory">
- <property name="SecurityDomain">DefaultSecurityDomain</property>
- <property name="UserName">user</property>
- <property name="Password">password</property>
-</bean>
- ]]>
- </programlisting>
-
- <para>beans.</para>
-
- </section>
-
- </section>
-
- <section id="datasources">
- <title>Datasources</title>
-
- <para>The IronJacamar project can deploy datasources using the <code>datasources-1_0.xsd</code> schema.</para>
-
- <para>The configuration is done in the</para>
-
- <programlisting>
-config/bootstrap/ds.xml
- </programlisting>
-
- <para>file.</para>
-
- <table frame="all">
- <title>DsXmlDeployer</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>JDBCLocal</code></entry>
- <entry><code>String</code></entry>
- <entry>
- The name of the <code>jdbc-local.rar</code> deployment
- </entry>
- </row>
- <row>
- <entry><code>JDBCXA</code></entry>
- <entry><code>String</code></entry>
- <entry>
- The name of the <code>jdbc-xa.rar</code> deployment
- </entry>
- </row>
- <row>
- <entry><code>TransactionManager</code></entry>
- <entry><code>javax.transaction.​TransactionManager</code></entry>
- <entry>
- The transaction manager
- </entry>
- </row>
- <row>
- <entry><code>MetadataRepository</code></entry>
- <entry><code>org.jboss.jca.​core.spi.mdr.​MetadataRepository</code></entry>
- <entry>
- The metadata repository
- </entry>
- </row>
- <row>
- <entry><code>Kernel</code></entry>
- <entry><code>com.github.fungal.​api.Kernel</code></entry>
- <entry>
- The kernel
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The datasource deployer can be removed from the environment by removing the <code>ds.xml</code>
- file in</para>
-
- <programlisting>
-config/bootstrap/
- </programlisting>
-
- <para>as well as the reference in <code>config/bootstrap/bootstrap.xml</code> to the file.</para>
-
- <para>Furthermore all <code>jdbc-*.rar</code> files in the <code>system/</code> directory should be removed too.</para>
-
- </section>
-
- <section id="webserver">
- <title>Web server</title>
-
- <para>The IronJacamar project features a web server which is used to serve web archive deployments.
- More information about Jetty can be found at the <ulink url="http://www.eclipse.org/jetty/">
- homepage</ulink>.
- </para>
-
- <para>The configuration is done in the</para>
-
- <programlisting>
-system/web.xml
- </programlisting>
-
- <para>file.</para>
-
- <programlisting language="xml">
-<![CDATA[
-<bean name="WebServer" class="org.jboss.jca.web.WebServer">
- <property name="Host">${iron.jacamar.bindaddress:localhost}</property>
- <property name="Port">8080</property>
- <property name="ExecutorService"><inject bean="Kernel" property="ExecutorService"/></property>
-</bean>
-]]>
- </programlisting>
-
- <table frame="all">
- <title>Web server</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="2*"/>
- <colspec colname="c3" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Property</entry>
- <entry align="left">Type</entry>
- <entry align="left">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>Host</code></entry>
- <entry><code>String</code></entry>
- <entry>
- Set the bind address for the web server
- <para>Default: <code>localhost</code></para>
- </entry>
- </row>
- <row>
- <entry><code>Port</code></entry>
- <entry><code>int</code></entry>
- <entry>
- Set the port for the web server
- <para>Default: <code>8080</code></para>
- </entry>
- </row>
- <row>
- <entry><code>AcceptQueueSize</code></entry>
- <entry><code>int</code></entry>
- <entry>
- Set the accept queue size for the Jetty connector
- <para>Default: <code>64</code></para>
- </entry>
- </row>
- <row>
- <entry><code>ExecutorService</code></entry>
- <entry><code>java.util.concurrent.​ExecutorService</code></entry>
- <entry>
- The thread pool for the web server
- <para>Default: The kernel thread pool</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The web server can be removed from the environment by removing the <code>web.xml</code>
- file in</para>
-
- <programlisting>
-system/
- </programlisting>
-
- <para>Furthermore all <code>.war</code> files in the same directory should be removed too.</para>
-
- <para>All the Jetty libraries can be removed by deleting the</para>
-
- <programlisting>
-lib/jetty
- </programlisting>
-
- <para>directory.</para>
-
- </section>
-
-</chapter>
Copied: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml (from rev 112490, projects/jboss-jca/trunk/doc/userguide/en-US/modules/configuration.xml)
===================================================================
--- projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml (rev 0)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/configuration.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -0,0 +1,641 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="configuration">
+ <title>Configuration</title>
+
+ <para>The configuration for the IronJacamar container is located in the config/ directory.</para>
+
+ <section id="logging">
+ <title>Logging service</title>
+
+ <para>The IronJacamar container uses JBoss Logging framework as the implementation.</para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+config/logging.properties
+ </programlisting>
+
+ <para>file.</para>
+
+ <para>Consult the <ulink url="http://www.jboss.org/community/wiki/JBossBootLogging">
+ JBoss Logging documentation</ulink> on how the service can be configured.</para>
+
+ </section>
+
+ <section id="transaction">
+ <title>Transaction service</title>
+
+ <para>The IronJacamar container uses the JBoss Transaction Manager as its transaction implementation.</para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+config/transaction.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <para>Consult the JBoss Transaction documentation on how the service can be configured.</para>
+
+ </section>
+
+ <section id="jca">
+ <title>JCA</title>
+
+ <section id="jca_deployer">
+ <title>Deployer</title>
+
+ <para>The IronJacamar deployer is configured in the</para>
+
+ <programlisting>
+config/bootstrap/jca.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <section id="jca_deployer_configuration">
+ <title>Configuration</title>
+
+ <para>The configuration of the resource adapter deployer chain is handled
+ by a <code>org.jboss.jca.deployers.fungal.RAConfiguration</code> bean.</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<bean name="RAConfiguration"
+ class="org.jboss.jca.deployers.fungal.RAConfiguration">
+ <property name="ArchiveValidation">true</property>
+ <property name="ArchiveValidationFailOnWarn">false</property>
+ <property name="ArchiveValidationFailOnError">true</property>
+ <property name="BeanValidation">true</property>
+ <property name="PrintStream">
+ <inject bean="JBossStdioContext" property="Out"/>
+ </property>
+ <property name="DefaultBootstrapContext">
+ <inject bean="DefaultBootstrapContext"/>
+ </property>
+ <property name="JndiStrategy"><inject bean="JndiStrategy"/></property>
+ <property name="TransactionManager">
+ <inject bean="RealTransactionManager"/>
+ </property>
+ <property name="MetadataRepository"><inject bean="MDR"/></property>
+</bean>
+ ]]>
+ </programlisting>
+
+
+ <table frame="all">
+ <title>Resource adapter deployer configuration</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>ArchiveValidation</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Toggle archive validation for the deployment units.
+ <para>Default: <code>true</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>ArchiveValidation​FailOnWarn</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Should an archive validation warning report fail the deployment.
+ <para>Default: <code>false</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>ArchiveValidation​FailOnError</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Should an archive validation error report fail the deployment.
+ <para>Default: <code>true</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>BeanValidation</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Toggle bean validation (JSR-303) for the deployment units.
+ <para>Default: <code>true</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>DefaultBootstrap​Context</code></entry>
+ <entry><code>org.jboss.jca.​core.api.bootstrap.​CloneableBootstrap​Context</code></entry>
+ <entry>
+ Specifies the default bootstrap context for resource adapters
+ </entry>
+ </row>
+ <row>
+ <entry><code>BootstrapContexts</code></entry>
+ <entry><code>Map<String, ​org.jboss.jca.​core.api.bootstrap.​CloneableBootstrap​Context></code></entry>
+ <entry>
+ Bootstrap context map (unique name to a cloneable bootstrap context) which allows
+ developers to bind (through <code>jboss-ra.xml</code>) their resource adapter to
+ a specific bootstrap context instance.
+ </entry>
+ </row>
+ <row>
+ <entry><code>PrintStream</code></entry>
+ <entry><code>java.io.PrintStream</code></entry>
+ <entry>
+ Specifies which print stream that should be used to handle the <code>LogWriter</code>s
+ </entry>
+ </row>
+ <row>
+ <entry><code>MetadataRepository</code></entry>
+ <entry><code>org.jboss.jca.​core.spi.mdr.​MetadataRepository</code></entry>
+ <entry>
+ The metadata repository
+ </entry>
+ </row>
+ <row>
+ <entry><code>ResourceAdapterRepository</code></entry>
+ <entry><code>org.jboss.jca.​core.spi.rar.​ResourceAdapterRepository</code></entry>
+ <entry>
+ The resource adapter repository
+ </entry>
+ </row>
+ <row>
+ <entry><code>ScopeDeployment</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Should each deployment be scoped (isolated) from the container. This feature allows
+ deployment of libraries of a different version than used in the container environment.
+ <para>Default: <code>false</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>JndiStrategy</code></entry>
+ <entry><code>org.jboss.jca.​core.spi.naming.​JndiStrategy</code></entry>
+ <entry>
+ Specifies the JNDI strategy policy for binding the connection factories into
+ the naming environment
+
+ <para>The JNDI strategies are located in the <code>org.jboss.jca.core.naming</code>
+ package</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>NoopJndiStrategy</code>: A no operation JNDI strategy
+ which doesn't bind/unbind any objects
+ </listitem>
+ <listitem>
+ <code>SimpleJndiStrategy</code>: A simple JNDI strategy
+ which can bind/unbind a single connection factory
+ </listitem>
+ <listitem>
+ <code>ExplicitJndiStrategy</code>: A JNDI strategy
+ which can requires explicit JNDI names to bind/unbind a connection factory
+ </listitem>
+ </itemizedlist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section id="jca_deployer_radeployer">
+ <title>Resource adapter deployer</title>
+
+ <para>The initial deployer for resource adapter archives is handled
+ by a <code>org.jboss.jca.deployers.fungal.RADeployer</code> bean.</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<bean name="RADeployer"
+ interface="com.github.fungal.spi.deployers.Deployer"
+ class="org.jboss.jca.deployers.fungal.RADeployer">
+ <property name="Configuration"><inject bean="RAConfiguration"/></property>
+ <depends>BeanValidation</depends>
+ <depends>JBossStdioContextSelector</depends>
+</bean>
+ ]]>
+ </programlisting>
+
+ <para>This deployer will register the resource adapters with the metadata repository in
+ the system.</para>
+
+
+ <table frame="all">
+ <title>Resource adapter deployer</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>Configuration</code></entry>
+ <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
+ <entry>
+ The configuration for the deployer
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section id="jca_deployer_raxmldeployer">
+ <title>Resource adapter metadata deployer</title>
+
+ <para>The deployer for deploying our <code>-ra.xml</code> deployment descriptor is handled
+ by a <code>org.jboss.jca.deployers.fungal.RaXmlDeployer</code> bean.</para>
+
+ <para>The deployment descriptor is defined by the <code>resource-adapters-1_0.xsd</code> schema.</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<bean name="RaXmlDeployer"
+ interface="com.github.fungal.spi.deployers.Deployer"
+ class="org.jboss.jca.deployers.fungal.RaXmlDeployer">
+ <property name="Configuration"><inject bean="DeployerConfiguration"/></property>
+ <property name="Kernel"><inject bean="Kernel"/></property>
+ <depends>BeanValidation</depends>
+ <depends>JBossStdioContextSelector</depends>
+</bean>
+ ]]>
+ </programlisting>
+
+ <para>This deployer will activate resource adapters based on the deployment information.</para>
+
+
+ <table frame="all">
+ <title>Resource adapter metadata deployer</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>Configuration</code></entry>
+ <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
+ <entry>
+ The configuration for the deployer
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section id="jca_deployer_raactivator">
+ <title>Resource adapter activator</title>
+
+ <para>The deployer chain features an activator for resource adapter archives is handled
+ by the <code>org.jboss.jca.deployers.fungal.RAActivator</code> bean.</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<bean name="RAActivator"
+ class="org.jboss.jca.deployers.fungal.RAActivator">
+ <property name="Configuration"><inject bean="RAConfiguration"/></property>
+ <property name="Kernel"><inject bean="Kernel"/></property>
+ <property name="ExcludeArchives">
+ <set elementClass="java.lang.String">
+ <value>jdbc-local.rar</value>
+ <value>jdbc-xa.rar</value>
+ </set>
+ </property>
+ <depends>BeanValidation</depends>
+ <depends>JBossStdioContextSelector</depends>
+</bean>
+ ]]>
+ </programlisting>
+
+ <para>This activator will activate any resource adapters which hasn't been activated yet
+ unless they are in the excluded list.</para>
+
+
+ <table frame="all">
+ <title>Resource adapter activator</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>Configuration</code></entry>
+ <entry><code>org.jboss.jca.​deployers.fungal.​RAConfiguration</code></entry>
+ <entry>
+ The configuration for the deployer
+ </entry>
+ </row>
+ <row>
+ <entry><code>Enabled</code></entry>
+ <entry><code>boolean</code></entry>
+ <entry>
+ Should the activator be enabled. Default is <code>true</code>
+ </entry>
+ </row>
+ <row>
+ <entry><code>Kernel</code></entry>
+ <entry><code>com.github.fungal.​api.Kernel</code></entry>
+ <entry>
+ The kernel instance
+ </entry>
+ </row>
+ <row>
+ <entry><code>ExcludeArchives</code></entry>
+ <entry><code>java.util.Set</code></entry>
+ <entry>
+ A set of resource adapter archives which should be excluded
+ from activation
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ </section>
+
+ <section id="jca_security">
+ <title>Security</title>
+
+ <para>The Java EE Connector Architecture 1.6 specification allows units of
+ <code>javax.resource.spi.Work</code> to be executed in a specific security context.</para>
+
+ <para>This is done through the use of Java Authentication Service Provider Interface for Containers (JSR-196)
+ call backs using the <code>javax.security.auth.callback.Callback</code> interface.</para>
+
+ <para>The support is activated by letting the work instance implement the</para>
+
+ <programlisting>
+javax.resource.spi.work.WorkContextProvider
+ </programlisting>
+
+ <para>interface and returning an instance of <code>javax.resource.spi.work.SecurityContext</code>.</para>
+
+ <para>There is currently support for injecting a user/roles setup based on the files</para>
+
+ <programlisting>
+config/users.properties
+config/roles.properties
+ </programlisting>
+
+ <para>The format of the <code>users.properties</code> file is</para>
+
+ <programlisting>
+username1=password1
+username2=password2
+ </programlisting>
+
+ <para>The format of the <code>roles.properties</code> file is</para>
+
+ <programlisting>
+username1=role1,role2
+username2=role3,role4
+ </programlisting>
+
+ <para>The user/roles setup can be configured through the <code>UsersRoles</code> bean in the
+ <code>config/bootstrap/jca.xml</code> file.</para>
+
+ <programlisting language="xml">
+ <![CDATA[
+<!-- Users / roles -->
+<bean name="UsersRoles"
+ interface="org.jboss.jca.core.spi.security.Callback"
+ class="org.jboss.jca.core.security.UsersRoles">
+ <property name="UsersProperties">${iron.jacamar.home}/config/users.properties</property>
+ <property name="RolesProperties">${iron.jacamar.home}/config/roles.properties</property>
+</bean>
+ ]]>
+ </programlisting>
+
+ <para>There is support for creating a basic security domain which can provide
+ a <code>javax.security.auth.Subject</code> instance to deployments that
+ are using <code><security-domain></code> or
+ <code><security-domain-and-application></code> in their setup.</para>
+
+ <para>A security domain can be configured through</para>
+
+ <programlisting language="xml">
+ <![CDATA[
+<!-- SubjectFactory -->
+<bean name="DefaultSecurityDomain"
+ interface="org.jboss.security.SubjectFactory"
+ class="org.jboss.jca.core.security.DefaultSubjectFactory">
+ <property name="SecurityDomain">DefaultSecurityDomain</property>
+ <property name="UserName">user</property>
+ <property name="Password">password</property>
+</bean>
+ ]]>
+ </programlisting>
+
+ <para>beans.</para>
+
+ </section>
+
+ </section>
+
+ <section id="datasources">
+ <title>Datasources</title>
+
+ <para>The IronJacamar project can deploy datasources using the <code>datasources-1_0.xsd</code> schema.</para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+config/bootstrap/ds.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <table frame="all">
+ <title>DsXmlDeployer</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>JDBCLocal</code></entry>
+ <entry><code>String</code></entry>
+ <entry>
+ The name of the <code>jdbc-local.rar</code> deployment
+ </entry>
+ </row>
+ <row>
+ <entry><code>JDBCXA</code></entry>
+ <entry><code>String</code></entry>
+ <entry>
+ The name of the <code>jdbc-xa.rar</code> deployment
+ </entry>
+ </row>
+ <row>
+ <entry><code>TransactionManager</code></entry>
+ <entry><code>javax.transaction.​TransactionManager</code></entry>
+ <entry>
+ The transaction manager
+ </entry>
+ </row>
+ <row>
+ <entry><code>MetadataRepository</code></entry>
+ <entry><code>org.jboss.jca.​core.spi.mdr.​MetadataRepository</code></entry>
+ <entry>
+ The metadata repository
+ </entry>
+ </row>
+ <row>
+ <entry><code>Kernel</code></entry>
+ <entry><code>com.github.fungal.​api.Kernel</code></entry>
+ <entry>
+ The kernel
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The datasource deployer can be removed from the environment by removing the <code>ds.xml</code>
+ file in</para>
+
+ <programlisting>
+config/bootstrap/
+ </programlisting>
+
+ <para>as well as the reference in <code>config/bootstrap/bootstrap.xml</code> to the file.</para>
+
+ <para>Furthermore all <code>jdbc-*.rar</code> files in the <code>system/</code> directory should be removed too.</para>
+
+ </section>
+
+ <section id="webserver">
+ <title>Web server</title>
+
+ <para>The IronJacamar project features a web server which is used to serve web archive deployments.
+ More information about Jetty can be found at the <ulink url="http://www.eclipse.org/jetty/">
+ homepage</ulink>.
+ </para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+system/web.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<bean name="WebServer" class="org.jboss.jca.web.WebServer">
+ <property name="Host">${iron.jacamar.bindaddress:localhost}</property>
+ <property name="Port">8080</property>
+ <property name="ExecutorService"><inject bean="Kernel" property="ExecutorService"/></property>
+</bean>
+]]>
+ </programlisting>
+
+ <table frame="all">
+ <title>Web server</title>
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="2*"/>
+ <colspec colname="c3" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Property</entry>
+ <entry align="left">Type</entry>
+ <entry align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>Host</code></entry>
+ <entry><code>String</code></entry>
+ <entry>
+ Set the bind address for the web server
+ <para>Default: <code>localhost</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>Port</code></entry>
+ <entry><code>int</code></entry>
+ <entry>
+ Set the port for the web server
+ <para>Default: <code>8080</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>AcceptQueueSize</code></entry>
+ <entry><code>int</code></entry>
+ <entry>
+ Set the accept queue size for the Jetty connector
+ <para>Default: <code>64</code></para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>ExecutorService</code></entry>
+ <entry><code>java.util.concurrent.​ExecutorService</code></entry>
+ <entry>
+ The thread pool for the web server
+ <para>Default: The kernel thread pool</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The web server can be removed from the environment by removing the <code>web.xml</code>
+ file in</para>
+
+ <programlisting>
+system/
+ </programlisting>
+
+ <para>Furthermore all <code>.war</code> files in the same directory should be removed too.</para>
+
+ <para>All the Jetty libraries can be removed by deleting the</para>
+
+ <programlisting>
+lib/jetty
+ </programlisting>
+
+ <para>directory.</para>
+
+ </section>
+
+</chapter>
Deleted: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en-US/modules/deployment.xml 2011-11-30 14:53:53 UTC (rev 112489)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -1,1722 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="deployment">
- <title>Deployment</title>
-
- <para>The IronJacamar distribution contains a deploy/ directory where all deployments
- should be deployed to.</para>
-
- <section id="packagingrequirements">
- <title>Packaging requirements</title>
-
- <para>A resource adapter archive is a structured Java Archive (JAR) file, which
- bundles all Java classes in JAR files, and optionally contains metadata, resources and native
- libraries.</para>
-
- <para>A resource adapter archive name ends in the <code>.rar</code> extension.</para>
-
- <para>An example of a resource adapter archive could look like</para>
-
- <programlisting>
-<![CDATA[
-[jpederse at localhost]$ jar tf ra.rar
-META-INF/ra.xml
-readme.html
-ra.jar
-images/icon.jpg
-win.dll
-linux.so
- ]]>
- </programlisting>
-
- <para>See the Java EE Connector Architecture 1.6 specification chapter 20 for further
- requirements.</para>
-
- </section>
-
- <section id="deployingrar">
- <title>Deploying resource adapters</title>
-
- <para>Resource adapters (.rar) are deployed by copying the resource adapter into the
- <code>deploy/</code> directory</para>
-
- <programlisting>
-cp example.rar ironjacamar-1.0.0.Final/deploy
- </programlisting>
-
- <para>on a Un*x based system or</para>
-
- <programlisting>
-copy example.rar ironjacamar-1.0.0.Final\deploy
- </programlisting>
-
- <para>on Windows.</para>
-
- <para>The resource adapter can configured and activated through a <code>META-INF/ironjacamar.xml</code>
- file in the archive. The format of the XML document is defined by the <code>ironjacamar_1_0.xsd</code>.</para>
-
- <para>A resource adapter can also be configured and activated through deployment of a <code>-ra.xml</code>
- file in the <code>deploy/</code> directory - f.ex. <code>deploy/example-ra.xml</code>. The format of the XML
- document is defined by the <code>resource-adapters_1_0.xsd</code> - f.ex</para>
-
- <programlisting language="xml">
-<![CDATA[
-<resource-adapters>
- <resource-adapter>
- <archive>example.rar</archive>
- <connection-definitions>
- <connection-definition jndi-name="java:/eis/example" class-name="com.example.ra.MCF"/>
- </connection-definitions>
- </resource-adapter>
-</resource-adapters>
-]]>
- </programlisting>
-
- <para>to bind the connection factory from <code>com.example.ra.MCF</code> under <code>java:/eis/example</code>.</para>
-
- <para>See the schema appendix for additional details about the format.</para>
-
- <para>Alternative the resource adapter deployments will be picked up by the <code>RAActivator</code>
- bean which bind a single connection factory under</para>
-
- <programlisting>
-java:/eis/<deploymentName>
- </programlisting>
-
- <para>- f.ex. <code>java:/eis/example</code> and a single admin object under</para>
-
- <programlisting>
-java:/eis/ao/<deploymentName>
- </programlisting>
-
- <para>- f.ex. <code>java:/eis/ao/example</code>.</para>
-
- <section id="deployingra_descriptor">
- <title>Resource adapter descriptor</title>
-
- <para>A resource adapter can be configured using two different ways
-
- <itemizedlist spacing="compact">
- <listitem><code>META-INF/ironjacamar.xml</code> for internal configuration</listitem>
- <listitem><code>-ra.xml</code> for external configuration</listitem>
- </itemizedlist>
-
- to the resource adapter archive. Both formats share the same layout to ease
- configuration - only the top-level elements differ.</para>
-
- <table frame="all">
- <title>Main elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>bean-validation-groups</code></entry>
- <entry>
- Specifies bean validation group that should be used
- </entry>
- </row>
- <row>
- <entry><code>bootstrap-context</code></entry>
- <entry>
- Specifies the unique name of the bootstrap context that should be used
- </entry>
- </row>
- <row>
- <entry><code>config-property</code></entry>
- <entry>
- The config-property specifies resource adapter configuration properties.
- </entry>
- </row>
- <row>
- <entry><code>transaction-support</code></entry>
- <entry>
- Define the type of transaction supported by this resource adapter.
- Valid values are: NoTransaction, LocalTransaction, XATransaction
- </entry>
- </row>
- <row>
- <entry><code>connection-definitions</code></entry>
- <entry>
- Specifies the connection definitions
- </entry>
- </row>
- <row>
- <entry><code>admin-objects</code></entry>
- <entry>
- Specifies the administration objects
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Bean validation groups elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>bean-validation-group</code></entry>
- <entry>
- Specifies the fully qualified class name for a bean validation group that
- should be used for validation
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Connection definition / admin object attributes</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Attribute</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>class-name</code></entry>
- <entry>
- Specifies the the fully qualified class name of a managed connection factory
- or admin object
- </entry>
- </row>
- <row>
- <entry><code>jndi-name</code></entry>
- <entry>
- Specifies the JNDI name
- </entry>
- </row>
- <row>
- <entry><code>enabled</code></entry>
- <entry>
- Should the object in question be activated
- </entry>
- </row>
- <row>
- <entry><code>use-java-context</code></entry>
- <entry>
- Specifies if a java:/ JNDI context should be used
- </entry>
- </row>
- <row>
- <entry><code>pool-name</code></entry>
- <entry>
- Specifies the pool name for the object
- </entry>
- </row>
- <row>
- <entry><code>use-ccm</code></entry>
- <entry>
- Enable the cache connection manager
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Connection definition elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>config-property</code></entry>
- <entry>
- The config-property specifies managed connection factory configuration properties.
- </entry>
- </row>
- <row>
- <entry><code>pool</code></entry>
- <entry>
- Specifies pooling settings
- </entry>
- </row>
- <row>
- <entry><code>xa-pool</code></entry>
- <entry>
- Specifies XA pooling settings
- </entry>
- </row>
- <row>
- <entry><code>security</code></entry>
- <entry>
- Specifies security settings
- </entry>
- </row>
- <row>
- <entry><code>timeout</code></entry>
- <entry>
- Specifies time out settings
- </entry>
- </row>
- <row>
- <entry><code>validation</code></entry>
- <entry>
- Specifies validation settings
- </entry>
- </row>
- <row>
- <entry><code>recovery</code></entry>
- <entry>
- Specifies the XA recovery settings
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Pool elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>min-pool-size</code></entry>
- <entry>
- The min-pool-size element indicates the minimum number of connections
- a pool should hold. These are not created until a Subject is known from a
- request for a connection. This default to 0
- </entry>
- </row>
- <row>
- <entry><code>max-pool-size</code></entry>
- <entry>
- The max-pool-size element indicates the maximum number of connections
- for a pool. No more than max-pool-size connections will be created in each sub-pool.
- This defaults to 20.
- </entry>
- </row>
- <row>
- <entry><code>prefill</code></entry>
- <entry>
- Whether to attempt to prefill the connection pool.
- Default is false
- </entry>
- </row>
- <row>
- <entry><code>use-strict-min</code></entry>
- <entry>
- Specifies if the min-pool-size should be considered strictly.
- Default false
- </entry>
- </row>
- <row>
- <entry><code>flush-strategy</code></entry>
- <entry>
- Specifies how the pool should be flush in case of an error.
- Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>XA pool elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>min-pool-size</code></entry>
- <entry>
- The min-pool-size element indicates the minimum number of connections
- a pool should hold. These are not created until a Subject is known from a
- request for a connection. This default to 0
- </entry>
- </row>
- <row>
- <entry><code>max-pool-size</code></entry>
- <entry>
- The max-pool-size element indicates the maximum number of connections
- for a pool. No more than max-pool-size connections will be created in each sub-pool.
- This defaults to 20.
- </entry>
- </row>
- <row>
- <entry><code>prefill</code></entry>
- <entry>
- Whether to attempt to prefill the connection pool.
- Default is false
- </entry>
- </row>
- <row>
- <entry><code>use-strict-min</code></entry>
- <entry>
- Specifies if the min-pool-size should be considered strictly.
- Default false
- </entry>
- </row>
- <row>
- <entry><code>flush-strategy</code></entry>
- <entry>
- Specifies how the pool should be flush in case of an error.
- Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
- </entry>
- </row>
- <row>
- <entry><code>is-same-rm-override</code></entry>
- <entry>
- The is-same-rm-override element allows one to unconditionally
- set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns
- true or false
- </entry>
- </row>
- <row>
- <entry><code>interleaving</code></entry>
- <entry>
- An element to enable interleaving for XA connection factories
- </entry>
- </row>
- <row>
- <entry><code>no-tx-separate-pools</code></entry>
- <entry>
- 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
- </entry>
- </row>
- <row>
- <entry><code>pad-xid</code></entry>
- <entry>
- Should the Xid be padded
- </entry>
- </row>
- <row>
- <entry><code>wrap-xa-resource</code></entry>
- <entry>
- Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper
- instance
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Security elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>application</code></entry>
- <entry>
- Indicates that application supplied parameters (such as from getConnection(user, pw))
- are used to distinguish connections in the pool.
- </entry>
- </row>
- <row>
- <entry><code>security-domain</code></entry>
- <entry>
- Indicates Subject (from security domain) are used to distinguish connections in the pool.
- The content of the security-domain is the name of the JAAS security manager that will handle
- authentication. This name correlates to the JAAS login-config.xml descriptor
- application-policy/name attribute.
- </entry>
- </row>
- <row>
- <entry><code>security-domain-and-application</code></entry>
- <entry>
- Indicates that either application supplied parameters (such as from
- getConnection(user, pw)) or Subject (from security domain) are used to
- distinguish connections in the pool. The content of the
- security-domain is the name of the JAAS security manager that will handle
- authentication. This name correlates to the JAAS login-config.xml descriptor
- application-policy/name attribute.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Time out elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>blocking-timeout-millis</code></entry>
- <entry>
- The blocking-timeout-millis element indicates 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 30000 (30 seconds).
- </entry>
- </row>
- <row>
- <entry><code>idle-timeout-minutes</code></entry>
- <entry>
- The idle-timeout-minutes elements indicates the maximum time in minutes
- a connection may be idle before being closed. The actual maximum time depends
- also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes
- of any pool.
- </entry>
- </row>
- <row>
- <entry><code>allocation-retry</code></entry>
- <entry>
- The allocation retry element indicates the number of times that allocating
- a connection should be tried before throwing an exception. The default is
- 0.
- </entry>
- </row>
- <row>
- <entry><code>allocation-retry-wait-millis</code></entry>
- <entry>
- The allocation retry wait millis element indicates the time in milliseconds
- to wait between retrying to allocate a connection. The default is 5000 (5 seconds).
- </entry>
- </row>
- <row>
- <entry><code>xa-resource-timeout</code></entry>
- <entry>
- Passed to XAResource.setTransactionTimeout(). Default is zero which does not invoke the setter.
- Specified in seconds
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Validation elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>background-validation</code></entry>
- <entry>
- An element to specify that connections should be validated on a background
- thread versus being validated prior to use
- </entry>
- </row>
- <row>
- <entry><code>background-validation-minutes</code></entry>
- <entry>
- The background-validation-minutes element specifies the amount of
- time, in minutes, that background validation will run.
- </entry>
- </row>
- <row>
- <entry><code>use-fast-fail</code></entry>
- <entry>
- Whether fail a connection allocation on the first connection if it
- is invalid (true) or keep trying until the pool is exhausted of all potential
- connections (false). Default is false
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Admin object elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>config-property</code></entry>
- <entry>
- Specifies an administration object configuration property.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Recovery elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>recover-credential</code></entry>
- <entry>
- Specifies the user name / password pair or security domain that
- should be used for recovery.
- </entry>
- </row>
- <row>
- <entry><code>recover-plugin</code></entry>
- <entry>
- Specifies an implementation of the org.jboss.jca.core.spi.recovery.RecoveryPlugin
- class.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The deployment schemas are defined in <code>doc/ironjacamar_1_0.xsd</code> and
- <code>doc/resource-adapters_1_0.xsd</code>.</para>
-
- </section>
-
- <section id="deployingra_extensions">
- <title>Resource adapter extensions</title>
-
- <para>
- A resource adapter can make use of a couple of Java EE Connector Architecture extensions in
- the IronJacamar container in order to improve the integration.
- </para>
-
- <para>
- The extensions include
-
- <itemizedlist>
- <listitem>
- <code>org.jboss.jca.core.spi.recovery.RecoveryPlugin</code>: Plugin to provide feedback
- to the recovery module inside IronJacamar.
- </listitem>
- <listitem>
- <code>org.jboss.jca.core.spi.statistics.Statistics</code>: Plugin to identify a resource
- adapter component (<code>ResourceAdapter</code>, <code>ManagedConnectionFactory</code> and
- admin object) that provides statistics.
- </listitem>
- </itemizedlist>
-
- </para>
-
- <para>
- The following sections will describe these extensions points.
- </para>
-
- <section id="deployingra_extensions_recovery">
- <title>Recovery extension</title>
-
- <para>
- The IronJacamar recovery extension allows the resource adapter deployment to give feedback
- to the container if a <code>ManagedConnection</code> can be used for recovery. This extension
- is used as part of XA recovery in the environment, and should therefore be implemented by all
- resource adapters capable of working in an <code>XATransaction</code> sematics.
- </para>
-
- <para>
- The interface <code>org.jboss.core.spi.recovery.RecoveryPlugin</code> located in the
- <code>ironjacamar-core-api</code> artifact makes up the SPI for the extension.
- </para>
-
- <para>
- The interface contains two methods that should be implemented in a resource adapter specific
- manner.
- </para>
-
- <para>
- The method
-
- <programlisting>
-public boolean isValid(Object c) throws ResourceException;
- </programlisting>
-
- will return <code>true</code> if the connection can be used for recovery.
- </para>
-
- <para>
- The method
-
- <programlisting>
-public void close(Object c) throws ResourceException;
- </programlisting>
-
- will close a connection that was used for recovery.
- </para>
-
- <para>
- The recovery extension is activated by adding a recovery element to the deployment
-
- <programlisting>
-<recovery>
- <recovery-plugin>com.mycompany.myproject.RecoveryPluginImpl</recovery-plugin>
-</recovery>
- </programlisting>
-
- </para>
-
- <note>
- The IronJacamar container will use a default implementation of the recovery SPI if an
- implementation isn't specified by the deployment.
- </note>
-
- </section>
-
- <section id="deployingra_extensions_statistics">
- <title>Statistics extension</title>
-
- <para>
- The IronJacamar statistics extension allows a resource adapter to expose statistics to
- the container and hence to the environment where IronJacamar is running. Statistics can
- be enabled for <code>ResourceAdapter</code>, <code>ManagedConnectionFactory</code> and
- admin object instances.
- </para>
-
- <para>
- The extension include two interfaces <code>org.jboss.core.spi.statistics.Statistics</code>
- and <code>org.jboss.core.spi.statistics.StatisticsPlugin</code>. Both these interfaces are
- located in the <code>ironjacamar-core-api</code> artifact.
- </para>
-
- <para>
- The <code>Statistics</code> interface will mark a resource adapter component as statistics capable
- and return the statistics plugin implementation instance.
- </para>
-
- <para>
- The <code>StatisticsPlugin</code> interface contains methods to expose and describe each statistic
- that the plugin makes available. This information will then be made available to the environment
- where the IronJacamar container is running using the environment's prefered mechanism.
- </para>
-
- <note>
- The IronJacamar container will only expose core statistics for a deployment if no implementation
- of this extension is available.
- </note>
-
- </section>
-
- </section>
-
- </section>
-
- <!-- Datasources -->
- <section id="deployingds">
- <title>Deploying datasources</title>
-
- <para>Datasources (-ds.xml) are deployed by copying the definition into the
- <code>deploy/</code> directory</para>
-
- <programlisting>
-cp postgres-xa-ds.xml ironjacamar-1.0.0.Final/deploy
- </programlisting>
-
- <para>on a Un*x based system or</para>
-
- <programlisting>
-copy postgres-xa-ds.xml ironjacamar-1.0.0.Final\deploy
- </programlisting>
-
- <para>on Windows.</para>
-
- <para>You will need to install the database JDBC driver into the <code>lib/</code> directory.</para>
-
- <para>You can find examples of datasource definitions in the <code>doc/datasources</code> directory
- and the schema itself <code>doc/datasources_1_0.xsd</code>.</para>
-
- <section id="deployingds_descriptor">
- <title>Datasource descriptor</title>
-
- <para>Datasource descriptors are divided into
-
- <itemizedlist spacing="compact">
- <listitem><code><datasource></code> for a standard datasource</listitem>
- <listitem><code><xa-datasource></code> for an XA capable datasource</listitem>
- </itemizedlist>
-
- definitions.</para>
-
- <para>A datasource descriptor supports the following parameters.</para>
-
- <table frame="all">
- <title>Common datasource attributes</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Attribute</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>jndi-name</code></entry>
- <entry>
- Specifies the JNDI name for the datasource
- </entry>
- </row>
- <row>
- <entry><code>pool-name</code></entry>
- <entry>
- Specifies the pool name for the datasource used for management
- </entry>
- </row>
- <row>
- <entry><code>enabled</code></entry>
- <entry>
- Specifies if the datasource should be enabled
- </entry>
- </row>
- <row>
- <entry><code>use-java-context</code></entry>
- <entry>
- Setting this to false will bind the DataSource into global JNDI
- </entry>
- </row>
- <row>
- <entry><code>spy</code></entry>
- <entry>
- Enable spy functionality on the JDBC layer - e.g. log all JDBC traffic to the datasource.
- The logging category <code>org.jboss.jdbc</code> must be enabled too.
- </entry>
- </row>
- <row>
- <entry><code>use-ccm</code></entry>
- <entry>
- Enable the cached connection manager
- </entry>
- </row>
- <row>
- <entry><code>jta</code></entry>
- <entry>
- Enable JTA integration (only <code><datasource></code>)
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title><code>datasource</code> elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>connection-url</code></entry>
- <entry>
- The JDBC driver connection URL
- </entry>
- </row>
- <row>
- <entry><code>driver-class</code></entry>
- <entry>
- The fully qualifed name of the JDBC driver class
- </entry>
- </row>
- <row>
- <entry><code>datasource-class</code></entry>
- <entry>
- The fully qualifed name of the JDBC datasource class
- </entry>
- </row>
- <row>
- <entry><code>driver</code></entry>
- <entry>
- An unique name for the JDBC driver specified in the drivers section.
- Or the name of the .jar file if deployed as standalone deployment
- </entry>
- </row>
- <row>
- <entry><code>connection-property</code></entry>
- <entry>
- The connection-property element allows you to pass in arbitrary connection
- properties to the Driver.connect(url, props) method. Each connection-property
- specifies a string name/value pair with the property name coming from the
- name attribute and the value coming from the element content
- </entry>
- </row>
- <row>
- <entry><code>new-connection-sql</code></entry>
- <entry>
- Specify an SQL statement to execute whenever a connection is added
- to the connection pool
- </entry>
- </row>
- <row>
- <entry><code>transaction-isolation</code></entry>
- <entry>
- Set java.sql.Connection transaction isolation level to use. The constants
- defined by transaction-isolation-values are the possible transaction isolation
- levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED
- TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE
- </entry>
- </row>
- <row>
- <entry><code>url-delimiter</code></entry>
- <entry>
- Specifies the delimeter for URLs in connection-url for HA datasources
- </entry>
- </row>
- <row>
- <entry><code>url-selector-strategy-class-name</code></entry>
- <entry>
- A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
- </entry>
- </row>
- <row>
- <entry><code>pool</code></entry>
- <entry>
- Specifies the pooling settings
- </entry>
- </row>
- <row>
- <entry><code>security</code></entry>
- <entry>
- Specifies the security settings
- </entry>
- </row>
- <row>
- <entry><code>validation</code></entry>
- <entry>
- Specifies the validation settings
- </entry>
- </row>
- <row>
- <entry><code>timeout</code></entry>
- <entry>
- Specifies the time out settings
- </entry>
- </row>
- <row>
- <entry><code>statement</code></entry>
- <entry>
- Specifies the statement settings
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title><code>xa-datasource</code> elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>xa-datasource-property</code></entry>
- <entry>
- Specifies a property to assign to the XADataSource implementation class.
- Each property is identified by the name attribute and the property value
- is given by the xa-datasource-property element content. The property is mapped
- onto the XADataSource 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 java.beans.PropertyEditor for the type
- </entry>
- </row>
- <row>
- <entry><code>xa-datasource-class</code></entry>
- <entry>
- The fully qualifed name of the javax.sql.XADataSource implementation
- class
- </entry>
- </row>
- <row>
- <entry><code>driver</code></entry>
- <entry>
- An unique name for the JDBC driver specified in the drivers section.
- Or the name of the .jar file if deployed as standalone deployment
- </entry>
- </row>
- <row>
- <entry><code>url-delimiter</code></entry>
- <entry>
- Specifies the delimeter for URLs in the connection url for HA datasources
- </entry>
- </row>
- <row>
- <entry><code>url-selector-strategy-class-name</code></entry>
- <entry>
- A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
- </entry>
- </row>
- <row>
- <entry><code>new-connection-sql</code></entry>
- <entry>
- Specifies an SQL statement to execute whenever a connection is added
- to the connection pool
- </entry>
- </row>
- <row>
- <entry><code>transaction-isolation</code></entry>
- <entry>
- Set java.sql.Connection transaction isolation level to use. The constants
- defined by transaction-isolation-values are the possible transaction isolation
- levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED
- TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE
- </entry>
- </row>
- <row>
- <entry><code>xa-pool</code></entry>
- <entry>
- Specifies the pooling settings
- </entry>
- </row>
- <row>
- <entry><code>security</code></entry>
- <entry>
- Specifies the security settings
- </entry>
- </row>
- <row>
- <entry><code>validation</code></entry>
- <entry>
- Specifies the validation settings
- </entry>
- </row>
- <row>
- <entry><code>timeout</code></entry>
- <entry>
- Specifies the time out settings
- </entry>
- </row>
- <row>
- <entry><code>statement</code></entry>
- <entry>
- Specifies the statement settings
- </entry>
- </row>
- <row>
- <entry><code>recovery</code></entry>
- <entry>
- Specifies the recovery settings
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Pool settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>min-pool-size</code></entry>
- <entry>
- The min-pool-size element indicates the minimum number of connections
- a pool should hold. These are not created until a Subject is known from a
- request for a connection. This default to 0
- </entry>
- </row>
- <row>
- <entry><code>max-pool-size</code></entry>
- <entry>
- The max-pool-size element indicates the maximum number of connections
- for a pool. No more connections will be created in each sub-pool.
- This defaults to 20
- </entry>
- </row>
- <row>
- <entry><code>prefill</code></entry>
- <entry>
- Whether to attempt to prefill the connection pool. Empty element denotes
- a true value. Default is false
- </entry>
- </row>
- <row>
- <entry><code>use-strict-min</code></entry>
- <entry>
- Define if the min-pool-size should be considered a strictly.
- Default false
- </entry>
- </row>
- <row>
- <entry><code>flush-strategy</code></entry>
- <entry>
- Specifies how the pool should be flush in case of an error.
- Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>XA pool settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>min-pool-size</code></entry>
- <entry>
- The min-pool-size element indicates the minimum number of connections
- a pool should hold. These are not created until a Subject is known from a
- request for a connection. This default to 0
- </entry>
- </row>
- <row>
- <entry><code>max-pool-size</code></entry>
- <entry>
- The max-pool-size element indicates the maximum number of connections
- for a pool. No more connections will be created in each sub-pool.
- This defaults to 20
- </entry>
- </row>
- <row>
- <entry><code>prefill</code></entry>
- <entry>
- Whether to attempt to prefill the connection pool. Empty element denotes
- a true value. Default is false
- </entry>
- </row>
- <row>
- <entry><code>use-strict-min</code></entry>
- <entry>
- Define if the min-pool-size should be considered a strictly.
- Default false
- </entry>
- </row>
- <row>
- <entry><code>flush-strategy</code></entry>
- <entry>
- Specifies how the pool should be flush in case of an error.
- Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
- </entry>
- </row>
- <row>
- <entry><code>is-same-rm-override</code></entry>
- <entry>
- The is-same-rm-override element allows one to unconditionally
- set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns
- true or false
- </entry>
- </row>
- <row>
- <entry><code>interleaving</code></entry>
- <entry>
- An element to enable interleaving for XA connection factories
- </entry>
- </row>
- <row>
- <entry><code>no-tx-separate-pools</code></entry>
- <entry>
- 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
- </entry>
- </row>
- <row>
- <entry><code>pad-xid</code></entry>
- <entry>
- Should the Xid be padded
- </entry>
- </row>
- <row>
- <entry><code>wrap-xa-resource</code></entry>
- <entry>
- Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper
- instance
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Security settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>user-name</code></entry>
- <entry>
- Specify the username used when creating a new connection.
- </entry>
- </row>
- <row>
- <entry><code>password</code></entry>
- <entry>
- Specify the password used when creating a new connection.
- </entry>
- </row>
- <row>
- <entry><code>security-domain</code></entry>
- <entry>
- Indicates Subject (from security domain) are used to distinguish connections in the pool.
- The content of the security-domain is the name of the JAAS security manager that will handle
- authentication. This name correlates to the JAAS login-config.xml descriptor
- application-policy/name attribute.
- </entry>
- </row>
- <row>
- <entry><code>reauth-plugin</code></entry>
- <entry>
- Defines a reauthentication plugin that can be used for reauthentication of physical connections.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Validation settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>valid-connection-checker</code></entry>
- <entry>
- An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides
- a SQLException isValidConnection(Connection e) method to validate is a connection
- is valid. An exception means the connection is destroyed. This overrides
- the check-valid-connection-sql when present
- </entry>
- </row>
- <row>
- <entry><code>check-valid-connection-sql</code></entry>
- <entry>
- Specify an SQL statement to check validity of a pool connection. This
- may be called when managed connection is taken from pool for use.
- </entry>
- </row>
- <row>
- <entry><code>validate-on-match</code></entry>
- <entry>
- The validate-on-match element indicates whether or not connection
- level validation should be done when a connection factory attempts to match
- a managed connection for a given set. This is typically exclusive to the
- use of background validation
- </entry>
- </row>
- <row>
- <entry><code>background-validation</code></entry>
- <entry>
- An element to specify that connections should be validated on a background
- thread versus being validated prior to use
- </entry>
- </row>
- <row>
- <entry><code>background-validation-minutes</code></entry>
- <entry>
- The background-validation-minutes element specifies the amount of
- time, in minutes, that background validation will run
- </entry>
- </row>
- <row>
- <entry><code>use-fast-fail</code></entry>
- <entry>
- Whether fail a connection allocation on the first connection if it
- is invalid (true) or keep trying until the pool is exhausted of all potential
- connections (false) default false
- </entry>
- </row>
- <row>
- <entry><code>stale-connection-checker</code></entry>
- <entry>
- An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides
- a boolean isStaleConnection(SQLException e) method which if it it returns
- true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
- which is a subclass of SQLException
- </entry>
- </row>
- <row>
- <entry><code>exception-sorter</code></entry>
- <entry>
- An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a
- boolean isExceptionFatal(SQLException e) method to validate is an exception
- should be broadcast to all javax.resource.spi.ConnectionEventListener as
- a connectionErrorOccurred message
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Time out settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>blocking-timeout-millis</code></entry>
- <entry>
- The blocking-timeout-millis element indicates 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 30000 (30 seconds).
- </entry>
- </row>
- <row>
- <entry><code>idle-timeout-minutes</code></entry>
- <entry>
- The idle-timeout-minutes elements indicates the maximum time in minutes
- a connection may be idle before being closed. The actual maximum time depends
- also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes
- of any pool.
- </entry>
- </row>
- <row>
- <entry><code>set-tx-query-timeout</code></entry>
- <entry>
- Whether to set the query timeout based on the time remaining until
- transaction timeout, any configured query timeout will be used if there is
- no transaction. The default is false
- </entry>
- </row>
- <row>
- <entry><code>query-timeout</code></entry>
- <entry>
- Any configured query timeout in seconds The default is no timeout
- </entry>
- </row>
- <row>
- <entry><code>use-try-lock</code></entry>
- <entry>
- Any configured timeout for internal locks on the resource adapter
- objects in seconds The default is a 60 second timeout
- </entry>
- </row>
- <row>
- <entry><code>allocation-retry</code></entry>
- <entry>
- The allocation retry element indicates the number of times that allocating
- a connection should be tried before throwing an exception. The default is 0.
- </entry>
- </row>
- <row>
- <entry><code>allocation-retry-wait-millis</code></entry>
- <entry>
- The allocation retry wait millis element indicates the time in milliseconds
- to wait between retrying to allocate a connection. The default is 5000 (5 seconds).
- </entry>
- </row>
- <row>
- <entry><code>xa-resource-timeout</code></entry>
- <entry>
- Passed to XAResource.setTransactionTimeout() Default is zero which
- does not invoke the setter. In seconds
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Statement settings</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>track-statements</code></entry>
- <entry>
- Whether to check for unclosed statements when a connection is returned
- to the pool and result sets are closed when a statement is closed/return
- to the prepared statement cache. valid values are: false - do not track statements
- and results true - track statements and result sets and warn when they are
- not closed nowarn - track statements but do no warn about them being unclosed
- (the default)
- </entry>
- </row>
- <row>
- <entry><code>prepared-statement-cache-size</code></entry>
- <entry>
- The number of prepared statements per connection in an LRU cache
- </entry>
- </row>
- <row>
- <entry><code>share-prepared-statements</code></entry>
- <entry>
- Whether to share prepare statements, i.e. whether asking for same
- statement twice without closing uses the same underlying prepared statement.
- The default is false
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Recovery elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>recover-credential</code></entry>
- <entry>
- Specifies the user name / password pair or security domain that
- should be used for recovery.
- </entry>
- </row>
- <row>
- <entry><code>recover-plugin</code></entry>
- <entry>
- Specifies an implementation of the org.jboss.jca.core.spi.recovery.RecoveryPlugin
- class.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Driver attributes</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Attribute</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>name</code></entry>
- <entry>
- An unique name for the JDBC driver
- </entry>
- </row>
- <row>
- <entry><code>module</code></entry>
- <entry>
- The module definition for the JDBC driver. The format of a module inside
- JBoss Application Server 7+ is <code>com.h2database.h2</code> which will
- map to the H2 installation under <code>modules/com/h2database/h2/main</code>.
- The format for IronJacamar Standalone/Embedded is the name of the .jar file
- </entry>
- </row>
- <row>
- <entry><code>major-version</code></entry>
- <entry>
- The major version of the driver
- </entry>
- </row>
- <row>
- <entry><code>minor-version</code></entry>
- <entry>
- The minor version of the driver
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table frame="all">
- <title>Driver elements</title>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" colwidth="2*"/>
- <colspec colname="c2" colwidth="3*"/>
- <thead>
- <row>
- <entry align="left">Element</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>driver-class</code></entry>
- <entry>
- The fully qualified class name of the driver class
- </entry>
- </row>
- <row>
- <entry><code>datasource-class</code></entry>
- <entry>
- The fully qualified class name of the datasource class
- </entry>
- </row>
- <row>
- <entry><code>xa-datasource-class</code></entry>
- <entry>
- The fully qualified class name of the XA datasource class
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The datasource deployment schema is defined in <code>doc/datasources_1_0.xsd</code>.</para>
-
- </section>
-
- <section id="deployingds_extensions">
- <title>Datasource extensions</title>
-
- <para>
- The datasource deployments can make use of a couple of extensions in the JDBC resource adapter
- to improve the connection validation and checking if an exception should reestablish
- the connection in question.
- </para>
-
- <para>
- The extensions include
-
- <itemizedlist>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.spi.ExceptionSorter</code>: Plugin to check if a
- <code>SQLException</code> is fatal for the connection on which it was thrown.
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.spi.StaleConnection</code>: Plugin to wrap stale
- <code>SQLException</code>'s in a <code>org.jboss.jca.adapters.jdbc.StaleConnectionException</code>.
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.spi.ValidConnection</code>: Plugin to Check if a connection is
- valid for use by the application.
- </listitem>
- </itemizedlist>
-
- </para>
-
- <para>
- Configuration of the extensions are done by using
-
- <itemizedlist>
- <listitem>
- The <code><exception-sorter></code> tag for an <code>ExceptionSorter</code>
- </listitem>
- <listitem>
- The <code><stale-connection-checker></code> tag for a <code>StaleConnection</code>
- </listitem>
- <listitem>
- The <code><valid-connection-checker></code> tag for a <code>ValidConnection</code>
- </listitem>
- </itemizedlist>
-
- </para>
-
- <para>
- IronJacamar features implementations of these extensions for a couple of popular databases.
- Contributions in this area are most welcome either generic solutions or for a specific database.
- </para>
-
- <para>
- Informix:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.informix.InformixExceptionSorter</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Microsoft SQLServer:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- PostgreSQL:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- MySQL:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLReplicationValidConnectionChecker</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- IBM DB2:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Generic:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullStaleConnectionChecker</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Sybase:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Oracle:
-
- <itemizedlist spacing="compact">
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker</code>
- </listitem>
- <listitem>
- <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker</code>
- </listitem>
- </itemizedlist>
- </para>
-
- </section>
-
- </section>
-
-</chapter>
Copied: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml (from rev 112490, projects/jboss-jca/trunk/doc/userguide/en-US/modules/deployment.xml)
===================================================================
--- projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml (rev 0)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/deployment.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -0,0 +1,1722 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="deployment">
+ <title>Deployment</title>
+
+ <para>The IronJacamar distribution contains a deploy/ directory where all deployments
+ should be deployed to.</para>
+
+ <section id="packagingrequirements">
+ <title>Packaging requirements</title>
+
+ <para>A resource adapter archive is a structured Java Archive (JAR) file, which
+ bundles all Java classes in JAR files, and optionally contains metadata, resources and native
+ libraries.</para>
+
+ <para>A resource adapter archive name ends in the <code>.rar</code> extension.</para>
+
+ <para>An example of a resource adapter archive could look like</para>
+
+ <programlisting>
+<![CDATA[
+[jpederse at localhost]$ jar tf ra.rar
+META-INF/ra.xml
+readme.html
+ra.jar
+images/icon.jpg
+win.dll
+linux.so
+ ]]>
+ </programlisting>
+
+ <para>See the Java EE Connector Architecture 1.6 specification chapter 20 for further
+ requirements.</para>
+
+ </section>
+
+ <section id="deployingrar">
+ <title>Deploying resource adapters</title>
+
+ <para>Resource adapters (.rar) are deployed by copying the resource adapter into the
+ <code>deploy/</code> directory</para>
+
+ <programlisting>
+cp example.rar ironjacamar-1.0.0.Final/deploy
+ </programlisting>
+
+ <para>on a Un*x based system or</para>
+
+ <programlisting>
+copy example.rar ironjacamar-1.0.0.Final\deploy
+ </programlisting>
+
+ <para>on Windows.</para>
+
+ <para>The resource adapter can be configured and activated through a <code>META-INF/ironjacamar.xml</code>
+ file in the archive. The format of the XML document is defined by the <code>ironjacamar_1_0.xsd</code>.</para>
+
+ <para>A resource adapter can also be configured and activated through deployment of a <code>-ra.xml</code>
+ file in the <code>deploy/</code> directory - f.ex. <code>deploy/example-ra.xml</code>. The format of the XML
+ document is defined by the <code>resource-adapters_1_0.xsd</code> - f.ex</para>
+
+ <programlisting language="xml">
+<![CDATA[
+<resource-adapters>
+ <resource-adapter>
+ <archive>example.rar</archive>
+ <connection-definitions>
+ <connection-definition jndi-name="java:/eis/example" class-name="com.example.ra.MCF"/>
+ </connection-definitions>
+ </resource-adapter>
+</resource-adapters>
+]]>
+ </programlisting>
+
+ <para>to bind the connection factory from <code>com.example.ra.MCF</code> under <code>java:/eis/example</code>.</para>
+
+ <para>See the schema appendix for additional details about the format.</para>
+
+ <para>Alternative the resource adapter deployments will be picked up by the <code>RAActivator</code>
+ bean which bind a single connection factory under</para>
+
+ <programlisting>
+java:/eis/<deploymentName>
+ </programlisting>
+
+ <para>- f.ex. <code>java:/eis/example</code> and a single admin object under</para>
+
+ <programlisting>
+java:/eis/ao/<deploymentName>
+ </programlisting>
+
+ <para>- f.ex. <code>java:/eis/ao/example</code>.</para>
+
+ <section id="deployingra_descriptor">
+ <title>Resource adapter descriptor</title>
+
+ <para>A resource adapter can be configured using two different ways
+
+ <itemizedlist spacing="compact">
+ <listitem><code>META-INF/ironjacamar.xml</code> for internal configuration</listitem>
+ <listitem><code>-ra.xml</code> for external configuration</listitem>
+ </itemizedlist>
+
+ to the resource adapter archive. Both formats share the same layout to ease
+ configuration - only the top-level elements differ.</para>
+
+ <table frame="all">
+ <title>Main elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>bean-validation-groups</code></entry>
+ <entry>
+ Specifies bean validation group that should be used
+ </entry>
+ </row>
+ <row>
+ <entry><code>bootstrap-context</code></entry>
+ <entry>
+ Specifies the unique name of the bootstrap context that should be used
+ </entry>
+ </row>
+ <row>
+ <entry><code>config-property</code></entry>
+ <entry>
+ The config-property specifies resource adapter configuration properties.
+ </entry>
+ </row>
+ <row>
+ <entry><code>transaction-support</code></entry>
+ <entry>
+ Define the type of transaction supported by this resource adapter.
+ Valid values are: NoTransaction, LocalTransaction, XATransaction
+ </entry>
+ </row>
+ <row>
+ <entry><code>connection-definitions</code></entry>
+ <entry>
+ Specifies the connection definitions
+ </entry>
+ </row>
+ <row>
+ <entry><code>admin-objects</code></entry>
+ <entry>
+ Specifies the administration objects
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Bean validation groups elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>bean-validation-group</code></entry>
+ <entry>
+ Specifies the fully qualified class name for a bean validation group that
+ should be used for validation
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Connection definition / admin object attributes</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Attribute</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>class-name</code></entry>
+ <entry>
+ Specifies the the fully qualified class name of a managed connection factory
+ or admin object
+ </entry>
+ </row>
+ <row>
+ <entry><code>jndi-name</code></entry>
+ <entry>
+ Specifies the JNDI name
+ </entry>
+ </row>
+ <row>
+ <entry><code>enabled</code></entry>
+ <entry>
+ Should the object in question be activated
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-java-context</code></entry>
+ <entry>
+ Specifies if a java:/ JNDI context should be used
+ </entry>
+ </row>
+ <row>
+ <entry><code>pool-name</code></entry>
+ <entry>
+ Specifies the pool name for the object
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-ccm</code></entry>
+ <entry>
+ Enable the cache connection manager
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Connection definition elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>config-property</code></entry>
+ <entry>
+ The config-property specifies managed connection factory configuration properties.
+ </entry>
+ </row>
+ <row>
+ <entry><code>pool</code></entry>
+ <entry>
+ Specifies pooling settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-pool</code></entry>
+ <entry>
+ Specifies XA pooling settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>security</code></entry>
+ <entry>
+ Specifies security settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>timeout</code></entry>
+ <entry>
+ Specifies time out settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>validation</code></entry>
+ <entry>
+ Specifies validation settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>recovery</code></entry>
+ <entry>
+ Specifies the XA recovery settings
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Pool elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>min-pool-size</code></entry>
+ <entry>
+ The min-pool-size element indicates the minimum number of connections
+ a pool should hold. These are not created until a Subject is known from a
+ request for a connection. This default to 0
+ </entry>
+ </row>
+ <row>
+ <entry><code>max-pool-size</code></entry>
+ <entry>
+ The max-pool-size element indicates the maximum number of connections
+ for a pool. No more than max-pool-size connections will be created in each sub-pool.
+ This defaults to 20.
+ </entry>
+ </row>
+ <row>
+ <entry><code>prefill</code></entry>
+ <entry>
+ Whether to attempt to prefill the connection pool.
+ Default is false
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-strict-min</code></entry>
+ <entry>
+ Specifies if the min-pool-size should be considered strictly.
+ Default false
+ </entry>
+ </row>
+ <row>
+ <entry><code>flush-strategy</code></entry>
+ <entry>
+ Specifies how the pool should be flush in case of an error.
+ Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>XA pool elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>min-pool-size</code></entry>
+ <entry>
+ The min-pool-size element indicates the minimum number of connections
+ a pool should hold. These are not created until a Subject is known from a
+ request for a connection. This default to 0
+ </entry>
+ </row>
+ <row>
+ <entry><code>max-pool-size</code></entry>
+ <entry>
+ The max-pool-size element indicates the maximum number of connections
+ for a pool. No more than max-pool-size connections will be created in each sub-pool.
+ This defaults to 20.
+ </entry>
+ </row>
+ <row>
+ <entry><code>prefill</code></entry>
+ <entry>
+ Whether to attempt to prefill the connection pool.
+ Default is false
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-strict-min</code></entry>
+ <entry>
+ Specifies if the min-pool-size should be considered strictly.
+ Default false
+ </entry>
+ </row>
+ <row>
+ <entry><code>flush-strategy</code></entry>
+ <entry>
+ Specifies how the pool should be flush in case of an error.
+ Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
+ </entry>
+ </row>
+ <row>
+ <entry><code>is-same-rm-override</code></entry>
+ <entry>
+ The is-same-rm-override element allows one to unconditionally
+ set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns
+ true or false
+ </entry>
+ </row>
+ <row>
+ <entry><code>interleaving</code></entry>
+ <entry>
+ An element to enable interleaving for XA connection factories
+ </entry>
+ </row>
+ <row>
+ <entry><code>no-tx-separate-pools</code></entry>
+ <entry>
+ 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
+ </entry>
+ </row>
+ <row>
+ <entry><code>pad-xid</code></entry>
+ <entry>
+ Should the Xid be padded
+ </entry>
+ </row>
+ <row>
+ <entry><code>wrap-xa-resource</code></entry>
+ <entry>
+ Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper
+ instance
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Security elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>application</code></entry>
+ <entry>
+ Indicates that application supplied parameters (such as from getConnection(user, pw))
+ are used to distinguish connections in the pool.
+ </entry>
+ </row>
+ <row>
+ <entry><code>security-domain</code></entry>
+ <entry>
+ Indicates Subject (from security domain) are used to distinguish connections in the pool.
+ The content of the security-domain is the name of the JAAS security manager that will handle
+ authentication. This name correlates to the JAAS login-config.xml descriptor
+ application-policy/name attribute.
+ </entry>
+ </row>
+ <row>
+ <entry><code>security-domain-and-application</code></entry>
+ <entry>
+ Indicates that either application supplied parameters (such as from
+ getConnection(user, pw)) or Subject (from security domain) are used to
+ distinguish connections in the pool. The content of the
+ security-domain is the name of the JAAS security manager that will handle
+ authentication. This name correlates to the JAAS login-config.xml descriptor
+ application-policy/name attribute.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Time out elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>blocking-timeout-millis</code></entry>
+ <entry>
+ The blocking-timeout-millis element indicates 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 30000 (30 seconds).
+ </entry>
+ </row>
+ <row>
+ <entry><code>idle-timeout-minutes</code></entry>
+ <entry>
+ The idle-timeout-minutes elements indicates the maximum time in minutes
+ a connection may be idle before being closed. The actual maximum time depends
+ also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes
+ of any pool.
+ </entry>
+ </row>
+ <row>
+ <entry><code>allocation-retry</code></entry>
+ <entry>
+ The allocation retry element indicates the number of times that allocating
+ a connection should be tried before throwing an exception. The default is
+ 0.
+ </entry>
+ </row>
+ <row>
+ <entry><code>allocation-retry-wait-millis</code></entry>
+ <entry>
+ The allocation retry wait millis element indicates the time in milliseconds
+ to wait between retrying to allocate a connection. The default is 5000 (5 seconds).
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-resource-timeout</code></entry>
+ <entry>
+ Passed to XAResource.setTransactionTimeout(). Default is zero which does not invoke the setter.
+ Specified in seconds
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Validation elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>background-validation</code></entry>
+ <entry>
+ An element to specify that connections should be validated on a background
+ thread versus being validated prior to use
+ </entry>
+ </row>
+ <row>
+ <entry><code>background-validation-minutes</code></entry>
+ <entry>
+ The background-validation-minutes element specifies the amount of
+ time, in minutes, that background validation will run.
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-fast-fail</code></entry>
+ <entry>
+ Whether fail a connection allocation on the first connection if it
+ is invalid (true) or keep trying until the pool is exhausted of all potential
+ connections (false). Default is false
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Admin object elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>config-property</code></entry>
+ <entry>
+ Specifies an administration object configuration property.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Recovery elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>recover-credential</code></entry>
+ <entry>
+ Specifies the user name / password pair or security domain that
+ should be used for recovery.
+ </entry>
+ </row>
+ <row>
+ <entry><code>recover-plugin</code></entry>
+ <entry>
+ Specifies an implementation of the org.jboss.jca.core.spi.recovery.RecoveryPlugin
+ class.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The deployment schemas are defined in <code>doc/ironjacamar_1_0.xsd</code> and
+ <code>doc/resource-adapters_1_0.xsd</code>.</para>
+
+ </section>
+
+ <section id="deployingra_extensions">
+ <title>Resource adapter extensions</title>
+
+ <para>
+ A resource adapter can make use of a couple of Java EE Connector Architecture extensions in
+ the IronJacamar container in order to improve the integration.
+ </para>
+
+ <para>
+ The extensions include
+
+ <itemizedlist>
+ <listitem>
+ <code>org.jboss.jca.core.spi.recovery.RecoveryPlugin</code>: Plugin to provide feedback
+ to the recovery module inside IronJacamar.
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.core.spi.statistics.Statistics</code>: Plugin to identify a resource
+ adapter component (<code>ResourceAdapter</code>, <code>ManagedConnectionFactory</code> and
+ admin object) that provides statistics.
+ </listitem>
+ </itemizedlist>
+
+ </para>
+
+ <para>
+ The following sections will describe these extensions points.
+ </para>
+
+ <section id="deployingra_extensions_recovery">
+ <title>Recovery extension</title>
+
+ <para>
+ The IronJacamar recovery extension allows the resource adapter deployment to give feedback
+ to the container if a <code>ManagedConnection</code> can be used for recovery. This extension
+ is used as part of XA recovery in the environment, and should therefore be implemented by all
+ resource adapters capable of working in an <code>XATransaction</code> semantics.
+ </para>
+
+ <para>
+ The interface <code>org.jboss.core.spi.recovery.RecoveryPlugin</code> located in the
+ <code>ironjacamar-core-api</code> artifact makes up the SPI for the extension.
+ </para>
+
+ <para>
+ The interface contains two methods that should be implemented in a resource adapter specific
+ manner.
+ </para>
+
+ <para>
+ The method
+
+ <programlisting>
+public boolean isValid(Object c) throws ResourceException;
+ </programlisting>
+
+ will return <code>true</code> if the connection can be used for recovery.
+ </para>
+
+ <para>
+ The method
+
+ <programlisting>
+public void close(Object c) throws ResourceException;
+ </programlisting>
+
+ will close a connection that was used for recovery.
+ </para>
+
+ <para>
+ The recovery extension is activated by adding a recovery element to the deployment
+
+ <programlisting>
+<recovery>
+ <recovery-plugin>com.mycompany.myproject.RecoveryPluginImpl</recovery-plugin>
+</recovery>
+ </programlisting>
+
+ </para>
+
+ <note>
+ The IronJacamar container will use a default implementation of the recovery SPI if an
+ implementation isn't specified by the deployment.
+ </note>
+
+ </section>
+
+ <section id="deployingra_extensions_statistics">
+ <title>Statistics extension</title>
+
+ <para>
+ The IronJacamar statistics extension allows a resource adapter to expose statistics to
+ the container and hence to the environment where IronJacamar is running. Statistics can
+ be enabled for <code>ResourceAdapter</code>, <code>ManagedConnectionFactory</code> and
+ admin object instances.
+ </para>
+
+ <para>
+ The extension include two interfaces <code>org.jboss.core.spi.statistics.Statistics</code>
+ and <code>org.jboss.core.spi.statistics.StatisticsPlugin</code>. Both these interfaces are
+ located in the <code>ironjacamar-core-api</code> artifact.
+ </para>
+
+ <para>
+ The <code>Statistics</code> interface will mark a resource adapter component as statistics capable
+ and return the statistics plugin implementation instance.
+ </para>
+
+ <para>
+ The <code>StatisticsPlugin</code> interface contains methods to expose and describe each statistic
+ that the plugin makes available. This information will then be made available to the environment
+ where the IronJacamar container is running using the environment's prefered mechanism.
+ </para>
+
+ <note>
+ The IronJacamar container will only expose core statistics for a deployment if no implementation
+ of this extension is available.
+ </note>
+
+ </section>
+
+ </section>
+
+ </section>
+
+ <!-- Datasources -->
+ <section id="deployingds">
+ <title>Deploying datasources</title>
+
+ <para>Datasources (-ds.xml) are deployed by copying the definition into the
+ <code>deploy/</code> directory</para>
+
+ <programlisting>
+cp postgres-xa-ds.xml ironjacamar-1.0.0.Final/deploy
+ </programlisting>
+
+ <para>on a Un*x based system or</para>
+
+ <programlisting>
+copy postgres-xa-ds.xml ironjacamar-1.0.0.Final\deploy
+ </programlisting>
+
+ <para>on Windows.</para>
+
+ <para>You will need to install the database JDBC driver into the <code>lib/</code> directory.</para>
+
+ <para>You can find examples of datasource definitions in the <code>doc/datasources</code> directory
+ and the schema itself <code>doc/datasources_1_0.xsd</code>.</para>
+
+ <section id="deployingds_descriptor">
+ <title>Datasource descriptor</title>
+
+ <para>Datasource descriptors are divided into
+
+ <itemizedlist spacing="compact">
+ <listitem><code><datasource></code> for a standard datasource</listitem>
+ <listitem><code><xa-datasource></code> for an XA capable datasource</listitem>
+ </itemizedlist>
+
+ definitions.</para>
+
+ <para>A datasource descriptor supports the following parameters.</para>
+
+ <table frame="all">
+ <title>Common datasource attributes</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Attribute</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>jndi-name</code></entry>
+ <entry>
+ Specifies the JNDI name for the datasource
+ </entry>
+ </row>
+ <row>
+ <entry><code>pool-name</code></entry>
+ <entry>
+ Specifies the pool name for the datasource used for management
+ </entry>
+ </row>
+ <row>
+ <entry><code>enabled</code></entry>
+ <entry>
+ Specifies if the datasource should be enabled
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-java-context</code></entry>
+ <entry>
+ Setting this to false will bind the DataSource into global JNDI
+ </entry>
+ </row>
+ <row>
+ <entry><code>spy</code></entry>
+ <entry>
+ Enable spy functionality on the JDBC layer - e.g. log all JDBC traffic to the datasource.
+ The logging category <code>org.jboss.jdbc</code> must be enabled too.
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-ccm</code></entry>
+ <entry>
+ Enable the cached connection manager
+ </entry>
+ </row>
+ <row>
+ <entry><code>jta</code></entry>
+ <entry>
+ Enable JTA integration (only <code><datasource></code>)
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title><code>datasource</code> elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>connection-url</code></entry>
+ <entry>
+ The JDBC driver connection URL
+ </entry>
+ </row>
+ <row>
+ <entry><code>driver-class</code></entry>
+ <entry>
+ The fully qualifed name of the JDBC driver class
+ </entry>
+ </row>
+ <row>
+ <entry><code>datasource-class</code></entry>
+ <entry>
+ The fully qualifed name of the JDBC datasource class
+ </entry>
+ </row>
+ <row>
+ <entry><code>driver</code></entry>
+ <entry>
+ An unique name for the JDBC driver specified in the drivers section.
+ Or the name of the .jar file if deployed as standalone deployment
+ </entry>
+ </row>
+ <row>
+ <entry><code>connection-property</code></entry>
+ <entry>
+ The connection-property element allows you to pass in arbitrary connection
+ properties to the Driver.connect(url, props) method. Each connection-property
+ specifies a string name/value pair with the property name coming from the
+ name attribute and the value coming from the element content
+ </entry>
+ </row>
+ <row>
+ <entry><code>new-connection-sql</code></entry>
+ <entry>
+ Specify an SQL statement to execute whenever a connection is added
+ to the connection pool
+ </entry>
+ </row>
+ <row>
+ <entry><code>transaction-isolation</code></entry>
+ <entry>
+ Set java.sql.Connection transaction isolation level to use. The constants
+ defined by transaction-isolation-values are the possible transaction isolation
+ levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED
+ TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE
+ </entry>
+ </row>
+ <row>
+ <entry><code>url-delimiter</code></entry>
+ <entry>
+ Specifies the delimeter for URLs in connection-url for HA datasources
+ </entry>
+ </row>
+ <row>
+ <entry><code>url-selector-strategy-class-name</code></entry>
+ <entry>
+ A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
+ </entry>
+ </row>
+ <row>
+ <entry><code>pool</code></entry>
+ <entry>
+ Specifies the pooling settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>security</code></entry>
+ <entry>
+ Specifies the security settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>validation</code></entry>
+ <entry>
+ Specifies the validation settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>timeout</code></entry>
+ <entry>
+ Specifies the time out settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>statement</code></entry>
+ <entry>
+ Specifies the statement settings
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title><code>xa-datasource</code> elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>xa-datasource-property</code></entry>
+ <entry>
+ Specifies a property to assign to the XADataSource implementation class.
+ Each property is identified by the name attribute and the property value
+ is given by the xa-datasource-property element content. The property is mapped
+ onto the XADataSource 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 java.beans.PropertyEditor for the type
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-datasource-class</code></entry>
+ <entry>
+ The fully qualifed name of the javax.sql.XADataSource implementation
+ class
+ </entry>
+ </row>
+ <row>
+ <entry><code>driver</code></entry>
+ <entry>
+ An unique name for the JDBC driver specified in the drivers section.
+ Or the name of the .jar file if deployed as standalone deployment
+ </entry>
+ </row>
+ <row>
+ <entry><code>url-delimiter</code></entry>
+ <entry>
+ Specifies the delimeter for URLs in the connection url for HA datasources
+ </entry>
+ </row>
+ <row>
+ <entry><code>url-selector-strategy-class-name</code></entry>
+ <entry>
+ A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
+ </entry>
+ </row>
+ <row>
+ <entry><code>new-connection-sql</code></entry>
+ <entry>
+ Specifies an SQL statement to execute whenever a connection is added
+ to the connection pool
+ </entry>
+ </row>
+ <row>
+ <entry><code>transaction-isolation</code></entry>
+ <entry>
+ Set java.sql.Connection transaction isolation level to use. The constants
+ defined by transaction-isolation-values are the possible transaction isolation
+ levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED
+ TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-pool</code></entry>
+ <entry>
+ Specifies the pooling settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>security</code></entry>
+ <entry>
+ Specifies the security settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>validation</code></entry>
+ <entry>
+ Specifies the validation settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>timeout</code></entry>
+ <entry>
+ Specifies the time out settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>statement</code></entry>
+ <entry>
+ Specifies the statement settings
+ </entry>
+ </row>
+ <row>
+ <entry><code>recovery</code></entry>
+ <entry>
+ Specifies the recovery settings
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Pool settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>min-pool-size</code></entry>
+ <entry>
+ The min-pool-size element indicates the minimum number of connections
+ a pool should hold. These are not created until a Subject is known from a
+ request for a connection. This default to 0
+ </entry>
+ </row>
+ <row>
+ <entry><code>max-pool-size</code></entry>
+ <entry>
+ The max-pool-size element indicates the maximum number of connections
+ for a pool. No more connections will be created in each sub-pool.
+ This defaults to 20
+ </entry>
+ </row>
+ <row>
+ <entry><code>prefill</code></entry>
+ <entry>
+ Whether to attempt to prefill the connection pool. Empty element denotes
+ a true value. Default is false
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-strict-min</code></entry>
+ <entry>
+ Define if the min-pool-size should be considered a strictly.
+ Default false
+ </entry>
+ </row>
+ <row>
+ <entry><code>flush-strategy</code></entry>
+ <entry>
+ Specifies how the pool should be flush in case of an error.
+ Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>XA pool settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>min-pool-size</code></entry>
+ <entry>
+ The min-pool-size element indicates the minimum number of connections
+ a pool should hold. These are not created until a Subject is known from a
+ request for a connection. This default to 0
+ </entry>
+ </row>
+ <row>
+ <entry><code>max-pool-size</code></entry>
+ <entry>
+ The max-pool-size element indicates the maximum number of connections
+ for a pool. No more connections will be created in each sub-pool.
+ This defaults to 20
+ </entry>
+ </row>
+ <row>
+ <entry><code>prefill</code></entry>
+ <entry>
+ Whether to attempt to prefill the connection pool. Empty element denotes
+ a true value. Default is false
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-strict-min</code></entry>
+ <entry>
+ Define if the min-pool-size should be considered a strictly.
+ Default false
+ </entry>
+ </row>
+ <row>
+ <entry><code>flush-strategy</code></entry>
+ <entry>
+ Specifies how the pool should be flush in case of an error.
+ Valid values are: FailingConnectionOnly (default), IdleConnections, EntirePool
+ </entry>
+ </row>
+ <row>
+ <entry><code>is-same-rm-override</code></entry>
+ <entry>
+ The is-same-rm-override element allows one to unconditionally
+ set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns
+ true or false
+ </entry>
+ </row>
+ <row>
+ <entry><code>interleaving</code></entry>
+ <entry>
+ An element to enable interleaving for XA connection factories
+ </entry>
+ </row>
+ <row>
+ <entry><code>no-tx-separate-pools</code></entry>
+ <entry>
+ 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
+ </entry>
+ </row>
+ <row>
+ <entry><code>pad-xid</code></entry>
+ <entry>
+ Should the Xid be padded
+ </entry>
+ </row>
+ <row>
+ <entry><code>wrap-xa-resource</code></entry>
+ <entry>
+ Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper
+ instance
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Security settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>user-name</code></entry>
+ <entry>
+ Specify the username used when creating a new connection.
+ </entry>
+ </row>
+ <row>
+ <entry><code>password</code></entry>
+ <entry>
+ Specify the password used when creating a new connection.
+ </entry>
+ </row>
+ <row>
+ <entry><code>security-domain</code></entry>
+ <entry>
+ Indicates Subject (from security domain) are used to distinguish connections in the pool.
+ The content of the security-domain is the name of the JAAS security manager that will handle
+ authentication. This name correlates to the JAAS login-config.xml descriptor
+ application-policy/name attribute.
+ </entry>
+ </row>
+ <row>
+ <entry><code>reauth-plugin</code></entry>
+ <entry>
+ Defines a reauthentication plugin that can be used for reauthentication of physical connections.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Validation settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>valid-connection-checker</code></entry>
+ <entry>
+ An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides
+ a SQLException isValidConnection(Connection e) method to validate is a connection
+ is valid. An exception means the connection is destroyed. This overrides
+ the check-valid-connection-sql when present
+ </entry>
+ </row>
+ <row>
+ <entry><code>check-valid-connection-sql</code></entry>
+ <entry>
+ Specify an SQL statement to check validity of a pool connection. This
+ may be called when managed connection is taken from pool for use.
+ </entry>
+ </row>
+ <row>
+ <entry><code>validate-on-match</code></entry>
+ <entry>
+ The validate-on-match element indicates whether or not connection
+ level validation should be done when a connection factory attempts to match
+ a managed connection for a given set. This is typically exclusive to the
+ use of background validation
+ </entry>
+ </row>
+ <row>
+ <entry><code>background-validation</code></entry>
+ <entry>
+ An element to specify that connections should be validated on a background
+ thread versus being validated prior to use
+ </entry>
+ </row>
+ <row>
+ <entry><code>background-validation-minutes</code></entry>
+ <entry>
+ The background-validation-minutes element specifies the amount of
+ time, in minutes, that background validation will run
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-fast-fail</code></entry>
+ <entry>
+ Whether fail a connection allocation on the first connection if it
+ is invalid (true) or keep trying until the pool is exhausted of all potential
+ connections (false) default false
+ </entry>
+ </row>
+ <row>
+ <entry><code>stale-connection-checker</code></entry>
+ <entry>
+ An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides
+ a boolean isStaleConnection(SQLException e) method which if it it returns
+ true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
+ which is a subclass of SQLException
+ </entry>
+ </row>
+ <row>
+ <entry><code>exception-sorter</code></entry>
+ <entry>
+ An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a
+ boolean isExceptionFatal(SQLException e) method to validate is an exception
+ should be broadcast to all javax.resource.spi.ConnectionEventListener as
+ a connectionErrorOccurred message
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Time out settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>blocking-timeout-millis</code></entry>
+ <entry>
+ The blocking-timeout-millis element indicates 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 30000 (30 seconds).
+ </entry>
+ </row>
+ <row>
+ <entry><code>idle-timeout-minutes</code></entry>
+ <entry>
+ The idle-timeout-minutes elements indicates the maximum time in minutes
+ a connection may be idle before being closed. The actual maximum time depends
+ also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes
+ of any pool.
+ </entry>
+ </row>
+ <row>
+ <entry><code>set-tx-query-timeout</code></entry>
+ <entry>
+ Whether to set the query timeout based on the time remaining until
+ transaction timeout, any configured query timeout will be used if there is
+ no transaction. The default is false
+ </entry>
+ </row>
+ <row>
+ <entry><code>query-timeout</code></entry>
+ <entry>
+ Any configured query timeout in seconds The default is no timeout
+ </entry>
+ </row>
+ <row>
+ <entry><code>use-try-lock</code></entry>
+ <entry>
+ Any configured timeout for internal locks on the resource adapter
+ objects in seconds The default is a 60 second timeout
+ </entry>
+ </row>
+ <row>
+ <entry><code>allocation-retry</code></entry>
+ <entry>
+ The allocation retry element indicates the number of times that allocating
+ a connection should be tried before throwing an exception. The default is 0.
+ </entry>
+ </row>
+ <row>
+ <entry><code>allocation-retry-wait-millis</code></entry>
+ <entry>
+ The allocation retry wait millis element indicates the time in milliseconds
+ to wait between retrying to allocate a connection. The default is 5000 (5 seconds).
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-resource-timeout</code></entry>
+ <entry>
+ Passed to XAResource.setTransactionTimeout() Default is zero which
+ does not invoke the setter. In seconds
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Statement settings</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>track-statements</code></entry>
+ <entry>
+ Whether to check for unclosed statements when a connection is returned
+ to the pool and result sets are closed when a statement is closed/return
+ to the prepared statement cache. valid values are: false - do not track statements
+ and results true - track statements and result sets and warn when they are
+ not closed nowarn - track statements but do no warn about them being unclosed
+ (the default)
+ </entry>
+ </row>
+ <row>
+ <entry><code>prepared-statement-cache-size</code></entry>
+ <entry>
+ The number of prepared statements per connection in an LRU cache
+ </entry>
+ </row>
+ <row>
+ <entry><code>share-prepared-statements</code></entry>
+ <entry>
+ Whether to share prepare statements, i.e. whether asking for same
+ statement twice without closing uses the same underlying prepared statement.
+ The default is false
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Recovery elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>recover-credential</code></entry>
+ <entry>
+ Specifies the user name / password pair or security domain that
+ should be used for recovery.
+ </entry>
+ </row>
+ <row>
+ <entry><code>recover-plugin</code></entry>
+ <entry>
+ Specifies an implementation of the org.jboss.jca.core.spi.recovery.RecoveryPlugin
+ class.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Driver attributes</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Attribute</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>name</code></entry>
+ <entry>
+ An unique name for the JDBC driver
+ </entry>
+ </row>
+ <row>
+ <entry><code>module</code></entry>
+ <entry>
+ The module definition for the JDBC driver. The format of a module inside
+ JBoss Application Server 7+ is <code>com.h2database.h2</code> which will
+ map to the H2 installation under <code>modules/com/h2database/h2/main</code>.
+ The format for IronJacamar Standalone/Embedded is the name of the .jar file
+ </entry>
+ </row>
+ <row>
+ <entry><code>major-version</code></entry>
+ <entry>
+ The major version of the driver
+ </entry>
+ </row>
+ <row>
+ <entry><code>minor-version</code></entry>
+ <entry>
+ The minor version of the driver
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table frame="all">
+ <title>Driver elements</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" colwidth="2*"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Element</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>driver-class</code></entry>
+ <entry>
+ The fully qualified class name of the driver class
+ </entry>
+ </row>
+ <row>
+ <entry><code>datasource-class</code></entry>
+ <entry>
+ The fully qualified class name of the datasource class
+ </entry>
+ </row>
+ <row>
+ <entry><code>xa-datasource-class</code></entry>
+ <entry>
+ The fully qualified class name of the XA datasource class
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The datasource deployment schema is defined in <code>doc/datasources_1_0.xsd</code>.</para>
+
+ </section>
+
+ <section id="deployingds_extensions">
+ <title>Datasource extensions</title>
+
+ <para>
+ The datasource deployments can make use of a couple of extensions in the JDBC resource adapter
+ to improve the connection validation and checking if an exception should reestablish
+ the connection in question.
+ </para>
+
+ <para>
+ The extensions include
+
+ <itemizedlist>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.spi.ExceptionSorter</code>: Plugin to check if a
+ <code>SQLException</code> is fatal for the connection on which it was thrown.
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.spi.StaleConnection</code>: Plugin to wrap stale
+ <code>SQLException</code>'s in a <code>org.jboss.jca.adapters.jdbc.StaleConnectionException</code>.
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.spi.ValidConnection</code>: Plugin to Check if a connection is
+ valid for use by the application.
+ </listitem>
+ </itemizedlist>
+
+ </para>
+
+ <para>
+ Configuration of the extensions are done by using
+
+ <itemizedlist>
+ <listitem>
+ The <code><exception-sorter></code> tag for an <code>ExceptionSorter</code>
+ </listitem>
+ <listitem>
+ The <code><stale-connection-checker></code> tag for a <code>StaleConnection</code>
+ </listitem>
+ <listitem>
+ The <code><valid-connection-checker></code> tag for a <code>ValidConnection</code>
+ </listitem>
+ </itemizedlist>
+
+ </para>
+
+ <para>
+ IronJacamar features implementations of these extensions for a couple of popular databases.
+ Contributions in this area are most welcome either generic solutions or for a specific database.
+ </para>
+
+ <para>
+ Informix:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.informix.InformixExceptionSorter</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ Microsoft SQLServer:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ PostgreSQL:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ MySQL:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLReplicationValidConnectionChecker</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ IBM DB2:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ Generic:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullStaleConnectionChecker</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.novendor.NullValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ Sybase:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ Oracle:
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker</code>
+ </listitem>
+ <listitem>
+ <code>org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker</code>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ </section>
+
+</chapter>
Deleted: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en-US/modules/introduction.xml 2011-11-30 14:53:53 UTC (rev 112489)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -1,198 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="introduction">
- <title>Introduction</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 id="whatsnew">
- <title>What's New</title>
-
- <para>The Java Connector Architecture 1.6 specification adds the following major areas:</para>
-
- <itemizedlist spacing="compact">
- <listitem>
- Ease of Development: The use of annotations reduces or completely eliminates the need to deal with a
- deployment descriptor in many cases. The use of annotations also reduces the need
- to keep the deployment descriptor synchronized with changes to source code.
- </listitem>
- <listitem>
- Generic work context contract: A generic contract that enables a resource adapter
- to control the execution context of a Work instance that it has submitted to the
- application server for execution.
- </listitem>
- <listitem>
- Security work context: A standard contract that enables a resource adapter to
- establish security information while submitting a Work instance for execution to a
- WorkManager and while delivering messages to message endpoints residing in
- the application server.
- </listitem>
- <listitem>
- Standalone Container Environment: A defined set of services that makes up a standalone
- execution environment for resource adapters.
- </listitem>
- </itemizedlist>
-
- </section>
-
- <section id="overview">
- <title>Overview</title>
-
- <para>
- The Java EE Connector Architecture features three different types of resource adapters
-
- <itemizedlist>
- <listitem>
- Outbound: The resource adapter allows the application to communicate to the Enterprise Information System (EIS).
- </listitem>
- <listitem>
- Inbound: The resource adapter allows messages to flow from the Enterprise Information System (EIS) to the application.
- </listitem>
- <listitem>
- Bi-directional: The resource adapter features both an outbound and an inbound part.
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- For more information about Java EE Connector Architecture see the specification.
- </para>
-
- <section id="overview_outbound">
- <title>Outbound resource adapter</title>
-
- <para>
- The Java Connector Architecture specification consists of a number of outbound components:
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/outbound.png" align="center"/>
- </imageobject>
- </mediaobject>
- </para>
-
- <para>
- The application uses the
-
- <itemizedlist>
- <listitem>
- ConnectionFactory: The connection factory is looked up in Java Naming and Directory Interface (JNDI)
- and is used to create a connection.
- </listitem>
- <listitem>
- Connection: The connection contains the Enterprise Information System (EIS) specific operations.
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- The resource adapter contains
-
- <itemizedlist>
- <listitem>
- ManagedConnectionFactory: The managed connection factory creates managed connections.
- </listitem>
- <listitem>
- ManagedConnection: The managed connection represents a physical connection to the target
- Enterprise Information System (EIS). The managed connection notfies the application server
- of events such as connection closed and connection error.
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- IronJacamar - the application server - contains
-
- <itemizedlist>
- <listitem>
- ConnectionManager: The connection manager handles all managed connections in regards to
- pooling, transaction and security.
- </listitem>
- <listitem>
- ConnectionEventListener: The connection event listener allows the connection manager to know
- the status of each managed connection.
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section id="overview_inbound">
- <title>Inbound resource adapter</title>
-
- <para>
- The Java Connector Architecture specification consists of a number of inbound components:
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/inbound.png" align="center"/>
- </imageobject>
- </mediaobject>
- </para>
-
- <para>
- The application uses the
-
- <itemizedlist>
- <listitem>
- ActivationSpec: The activation specification specifies the different properties that the
- application is looking for from the resource adapter and hence the Enterprise Information System (EIS).
- This specification can be hidden from the user by a facade provided by the application server.
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- The resource adapter contains
-
- <itemizedlist>
- <listitem>
- ResourceAdapter: The resource adapter provides the activation point for inbound communication.
- </listitem>
- <listitem>
- Resource adapter specific: The resource adapter specific code handles communication with the
- Enterprise Information System (EIS) and deliver messages through the MessageEndpointFactory.
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- IronJacamar - the application server - contains
-
- <itemizedlist>
- <listitem>
- MessageEndpointFactory: The MessageEndpointFactory is registered with the ResourceAdapter instance
- and creates the MessageEndpoint instances.
- </listitem>
- <listitem>
- MessageEndpoint: The MessageEndpoint contains the actual message from the Enterprise Information System (EIS)
- which the application uses. This could for example be a message driven Enterprise JavaBean (EJB/MDB).
- </listitem>
- </itemizedlist>
- </para>
-
- </section>
-
- </section>
-
-
-</chapter>
Copied: projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml (from rev 112490, projects/jboss-jca/trunk/doc/userguide/en-US/modules/introduction.xml)
===================================================================
--- projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml (rev 0)
+++ projects/jboss-jca/tags/IRONJACAMAR_1_1_0_ALPHA4/doc/userguide/en-US/modules/introduction.xml 2011-11-30 15:29:38 UTC (rev 112492)
@@ -0,0 +1,198 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="introduction">
+ <title>Introduction</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 id="whatsnew">
+ <title>What's New</title>
+
+ <para>The Java Connector Architecture 1.6 specification adds the following major areas:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Ease of Development: The use of annotations reduces or completely eliminates the need to deal with a
+ deployment descriptor in many cases. The use of annotations also reduces the need
+ to keep the deployment descriptor synchronized with changes to source code.
+ </listitem>
+ <listitem>
+ Generic work context contract: A generic contract that enables a resource adapter
+ to control the execution context of a Work instance that it has submitted to the
+ application server for execution.
+ </listitem>
+ <listitem>
+ Security work context: A standard contract that enables a resource adapter to
+ establish security information while submitting a Work instance for execution to a
+ WorkManager and while delivering messages to message endpoints residing in
+ the application server.
+ </listitem>
+ <listitem>
+ Standalone Container Environment: A defined set of services that makes up a standalone
+ execution environment for resource adapters.
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
+ <section id="overview">
+ <title>Overview</title>
+
+ <para>
+ The Java EE Connector Architecture features three different types of resource adapters
+
+ <itemizedlist>
+ <listitem>
+ Outbound: The resource adapter allows the application to communicate to the Enterprise Information System (EIS).
+ </listitem>
+ <listitem>
+ Inbound: The resource adapter allows messages to flow from the Enterprise Information System (EIS) to the application.
+ </listitem>
+ <listitem>
+ Bi-directional: The resource adapter features both an outbound and an inbound part.
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ For more information about Java EE Connector Architecture see the specification.
+ </para>
+
+ <section id="overview_outbound">
+ <title>Outbound resource adapter</title>
+
+ <para>
+ The Java Connector Architecture specification consists of a number of outbound components:
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/outbound.png" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+
+ <para>
+ The application uses the
+
+ <itemizedlist>
+ <listitem>
+ ConnectionFactory: The connection factory is looked up in Java Naming and Directory Interface (JNDI)
+ and is used to create a connection.
+ </listitem>
+ <listitem>
+ Connection: The connection contains the Enterprise Information System (EIS) specific operations.
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ The resource adapter contains
+
+ <itemizedlist>
+ <listitem>
+ ManagedConnectionFactory: The managed connection factory creates managed connections.
+ </listitem>
+ <listitem>
+ ManagedConnection: The managed connection represents a physical connection to the target
+ Enterprise Information System (EIS). The managed connection notifies the application server
+ of events such as connection closed and connection error.
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ IronJacamar - the application server - contains
+
+ <itemizedlist>
+ <listitem>
+ ConnectionManager: The connection manager handles all managed connections in regards to
+ pooling, transaction and security.
+ </listitem>
+ <listitem>
+ ConnectionEventListener: The connection event listener allows the connection manager to know
+ the status of each managed connection.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="overview_inbound">
+ <title>Inbound resource adapter</title>
+
+ <para>
+ The Java Connector Architecture specification consists of a number of inbound components:
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/inbound.png" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+
+ <para>
+ The application uses the
+
+ <itemizedlist>
+ <listitem>
+ ActivationSpec: The activation specification specifies the different properties that the
+ application is looking for from the resource adapter and hence the Enterprise Information System (EIS).
+ This specification can be hidden from the user by a facade provided by the application server.
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ The resource adapter contains
+
+ <itemizedlist>
+ <listitem>
+ ResourceAdapter: The resource adapter provides the activation point for inbound communication.
+ </listitem>
+ <listitem>
+ Resource adapter specific: The resource adapter specific code handles communication with the
+ Enterprise Information System (EIS) and deliver messages through the MessageEndpointFactory.
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ IronJacamar - the application server - contains
+
+ <itemizedlist>
+ <listitem>
+ MessageEndpointFactory: The MessageEndpointFactory is registered with the ResourceAdapter instance
+ and creates the MessageEndpoint instances.
+ </listitem>
+ <listitem>
+ MessageEndpoint: The MessageEndpoint contains the actual message from the Enterprise Information System (EIS)
+ which the application uses. This could for example be a message driven Enterprise JavaBean (EJB/MDB).
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ </section>
+
+
+</chapter>
More information about the jboss-cvs-commits
mailing list