[jboss-cvs] JBossAS SVN: r90636 - in projects/jboss-jca/trunk/doc/userguide/en: modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri Jun 26 11:06:11 EDT 2009
Author: jesper.pedersen
Date: 2009-06-26 11:06:11 -0400 (Fri, 26 Jun 2009)
New Revision: 90636
Added:
projects/jboss-jca/trunk/doc/userguide/en/modules/community.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/download.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/running.xml
Removed:
projects/jboss-jca/trunk/doc/userguide/en/modules/gettingstarted.xml
Modified:
projects/jboss-jca/trunk/doc/userguide/en/master.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/configuration.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/installation.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/introduction.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml
Log:
first pass of the users guide
Modified: projects/jboss-jca/trunk/doc/userguide/en/master.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/master.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/master.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -3,9 +3,12 @@
"../../../tools/docbook/support/docbook-dtd/docbookx.dtd" [
<!ENTITY about SYSTEM "modules/about.xml">
<!ENTITY introduction SYSTEM "modules/introduction.xml">
- <!ENTITY gettingstarted SYSTEM "modules/gettingstarted.xml">
+ <!ENTITY download SYSTEM "modules/download.xml">
<!ENTITY nc_installation SYSTEM "modules/installation.xml">
<!ENTITY configuration SYSTEM "modules/configuration.xml">
+ <!ENTITY deployment SYSTEM "modules/deployment.xml">
+ <!ENTITY running SYSTEM "modules/running.xml">
+ <!ENTITY community SYSTEM "modules/community.xml">
<!ENTITY troubleshooting SYSTEM "modules/troubleshooting.xml">
]>
<book lang="en">
@@ -22,12 +25,18 @@
&introduction;
- &gettingstarted;
+ &download;
&nc_installation;
&configuration;
+ &deployment;
+
+ &running;
+
+ &community;
+
&troubleshooting;
</book>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -1,4 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="about">
- <title>About JBoss JCA</title>
+ <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>
+
+ </section>
+
+ <section id="thanksto">
+ <title>Thanks to</title>
+
+ <para>
+ Dimitris Andreadis, Carlo de Wolf, Jason Green, Jonathan Halliday, Vicky Kak,
+ Alexey Loubyansky, Patrick MacDonald, Andrig Miller,
+ Sacha Labourey, 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>
Added: projects/jboss-jca/trunk/doc/userguide/en/modules/community.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/community.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/community.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="community">
+ <title>Community</title>
+
+ <section id="website">
+ <title>Website</title>
+
+ <para>The website contains the latest information about the project and links to important information.</para>
+
+ <para>The website is located at <ulink url="http://www.jboss.org/jca/">http://www.jboss.org/jca/</ulink></para>
+
+ </section>
+
+ <section id="userforum">
+ <title>User forum</title>
+
+ <para>The user forum is where we discuss matters about the usage of the JBoss JCA project.</para>
+
+ <para>Our forum is located at <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=136">http://www.jboss.org/index.html?module=bb&op=viewforum&f=136</ulink></para>
+
+ </section>
+
+ <section id="developerforum">
+ <title>Developer forum</title>
+
+ <para>The developer forum is where we discuss the implementation of the JBoss JCA project. This means the internals of the project and
+ not how the project is used.</para>
+
+ <para>User questions doesn't belong here - they should go in the user forum instead.</para>
+
+ <para>The forum is located at <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=165">http://www.jboss.org/index.html?module=bb&op=viewforum&f=165</ulink></para>
+
+ </section>
+
+ <section id="issuetracking">
+ <title>Issue tracking</title>
+
+ <para>We are using JIRA to manage our issues in the project.</para>
+
+ <para>These are divided into the following categories</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Feature Request: A feature that you would like see implemented.
+ </listitem>
+ <listitem>
+ Bug: A software defect.
+ </listitem>
+ </itemizedlist>
+
+ <para>For all of these you should post your request to our user forum first.</para>
+
+ <para>The rest of the categories are for team use only.</para>
+
+ <para>Our issue tracking system located at <ulink url="https://jira.jboss.org/jira/browse/JBJCA">https://jira.jboss.org/jira/browse/JBJCA</ulink></para>
+
+ </section>
+
+</chapter>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/configuration.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/configuration.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/configuration.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -2,4 +2,41 @@
<chapter id="configuration">
<title>Configuration</title>
+ <para>The configuration for the JBoss JCA container is located in the config/ directory.</para>
+
+ <section id="logging">
+ <title>Logging service</title>
+
+ <para>The JBoss JCA container uses JBoss Logging and the Apache Log4J framework as the implementation.</para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+config/log4j.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <para>Consult the Apache Log4J documentation on how the service can be configured.</para>
+
+ </section>
+
+ <section id="transaction">
+ <title>Transaction service</title>
+
+ <para>The JBoss JCA container uses the JBoss Transaction Manager as its transaction implementation.</para>
+
+ <para>The configuration is done in the</para>
+
+ <programlisting>
+config/jbossts-properties.xml
+ </programlisting>
+
+ <para>file.</para>
+
+ <para>Consult the JBoss Transaction documentation on how the service can be configured.</para>
+
+ </section>
+
+
</chapter>
Added: projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/deployment.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="deployment">
+ <title>Deployment</title>
+
+ <para>The JBoss JCA distribution contains a deploy/ directory where all deployments
+ should be deployed to.</para>
+
+ <section id="deployingrar">
+ <title>Deploying resource adapters</title>
+
+ <para>Resource adapters (.rar) are deployed by copying the resource adapters into the
+ deploy/ directory</para>
+
+ <programlisting>
+cp example.rar jboss-jca-1.0.0/deploy
+ </programlisting>
+
+ <para>on a Un*x based system or</para>
+
+ <programlisting>
+copy example.rar jboss-jca-1.0.0\deploy
+ </programlisting>
+
+ <para>on Windows.</para>
+
+ </section>
+
+</chapter>
Copied: projects/jboss-jca/trunk/doc/userguide/en/modules/download.xml (from rev 90535, projects/jboss-jca/trunk/doc/userguide/en/modules/gettingstarted.xml)
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/download.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/download.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="gettingstarted">
+ <title>Download</title>
+ <para>The official JBoss JCA project page is <ulink
+ url="http://www.jboss.org/jca/">http://www.jboss.org/jca/</ulink> where you can download the software.</para>
+
+ <section id="download">
+ <title>Download</title>
+
+ <para>The download location is zone: <ulink url="http://www.jboss.org/jca/downloads/">http://www.jboss.org/jca/downloads/</ulink></para>
+
+ <para>Each release is labelled with a version number and an identifier.</para>
+
+ <programlisting>
+jboss-jca-<major>.<minor>.<patch>[.<identifier>]
+ </programlisting>
+
+ <para>where</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ Major: The major version number. Signifies major changes in the implementation.
+ </listitem>
+ <listitem>
+ Minor: The minor version number. Signifies functional changes to a major version.
+ </listitem>
+ <listitem>
+ Patch: The patch version number. Signifies a binary compatible change to a minor version.
+ </listitem>
+ <listitem>
+ Identifier: The identifier. Identifies the level of the quality of the release.
+ <itemizedlist spacing="compact">
+ <listitem>
+ None / GA: Stable release
+ </listitem>
+ <listitem>
+ CR: Candidate for Release quality. The implementation is functional complete.
+ </listitem>
+ <listitem>
+ Beta: Beta quality. The implementation is almost functional complete.
+ </listitem>
+ <listitem>
+ Alpha: Alpha quality. The implementation is a snapshot of the development.
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para>An example</para>
+
+ <programlisting>
+jboss-jca-1.0.0.tar.gz
+ </programlisting>
+
+ <para>which is the first stable release of the project.</para>
+
+ </section>
+
+ <section id="SVN">
+ <title>SVN Access</title>
+ <para>If you want to experiment with the latest developments you may
+ checkout the latest code from SVN trunk. Be aware that the
+ information provided in this manual might then not be accurate.</para>
+
+ <para>The anonymous SVN repository is located under:</para>
+
+ <programlisting>
+svn co http://anonsvn.jboss.org/repos/jbossas/projects/jboss-jca/trunk/ jbossjca-trunk
+ </programlisting>
+
+ <para>You can find additional information about this in the developer guide.</para>
+
+ </section>
+</chapter>
Property changes on: projects/jboss-jca/trunk/doc/userguide/en/modules/download.xml
___________________________________________________________________
Name: svn:mergeinfo
+
Deleted: projects/jboss-jca/trunk/doc/userguide/en/modules/gettingstarted.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/gettingstarted.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/gettingstarted.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="gettingstarted">
- <title>Download Software</title>
- <para>The official JBoss JCA project page is <ulink
- url="http://www.jboss.org/jbossjca/">http://www.jboss.org/jbossjca/</ulink>.</para>
- <para>The download location is
- zone: <ulink
- url="http://www.jboss.org/jbossjca/downloads/">http://www.jboss.org/jbossjca/downloads/</ulink></para>
- <section id="SVN">
- <title>SVN Access</title>
- <para>If you want to experiment with the latest developments you may
- checkout the latest code from SVN trunk. Be aware that the
- information provided in this manual might then not be accurate.</para>
- </section>
-</chapter>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/installation.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/installation.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/installation.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -2,4 +2,73 @@
<chapter id="installation">
<title>Installation</title>
+ <para>Once you have downloaded the distribution you need to install it in a location of your choice.</para>
+
+ <section id="installtargz">
+ <title>Compressed Tape Archive (.tar.gz)</title>
+
+ <para>Extract the distribution using</para>
+
+ <programlisting>
+tar xzf jboss-jca-1.0.0.tar.gz
+ </programlisting>
+
+ <para>The distribution will be located in a directory named</para>
+
+ <programlisting>
+jboss-jca-1.0.0
+ </programlisting>
+
+ </section>
+
+ <section id="installzip">
+ <title>Zip Archive (.zip)</title>
+
+ <para>Extract the distribution using</para>
+
+ <programlisting>
+unzip jboss-jca-1.0.0.tar.gz
+ </programlisting>
+
+ <para>or any program capable of handling Zip archives such as WinZip and WinRar.</para>
+
+ <para>The distribution will be located in a directory named</para>
+
+ <programlisting>
+jboss-jca-1.0.0
+ </programlisting>
+
+ </section>
+
+ <section id="directorystructure">
+ <title>Directory structure</title>
+
+ <para>The JBoss JCA container has the following directory structure:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ bin: Contains the scripts that starts the container.
+ </listitem>
+ <listitem>
+ config: Contains the configuration of the container.
+ </listitem>
+ <listitem>
+ deploy: Contains user deployments.
+ </listitem>
+ <listitem>
+ doc: Contains the documentation.
+ </listitem>
+ <listitem>
+ lib: Contains all the libraries needed by the container.
+ </listitem>
+ <listitem>
+ log: Contains the log files for the container.
+ </listitem>
+ <listitem>
+ tmp: Contains temporary files.
+ </listitem>
+ </itemizedlist>
+
+ </section>
+
</chapter>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/introduction.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/introduction.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/introduction.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -2,4 +2,58 @@
<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),
+ database 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 submiting 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>
+
+
</chapter>
Added: projects/jboss-jca/trunk/doc/userguide/en/modules/running.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/running.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/running.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="running">
+ <title>Running</title>
+
+ <section id="startingthecontainer">
+ <title>Starting the container</title>
+
+ <para>The JBoss JCA container is started by entering the bin/ directory</para>
+
+ <programlisting>
+cd jboss-jca-1.0.0/bin
+ </programlisting>
+
+ <para>and executing</para>
+
+ <programlisting>
+./run.sh
+ </programlisting>
+
+ <para>on a Un*x based system or</para>
+
+ <programlisting>
+run.bat
+ </programlisting>
+
+ <para>on Windows.</para>
+
+ <para>Once the container has started you should see a log entry like</para>
+
+ <programlisting>
+13:33:10,999 INFO [Main] Server started in 1192ms
+ </programlisting>
+
+ <para>in the console where the command was executed.</para>
+
+ </section>
+
+
+</chapter>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml 2009-06-26 14:36:03 UTC (rev 90635)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml 2009-06-26 15:06:11 UTC (rev 90636)
@@ -1,5 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="troubleshooting">
<title>Troubleshooting</title>
+
+ <section id="ithinkihavefoundabug">
+ <title>I think I have found a bug</title>
+
+ <para>If you think you have found a bug you should verify this by posting to our forum first.</para>
+
+ <para>Our forum is located at <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=136">http://www.jboss.org/index.html?module=bb&op=viewforum&f=136</ulink></para>
+
+ <para>You can also search our issue tracking system located at <ulink url="https://jira.jboss.org/jira/browse/JBJCA">https://jira.jboss.org/jira/browse/JBJCA</ulink></para>
+
+ </section>
+
+ <section id="howdoi">
+ <title>How do I ?</title>
+
+ <para>We can't cover every single issue in this guide, so feel free to drop by our forums to see if a solution
+ has already been provided. Otherwise feel free to ask your question there.</para>
+
+ <para>Our forum is located at <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=136">http://www.jboss.org/index.html?module=bb&op=viewforum&f=136</ulink></para>
+
+ </section>
+
</chapter>
More information about the jboss-cvs-commits
mailing list