[jboss-cvs] JBossAS SVN: r103329 - in projects/jboss-jca/tags: JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Mar 31 09:43:40 EDT 2010
Author: jesper.pedersen
Date: 2010-03-31 09:43:40 -0400 (Wed, 31 Mar 2010)
New Revision: 103329
Added:
projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/
projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml
projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml
Removed:
projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml
projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml
Log:
JBoss JCA 1.0.0.Alpha10
Copied: projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10 (from rev 103316, projects/jboss-jca/trunk)
Deleted: projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml 2010-03-31 12:36:27 UTC (rev 103316)
+++ projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml 2010-03-31 13:43:40 UTC (rev 103329)
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="about">
- <title>About JBoss JCA</title>
-
- <para>The goal of the JBoss JCA project is to provide an implementation of the Java Connector
- Architecture 1.6 specification.</para>
-
- <para>The specification can be found here: <ulink url="http://www.jcp.org/en/jsr/detail?id=322">http://www.jcp.org/en/jsr/detail?id=322</ulink>.</para>
-
- <section id="theteam">
- <title>The team</title>
-
- <para>Jesper Pedersen acts as the lead for the JBoss JCA project. He can be reached at jesper (dot) pedersen (at) jboss (dot) org.</para>
-
- <para>Jeff Zhang is a core developer on the JBoss JCA project. He can be reached at jizhang (at) redhat (dot) com.</para>
-
- <para>Gurkan Erdogdu is a core developer on the JBoss JCA project. He can be reached at gurkanerdogdu (at) yahoo (dot) com.</para>
-
- </section>
-
- <section id="thanksto">
- <title>Thanks to</title>
-
- <para>
- Dimitris Andreadis, Carlo de Wolf, Jason Green, Jonathan Halliday, Vicky Kak,
- Sacha Labourey, Alexey Loubyansky, Patrick MacDonald, Stefano Maestri, Andrig Miller,
- Andrew Lee Rubinger, Anil Saldhana and Scott Stark.
- </para>
-
- <para>And a special thanks goes to Adrian Brock and Ales Justin for their continuous support of this project.</para>
-
- </section>
-
-</chapter>
Copied: projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml (from rev 103328, projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml)
===================================================================
--- projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml (rev 0)
+++ projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/about.xml 2010-03-31 13:43:40 UTC (rev 103329)
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="about">
+ <title>About JBoss JCA</title>
+
+ <para>The goal of the JBoss JCA project is to provide an implementation of the Java Connector
+ Architecture 1.6 specification.</para>
+
+ <para>The specification can be found here: <ulink url="http://www.jcp.org/en/jsr/detail?id=322">http://www.jcp.org/en/jsr/detail?id=322</ulink>.</para>
+
+ <section id="theteam">
+ <title>The team</title>
+
+ <para>Jesper Pedersen acts as the lead for the JBoss JCA project. He can be reached at jesper (dot) pedersen (at) jboss (dot) org.</para>
+
+ <para>Jeff Zhang is a core developer on the JBoss JCA project. He can be reached at jizhang (at) redhat (dot) com.</para>
+
+ <para>Gurkan Erdogdu is a core developer on the JBoss JCA project. He can be reached at gurkanerdogdu (at) yahoo (dot) com.</para>
+
+ <para>Stefano Maestri is a core developer on the JBoss JCA project. He can be reached at stefano.maestri (at) javalinux (dot) it.</para>
+
+ </section>
+
+ <section id="thanksto">
+ <title>Thanks to</title>
+
+ <para>
+ Dimitris Andreadis, Carlo de Wolf, Jason Green, Jonathan Halliday, Vicky Kak,
+ Sacha Labourey, Alexey Loubyansky, Patrick MacDonald, Andrig Miller,
+ Andrew Lee Rubinger, Anil Saldhana and Scott Stark.
+ </para>
+
+ <para>And a special thanks goes to Adrian Brock and Ales Justin for their continuous support of this project.</para>
+
+ </section>
+
+</chapter>
Deleted: projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/validator.xml 2010-03-31 12:36:27 UTC (rev 103316)
+++ projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml 2010-03-31 13:43:40 UTC (rev 103329)
@@ -1,111 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="validator">
- <title>Validator</title>
-
- <section id="validator_introduction">
- <title>Introduction</title>
-
- <para>The JBoss JCA container features a validator which checks resource adapter archives
- against the Java Connector Architecture (JCA) specification.</para>
-
- <para>The validator works by doing a static analysis of the resource adapter classes
- and checks them against the rules defined in the validator.</para>
-
- <para>The validator is used in the deployer chain of the JCA container, and is available
- as a standalone tool too.</para>
- </section>
-
- <section id="validator_reports">
- <title>Reports</title>
-
- <para>The validator works by scanning the resource adapter in question and output
- a report which lists which rules have been violated.</para>
-
- <para>An example could be</para>
-
- <programlisting>
-Severity: ERROR
-Section: 19.4.2
-Description: A ResourceAdapter must implement a "public int hashCode()" method.
-Code: com.mycompany.myproject.ResourceAdapterImpl
-
-Severity: ERROR
-Section: 19.4.2
-Description: A ResourceAdapter must implement a "public boolean equals(Object)" method.
-Code: com.mycompany.myproject.ResourceAdapterImpl
- </programlisting>
-
- <para>which means that <code>com.mycompany.myproject.ResourceAdapterImpl</code> is missing
- an <code>equals</code> and <code>hashCode</code> implementation.</para>
-
- <table frame="all">
- <title>Validator report</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">Key</entry>
- <entry align="left">Desciption</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><code>Severity</code></entry>
- <entry>
- Specifies the severity of the rule.
- <para>
- <itemizedlist spacing="compact">
- <listitem>
- ERROR: Critical error which must be fixed in order for the
- resource adapter to operate correctly.
- </listitem>
- <listitem>
- WARN: Error which should be fixed in order for the
- resource adapter to operate correctly.
- </listitem>
- </itemizedlist>
- </para>
- </entry>
- </row>
- <row>
- <entry><code>Section</code></entry>
- <entry>
- A reference to a section in the Java Connector Architecture specification
- where the requirement is defined.
- </entry>
- </row>
- <row>
- <entry><code>Descrption</code></entry>
- <entry>
- A short description of the rule.
- </entry>
- </row>
- <row>
- <entry><code>Code</code></entry>
- <entry>
- The class which triggered the rule.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- </section>
-
- <section id="validator_running">
- <title>Running the standalone validator</title>
-
- <para>The validator can be run on the command line by</para>
-
- <programlisting>
-java -jar jboss-jca-validator.jar <file>
- </programlisting>
-
- <para>The reports will be generated into the current directory under the name of
- <code><file>.log</code>.</para>
-
- </section>
-
-
-</chapter>
Copied: projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml (from rev 103326, projects/jboss-jca/trunk/doc/userguide/en/modules/validator.xml)
===================================================================
--- projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml (rev 0)
+++ projects/jboss-jca/tags/JBOSS_JCA_1_0_0_ALPHA10/doc/userguide/en/modules/validator.xml 2010-03-31 13:43:40 UTC (rev 103329)
@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="validator">
+ <title>Validator</title>
+
+ <section id="validator_introduction">
+ <title>Introduction</title>
+
+ <para>The JBoss JCA container features a validator which checks resource adapter archives
+ against the Java Connector Architecture (JCA) specification.</para>
+
+ <para>The validator is doing a static analysis of the resource adapter classes
+ and checks them against the rules defined in the validator.</para>
+
+ <para>The validator is used in the deployer chain of the JCA container, and is available
+ as a standalone tool and an Apache Ant too.</para>
+ </section>
+
+ <section id="validator_reports">
+ <title>Reports</title>
+
+ <para>The validator works by scanning the resource adapter in question and output
+ a report which lists which rules have been violated.</para>
+
+ <para>An example could be</para>
+
+ <programlisting>
+Severity: ERROR
+Section: 19.4.2
+Description: A ResourceAdapter must implement a "public int hashCode()" method.
+Code: com.mycompany.myproject.ResourceAdapterImpl
+
+Severity: ERROR
+Section: 19.4.2
+Description: A ResourceAdapter must implement a "public boolean equals(Object)" method.
+Code: com.mycompany.myproject.ResourceAdapterImpl
+ </programlisting>
+
+ <para>which means that <code>com.mycompany.myproject.ResourceAdapterImpl</code> is missing
+ an <code>equals</code> and <code>hashCode</code> implementation.</para>
+
+ <table frame="all">
+ <title>Validator report</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">Key</entry>
+ <entry align="left">Desciption</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>Severity</code></entry>
+ <entry>
+ Specifies the severity of the rule.
+ <para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ ERROR: Critical error which must be fixed in order for the
+ resource adapter to operate correctly.
+ </listitem>
+ <listitem>
+ WARN: Error which should be fixed in order for the
+ resource adapter to operate correctly.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry><code>Section</code></entry>
+ <entry>
+ A reference to a section in the Java Connector Architecture specification
+ where the requirement is defined.
+ </entry>
+ </row>
+ <row>
+ <entry><code>Descrption</code></entry>
+ <entry>
+ A short description of the rule.
+ </entry>
+ </row>
+ <row>
+ <entry><code>Code</code></entry>
+ <entry>
+ The class which triggered the rule.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section id="validator_standalone">
+ <title>Running the standalone validator</title>
+
+ <para>The validator can be run on the command line by</para>
+
+ <programlisting>
+java -jar jboss-jca-validator.jar <file>
+ </programlisting>
+
+ <para>The reports will be generated into the current directory under the name of
+ <code><file>.log</code>.</para>
+
+ </section>
+
+ <section id="validator_ant">
+ <title>Apache Ant integration</title>
+
+ <para>The validator integrates with Apache Ant such that you can generate the reports directly from
+ your build environment before deploying the resoruce adapter into the JBoss JCA container.</para>
+
+ <para>First you have to define the <code>taskdef</code> for the task</para>
+
+ <programlisting>
+<taskdef name="validator"
+ classname="org.jboss.jca.validator.ant.ValidatorTask"
+ classpathref="jbossjca.lib.path.id"/>
+ </programlisting>
+
+ <para>See the Apache Ant documentation for additional instructions on installation.</para>
+
+ <section id="validator_ant_usage">
+ <title>Usage</title>
+
+ <programlisting>
+<validator rarFile="${myArchive.rar}" outputDir="${report.dir}"/>
+ </programlisting>
+
+ <table frame="all">
+ <title>Apache Ant: validator</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="5*"/>
+ <thead>
+ <row>
+ <entry align="left">Key</entry>
+ <entry align="left">Value</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><code>rarFile</code></entry>
+ <entry>
+ The resource adapter file
+ </entry>
+ </row>
+ <row>
+ <entry><code>outputDir</code></entry>
+ <entry>
+ The directory where the reports should be generated
+ </entry>
+ </row>
+ <row>
+ <entry><code>classpath</code></entry>
+ <entry>
+ A classpath to resolve additional dependencies against
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ </section>
+
+</chapter>
More information about the jboss-cvs-commits
mailing list