[jboss-cvs] JBossAS SVN: r86125 - in projects/jboss-jca/trunk/doc: developerguide/en and 3 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Mar 19 15:46:41 EDT 2009
Author: jesper.pedersen
Date: 2009-03-19 15:46:41 -0400 (Thu, 19 Mar 2009)
New Revision: 86125
Added:
projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml
Removed:
projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml
Modified:
projects/jboss-jca/trunk/doc/developerguide/build.xml
projects/jboss-jca/trunk/doc/developerguide/en/master.xml
projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml
projects/jboss-jca/trunk/doc/userguide/build.xml
projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml
Log:
A bit about the metadata
Modified: projects/jboss-jca/trunk/doc/developerguide/build.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/build.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/developerguide/build.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -9,9 +9,19 @@
<antcall target="lang.all"><param name="lang" value="en"/></antcall>
</target>
- <target name="html.doc" description="creates the html docs only and opens a browser">
+ <target name="pdf">
<mkdir dir="en/images" />
+ <antcall target="lang.docpdf"><param name="lang" value="en"/></antcall>
+ </target>
+
+ <target name="html">
+ <mkdir dir="en/images" />
<antcall target="lang.dochtml"><param name="lang" value="en"/></antcall>
</target>
+ <target name="htmlsingle">
+ <mkdir dir="en/images" />
+ <antcall target="lang.dochtmlsingle"><param name="lang" value="en"/></antcall>
+ </target>
+
</project>
Modified: projects/jboss-jca/trunk/doc/developerguide/en/master.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/master.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/developerguide/en/master.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
"../../../tools/docbook/support/docbook-dtd/docbookx.dtd" [
- <!ENTITY about SYSTEM "modules/about.xml">
+ <!ENTITY about SYSTEM "../../userguide/en/modules/about.xml">
+ <!ENTITY introduction SYSTEM "../../userguide/en/modules/introduction.xml">
<!ENTITY building SYSTEM "modules/building.xml">
<!ENTITY testing SYSTEM "modules/testing.xml">
<!ENTITY metadata SYSTEM "modules/metadata.xml">
+ <!ENTITY deployers SYSTEM "modules/deployers.xml">
]>
<book lang="en">
<bookinfo>
@@ -18,10 +20,14 @@
&about;
+ &introduction;
+
&building;
&testing;
&metadata;
+ &deployers;
+
</book>
Deleted: projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/about.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="about">
- <title>About JBoss JCA</title>
-</chapter>
Added: projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml (rev 0)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/deployers.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="deployers">
+ <title>Deployers</title>
+
+ <section id="rardeployer">
+ <title>RAR Deployer</title>
+
+ </section>
+
+ <section id="dsdeployer">
+ <title>DataSource Deployer</title>
+
+ </section>
+</chapter>
Modified: projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/metadata.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -1,4 +1,115 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="metadata">
<title>Metadata</title>
+
+ <section id="coremetadata">
+ <title>Core Metadata</title>
+ <para>The metadata for the JBoss JCA project is split up into the following areas</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Java Connector Architecture Metadata</para>
+ </listitem>
+ <listitem>
+ <para>JBoss Metadata</para>
+ </listitem>
+ <listitem>
+ <para>DataSource Metadata</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The implementation of these areas is done in the JBoss Metadata (JBMETA) project, which is a common
+ project for all metadata inside JBoss.</para>
+
+ <para>The issue tracking system for JBoss Metadata is located here: <ulink url="https://jira.jboss.org/jira/browse/JBMETA"/>.</para>
+
+ <section id="jcametadata">
+ <title>Java Connector Architecture Metadata</title>
+ <para>The Java Connector Architecture (JCA) metadata implement the metadata defined in the JCA specifications.
+ We have metadata representing the following standards:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Java Connector Architecture 1.0</para>
+ </listitem>
+ <listitem>
+ <para>Java Connector Architecture 1.5</para>
+ </listitem>
+ <listitem>
+ <para>Java Connector Architecture 1.6</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>These metadata versions have a common super class</para>
+ <programlisting>
+org.jboss.metadata.rar.spec.ConnectorMetaData
+ </programlisting>
+ <para>which allow the developer to for example query the version of the metadata.</para>
+
+ <para>The metadata is part of the</para>
+ <programlisting>
+org.jboss.metadata.rar.jboss.RARDeploymentMetaData
+ </programlisting>
+ <para>structure.</para>
+
+ </section>
+
+ <section id="jbossmetadata">
+ <title>JBoss Metadata</title>
+ <para>The JBoss metadata implement JBoss specific extensions to the standard Java Connector Architecture
+ metadata. We have metadata representing:</para>
+
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>JBoss RA 1.0</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The metadata can be found in:</para>
+ <programlisting>
+org.jboss.metadata.rar.jboss.JBossRAMetaData
+ </programlisting>
+
+ <para>The metadata is part of the</para>
+ <programlisting>
+org.jboss.metadata.rar.jboss.RARDeploymentMetaData
+ </programlisting>
+ <para>structure.</para>
+
+ </section>
+
+ <section id="datasourcemetadata">
+ <title>DataSource Metadata</title>
+ <para>TODO</para>
+
+ </section>
+
+ </section>
+
+ <section id="metadatarepository">
+ <title>Metadata Repository</title>
+ <para>The metadata repository serves as a central point for all the metadata in the systems.</para>
+
+ <section id="mdrinterface">
+ <title>Interface</title>
+ <para>The interface of the metadata repository is located in:</para>
+ <programlisting>
+org.jboss.jca.core.api.MetaDataRepository
+ </programlisting>
+ <para>providing methods to query and update the repository.</para>
+ </section>
+
+ <section id="mdrbean">
+ <title>Bean</title>
+ <para>The JBoss Microcontainer bean for the metadata repository can be defined as:</para>
+ <programlisting>
+<bean name="MetaDataRepository"
+ interface="org.jboss.jca.core.api.MetaDataRepository"
+ class="org.jboss.jca.core.mdr.MetaDataRepositoryImpl">
+</bean>
+ </programlisting>
+ </section>
+
+
+ </section>
</chapter>
Modified: projects/jboss-jca/trunk/doc/userguide/build.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/build.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/userguide/build.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -9,9 +9,19 @@
<antcall target="lang.all"><param name="lang" value="en"/></antcall>
</target>
- <target name="html.doc" description="creates the html docs only and opens a browser">
+ <target name="pdf">
<mkdir dir="en/images" />
+ <antcall target="lang.docpdf"><param name="lang" value="en"/></antcall>
+ </target>
+
+ <target name="html">
+ <mkdir dir="en/images" />
<antcall target="lang.dochtml"><param name="lang" value="en"/></antcall>
</target>
+ <target name="htmlsingle">
+ <mkdir dir="en/images" />
+ <antcall target="lang.dochtmlsingle"><param name="lang" value="en"/></antcall>
+ </target>
+
</project>
Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml 2009-03-19 19:40:55 UTC (rev 86124)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/about.xml 2009-03-19 19:46:41 UTC (rev 86125)
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="about">
- <title>About JBoss JCA 1.0</title>
+ <title>About JBoss JCA</title>
</chapter>
More information about the jboss-cvs-commits
mailing list