[jboss-cvs] JBossAS SVN: r67558 - in projects/docs/trunk/Getting_Started: en-US and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Nov 28 08:54:21 EST 2007
Author: skittoli at redhat.com
Date: 2007-11-28 08:54:21 -0500 (Wed, 28 Nov 2007)
New Revision: 67558
Modified:
projects/docs/trunk/Getting_Started/Makefile
projects/docs/trunk/Getting_Started/en-US/About_the_Example_Applications.xml
projects/docs/trunk/Getting_Started/en-US/Book_Info.xml
projects/docs/trunk/Getting_Started/en-US/Introduction.xml
projects/docs/trunk/Getting_Started/en-US/Preface.xml
projects/docs/trunk/Getting_Started/en-US/Revision_History.xml
projects/docs/trunk/Getting_Started/en-US/Server_Configurations.xml
projects/docs/trunk/Getting_Started/en-US/Start_Stop_Server.xml
projects/docs/trunk/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
projects/docs/trunk/Getting_Started/en-US/Using_Other_Databases.xml
projects/docs/trunk/Getting_Started/en-US/Using_Seam.xml
Log:
updates
Modified: projects/docs/trunk/Getting_Started/Makefile
===================================================================
--- projects/docs/trunk/Getting_Started/Makefile 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/Makefile 2007-11-28 13:54:21 UTC (rev 67558)
@@ -6,27 +6,9 @@
DOCNAME = Getting_Started
SYSTEM = JBoss_Application_Server
-OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
+OTHER_LANGS = de-DE es-ES fr-FR ja-JP pt-BR zh-CN
+#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
TRANSLATIONS = $(XML_LANG) $(OTHER_LANGS)
-COMMON_CONFIG = ./Common_Config
-COMMON_CONTENT = ./Common_Content
-include $(COMMON_CONFIG)/Makefile.common
-
-CVS_REPO = :pserver:anonymous at anoncvs.forge.jboss.com:/cvsroot/jboss
-CVS_TAG = HEAD
-CVS_DIR = jboss-docs/gettingstarted/docbook/en
-LOCAL_DIR = tmp
-MASTER_FILE = master.xml
-SED = sed -i -e 's/\(<\!-- DOCTYPE\)/<?xml version="1.0" standalone="no"?>\n<\!DOCTYPE book PUBLIC "-\/\/OASIS\/\/DTD DocBook XML V4.3\/\/EN" "http\:\/\/www.oasis-open.org\/docbook\/xml\/4.3\/docbookx.dtd" [\n<\!ENTITY \% RH-ENTITIES SYSTEM "Common_Config\/rh-entities.ent">\n\%RH-ENTITIES;\n] >\n\1/g'
-
-resynch::
- export XMLLINT_INDENT=" "
- cd $(XML_LANG) && cvs -d $(CVS_REPO) co -d $(LOCAL_DIR) -r $(CVS_TAG) $(CVS_DIR)
- cd $(XML_LANG) && cp -r $(LOCAL_DIR)/images .
- $(SED) $(XML_LANG)/$(LOCAL_DIR)/$(MASTER_FILE)
- cd $(XML_LANG) && xmllint --xinclude --postvalid --format --nsclean --output $(DOCNAME).xml --encode UTF-8 $(LOCAL_DIR)/$(MASTER_FILE)
-
-clean::
- rm -rf $(XML_LANG)/$(LOCAL_DIR) tmp
-
+COMMON_CONFIG = /usr/share/documentation-devel
+include $(COMMON_CONFIG)/make/Makefile.common
Modified: projects/docs/trunk/Getting_Started/en-US/About_the_Example_Applications.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/About_the_Example_Applications.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/About_the_Example_Applications.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -5,7 +5,7 @@
<chapter id="About_the_Example_Applications">
<title>About the Example Applications</title>
<para>
- In this guide, we make use of a simple web application to illustrate the use of JSF-EJB3 components. We then illustrate how to use Seam to integrate the JSF and EJB3 components. The example applications (source code) come with this guide and you can find them located in the <filename class="directory">JBOSS_DIST/doc/examples</filename> directory. You can also download the sample applications from <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>. We use two examples in this book:
+ In this guide, we make use of a simple web application to show the use of JSF-EJB3 components. We then illustrate how to use Seam to integrate the JSF and EJB3 components. The example applications (source code) come with this guide and you can find them located in the <filename class="directory">JBOSS_DIST/doc/examples</filename> directory. You can also download the sample applications from <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>. We use two examples in this book:
<itemizedlist>
<listitem>
<para>A simple "TODO" application to create, view and edit tasks - implemented using JSF and EJB3;
@@ -18,7 +18,7 @@
</para>
<para>
- If you installed the documentation on your hard drive, then the first example can be found in the <filename class="directory">JBOSS_DIST/doc/examples/jsfejb3</filename> directory. We will see how to build this example using the <filename>build.xml</filename> file present here and also how to deploy the application. We will also cover in detail the working of the .java, .xml and .properties files.
+ If you installed the documentation on your hard drive, then the first example can be found in the <filename class="directory">JBOSS_DIST/doc/examples/jsfejb3</filename> directory (if you download the examples the path is: <filename class="directory">gettingstarted/jsfejb3</filename>). We will see how to build this example using the <filename>build.xml</filename> file present here and also how to deploy the application. We will also cover in detail the workings of the .java, .xml and .properties files.
</para>
<para>
The second example used in this guide can be found in the <filename class="directory">JBOSS_DIST/doc/examples/seamejb3</filename> directory. Using a simple "TODO" application we will illustrate how Seam ties together the database, the web interface and the EJB3 business logic in a web application. We will use the <filename>build.xml</filename> file present here to compile and build our Seam application.
Modified: projects/docs/trunk/Getting_Started/en-US/Book_Info.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Book_Info.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Book_Info.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -7,12 +7,9 @@
<subtitle>Getting Started Guide</subtitle>
<issuenum>4.2</issuenum>
<productnumber>2</productnumber>
- <pubdate>Sep, 2007</pubdate>
- <isbn>N/A</isbn>
- <abstract><para>The <citetitle>Getting Started Guide</citetitle> provides post-installation information about JBoss Application Server. Use this guide to familiarise yourself with the platform and the sample applications that demonstrate application development and deployment.</para></abstract>
- <copyright>
- <year>2007</year>
- <holder>Red Hat, Inc.</holder>
- </copyright>
+ <pubdate>Nov, 2007</pubdate>
+<subtitle>Authors</subtitle>
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
</bookinfo>
Modified: projects/docs/trunk/Getting_Started/en-US/Introduction.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Introduction.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Introduction.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -5,25 +5,18 @@
<chapter id="Introduction">
<title>Introduction</title>
<para>
- &JBEAP; is easy to install and you can have it running in a few easy steps. Refer to the <emphasis>&JBEAP;: Installation Guide</emphasis> for information on pre-requisites for installation and the detailed installation steps.
+ JBoss Application Server is easy to install and you can have it running in a few easy steps. Refer to the <ulink url="http://labs.jboss.com/file-access/default/members/jbossas/freezone/docs/Installation_Guide/beta422/html/index.html">JBoss Application Server: Installation Guide</ulink> for information on pre-requisites for installation and the detailed installation steps.
</para>
<para>
- Once you have &JBEAP; installed, use this guide to familiarize yourself with its layout and the example applications that demonstrate application development and deployment.
+ Once you have JBoss Application Server installed, use this guide to familiarize yourself with its layout and the example applications that demonstrate application development and deployment.
</para>
<section id="Introduction-Feedback">
<title>Feedback</title>
<para>
- If you spot a typo in the <emphasis>&JBEAP;: Getting Started Guide</emphasis>, or if you have thought of a way to make this manual better, we would love to hear from you! Submit a report in <ulink url="http://bugzilla.redhat.com/bugzilla/">Bugzilla</ulink> against the Product: &JBEAP;, Version: 4.2.0, Component: Getting_Started_Guide. If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the section number and some of the surrounding text so we can find it easily.
+ If you find a typographical error in the <emphasis>JBoss Application Server: Getting Started Guide</emphasis>, or if you have thought of a way to make this manual better, we would love to hear from you! Submit a report in <ulink url="http://bugzilla.redhat.com/bugzilla/">Bugzilla</ulink> against the Product: JBoss Application Server, Version: 4.2.2, Component: Getting_Started_Guide. If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the section number and some of the surrounding text so we can find it easily.
</para>
</section>
- <section id="Introduction-Other_Manuals">
- <title>Other Manuals</title>
- <para>
- If you are looking for detailed product information refer to the manuals available online at <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>.
- </para>
- </section>
-
</chapter>
Modified: projects/docs/trunk/Getting_Started/en-US/Preface.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Preface.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Preface.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -6,11 +6,11 @@
<preface id="Book-Preface">
<title>Introduction</title>
<para>
- &JBEAP; is easy to install and you can have it running in a few easy steps. Refer to the <emphasis>&JBEAP;: Installation Guide</emphasis> for information on pre-requisites for installation and the detailed installation steps.
+ JBoss Enterprise Application Platform is easy to install and you can have it running in a few easy steps. Refer to the <emphasis>JBoss Enterprise Application Platform: Installation Guide</emphasis> for information on pre-requisites for installation and the detailed installation steps.
</para>
<para>
- Once you have &JBEAP; installed, use this guide to familiarize yourself with its layout and the example applications that demonstrate application development and deployment.
+ Once you have JBoss Enterprise Application Platform installed, use this guide to familiarize yourself with its layout and the example applications that demonstrate application development and deployment.
</para>
<xi:include href="Software_Versions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: projects/docs/trunk/Getting_Started/en-US/Revision_History.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Revision_History.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Revision_History.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -9,7 +9,7 @@
<author>
<firstname>Michael</firstname>
<surname>Hideo</surname>
- <email>mhideo at redhat.com</email>
+ <email></email>
</author>
<revdescription>
<simplelist>
@@ -18,5 +18,21 @@
</simplelist>
</revdescription>
</revision>
+ <revision>
+ <revnumber>4.2.2</revnumber>
+ <date>Nov 28 2007</date>
+ <author>
+ <firstname>Samson</firstname>
+ <surname>Kittoli</surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Updated Content from tech review.</member>
+
+ </simplelist>
+ </revdescription>
+ </revision>
+
</revhistory>
Modified: projects/docs/trunk/Getting_Started/en-US/Server_Configurations.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Server_Configurations.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Server_Configurations.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -8,13 +8,13 @@
Fundamentally, the JBoss architecture consists of the JMX MBean server, the microkernel, and a set of pluggable component services - the MBeans. This makes it easy to assemble different configurations and gives you the flexibility to tailor them to meet your requirements.
</para>
<para>
- You don’t have to run a large, monolithic server all the time; you can remove the components you don’t need (which can also reduce the server startup time considerably) and you can also integrate additional services into JBoss by writing your own MBeans. You certainly don’t need to do this to be able to run standard J2EE applications though. Everything you need is already there.
+ You don’t have to run a large, monolithic server all the time; you can remove the components you don’t need (which can also reduce the server startup time considerably) and you can also integrate additional services into JBoss by writing your own MBeans. You certainly do not need to do this to be able to run standard J2EE applications though.
</para>
<para>
You don’t need a detailed understanding of JMX to use JBoss, but it’s worth keeping a picture of this basic architecture in mind as it is central to the way JBoss works.
</para>
<para>
- The JBoss Enterprise Application Platform ships with four different server configurations. Within the <literal>JBOSS_DIST/jboss-as/server</literal> directory, you will find four subdirectories: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal> and <literal>all</literal> - one for each server configuration. Each of these configurations provide a different set of services. The <literal>production</literal> configuration is the one used if you don’t specify another one when starting up the server.
+ The JBoss Enterprise Application Platform ships with four different server configurations. Within the <literal>JBOSS_DIST/jboss-as/server</literal> directory, you will find four subdirectories: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal> and <literal>all</literal> - one for each server configuration. Each of these configurations provide a different set of services. The <literal>default</literal> configuration is the one used if you don’t specify another one when starting up the server.
</para>
<para>
<variablelist>
@@ -30,7 +30,7 @@
<term>default</term>
<listitem>
<para>
- is a base J2EE 1.4 server profile containing a default set of services. It has the most frequently used services required to deploy a J2EE application. It does not include the JAXR service, the IIOP service, or any of the clustering services. Please note that although this configuration is called "default", the actual default configuration for the server is the "production" configuration.
+ is a base J2EE 1.4 server profile containing a default set of services. It has the most frequently used services required to deploy a J2EE application. It does not include the JAXR service, the IIOP service, or any of the clustering services.
</para>
</listitem>
</varlistentry>
@@ -38,18 +38,11 @@
<term>all</term>
<listitem>
<para>
- on the other hand has all the services configured to launch every single component. This is a full J2EE 1.4 server profile with enterprise extensions such as Clustering and RMI/IIOP.
+ The all configuration starts all the available services. This includes the RMI/IIOP and clustering services, which aren’t loaded in the default configuration.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>production</term>
- <listitem>
- <para>
- is based on the "all" profile, tuned for production; with log verbosity reduced, deployment scanning every 60 seconds, and memory usage tuned to accomodate production deployment requirements, among other things. This is the configuration that will be used by the server when it is started, if no other configuration is specified.
- </para>
- </listitem>
- </varlistentry>
+
</variablelist>
</para>
<para>
@@ -65,7 +58,7 @@
</para>
<note>
<para>
- The <emphasis role="bold">production</emphasis> configuration is the one used if you don’t specify another one when starting up the server.
+ The <emphasis role="bold">default</emphasis> configuration is the one used if you don’t specify another one when starting up the server.
</para>
<para>
To start the server using an alternate configuration refer to <xref linkend="Starting_and_Stopping_the_Server-Start_the_Server_With_Alternate_Configuration" />.
@@ -130,7 +123,7 @@
<filename class="directory">log</filename>
</entry>
<entry>
- This is where the log files are written. JBoss uses the Jakarta <literal>log4j</literal> package for logging and you can also use it directly in your own applications from within the server. This may be overridden through the <filename class="directory">conf/</filename><filename>log4j.xml</filename> configuration file.
+ This is where the log files are written. JBoss uses the Jakarta <literal>log4j</literal> package for logging and you can also use it directly in your own applications from within the server. This may be overridden through the <filename class="directory">conf/</filename><filename>jboss-log4j.xml</filename> configuration file.
</entry>
</row>
<row>
@@ -841,7 +834,7 @@
You can add your own configurations too. The best way to do this is to copy an existing one that is closest to your needs and modify the contents. For example, if you weren’t interested in using messaging, you could copy the <literal>production</literal> directory, renaming it as <literal>myconfig</literal>, remove the <literal>jms</literal> subdirectory and then start JBoss with the new configuration.
</para>
<programlisting>
-run -c <emphasis role="bold">myconfig</emphasis>
+./run.sh -c <emphasis role="bold">myconfig</emphasis>
</programlisting>
</section>
</section>
\ No newline at end of file
Modified: projects/docs/trunk/Getting_Started/en-US/Start_Stop_Server.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Start_Stop_Server.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Start_Stop_Server.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -2,7 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
-<!--<chapter id="Starting_and_Stopping_the_Server">-->
+
<section id="Starting_and_Stopping_the_Server">
<title>Starting and Stopping the Server</title>
<section id="Starting_and_Stopping_the_Server-Start_the_Server">
@@ -10,46 +10,23 @@
<para>
Move to <filename class="directory">JBOSS_DIST/jboss-as/bin</filename> directory and execute the <literal>run.bat</literal> (for Windows) or <literal>run.sh</literal> (for Linux) script, as appropriate for your operating system. Your output should look like the following (accounting for installation directory differences) and contain no error or exception messages:
</para>
-<programlisting>[jwulf at thinkpad bin]$ ./run.sh
+<programlisting>[user at mypc bin]$ ./run.sh
=========================================================================
JBoss Bootstrap Environment
- JBOSS_HOME: /home/jwulf/jboss-eap-4.2/jboss-as
+ JBOSS_HOME: /home/user/jboss-as-4.2.2/jboss-as
JAVA: java
JAVA_OPTS: -Dprogram.name=run.sh -server -Xms1503m -Xmx1503m -Dsun.rmi.dgc.client.
gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv4Stack=true
- CLASSPATH: /home/jwulf/jboss-eap-4.2/jboss-as/bin/run.jar
+ CLASSPATH: /home/user/jboss-as-4.2.2/jboss-as/bin/run.jar
=========================================================================
-13:11:46,215 INFO [Server] Starting JBoss (MX MicroKernel)...
-13:11:46,217 INFO [Server] Release ID: JBoss [EAP] 4.2.0.GA (build:
-SVNTag=JBoss_4_2_0_GA date=200706111042)
-13:11:46,218 INFO [Server] Home Dir: /home/jwulf/jboss-eap-4.2/jboss-as
-13:11:46,219 INFO [Server] Home URL: file:/home/jwulf/jboss-eap-4.2/jboss-as/
-13:11:46,220 INFO [Server] Patch URL: null
-13:11:46,225 INFO [Server] Server Name: production
-13:11:46,225 INFO [Server] Server Home Dir:
-/home/jwulf/jboss-eap-4.2/jboss-as/server/production
-13:11:46,225 INFO [Server] Server Home URL:
-file:/home/jwulf/jboss-eap-4.2/jboss-as/server/production/
-13:11:46,225 INFO [Server] Server Log Dir:
-/home/jwulf/jboss-eap-4.2/jboss-as/server/production/log
-13:11:46,226 INFO [Server] Server Temp Dir:
-/home/jwulf/jboss-eap-4.2/jboss-as/server/production/tmp
-13:11:46,226 INFO [Server] Root Deployment Filename: jboss-service.xml
-13:11:47,071 INFO [ServerInfo] Java version: 1.5.0_11,Sun Microsystems Inc.
-13:11:47,071 INFO [ServerInfo] Java VM:
-Java HotSpot(TM) Server VM 1.5.0_11-b03,Sun Microsystems Inc.
-13:11:47,072 INFO [ServerInfo] OS-System: Linux 2.6.21-1.3228.rhel5,i386
-13:11:48,558 INFO [Server] Core system initialized
-13:11:56,934 INFO [WebService] Using RMI server codebase: http://127.0.0.1:8083/
-13:11:56,940 INFO [Log4jService$URLWatchTimerTask]
-Configuring from URL: resource:jboss-log4j.xml</programlisting>
+</programlisting>
<note>
<para>
Note that there is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile, which is the default profile used when no other is specified. This message may be observed in the <filename>server.log</filename> file located in the <filename class="directory">server/production/log</filename> subdirectory.
@@ -60,13 +37,13 @@
<section id="Starting_and_Stopping_the_Server-Start_the_Server_With_Alternate_Configuration">
<title>Start the Server With Alternate Configuration</title>
<para>
- Using <literal>run.sh</literal> without any arguments starts the server using the <literal>production</literal> server configuration file set. To start with an alternate configuration file set, pass the name of the server configuration file set [same as the name of the server configuration directory under <literal>JBOSS_DIST/jboss-as/server</literal>] that you want to use, as the value to the <literal>-c</literal> command line option. For example, to start with the <literal>minimal</literal> configuration file set you should specify:
+ Using <literal>run.sh</literal> without any arguments starts the server using the <literal>default</literal> server configuration file set. To start with an alternate configuration file set, pass the name of the server configuration file set [same as the name of the server configuration directory under <literal>JBOSS_DIST/jboss-as/server</literal>] that you want to use, as the value to the <literal>-c</literal> command line option. For example, to start with the <literal>minimal</literal> configuration file set you should specify:
</para>
<programlisting>[bin]$ ./run.sh -c minimal
...
...
...
-15:05:40,301 INFO [Server] JBoss (MX MicroKernel) [4.2.0.GA (build: SVNTag=JBoss_4_2_0_GA date=200706111042)] Started in 5s:75ms
+15:05:40,301 INFO [Server] JBoss (MX MicroKernel) [4.2.2 (build: SVNTag=JBoss_4_2_2 date=200711111042)] Started in 5s:75ms
</programlisting>
</section>
Modified: projects/docs/trunk/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -4,16 +4,23 @@
<chapter id="The_JBoss_Server___A_Quick_Tour">
<title>The JBoss Server - A Quick Tour</title>
+
+<section><title>Server Structure</title>
+
<para>
- Let's explore the &JBEAP; directory structure and help you understand how the installation is laid out and what goes where. It’s worth familiarizing yourself with the layout, locations of the key configuration files, log files, deployment and so on. It will help you understand the JBoss service architecture so that you’ll be able to find your way around when it comes to deploying your own applications.
+ Now that you’ve downloaded JBoss and have run the server for the first time, the next thing you will want to know is how the installation is laid out and what goes where. At first glance there seems to be a lot of stuff in there, and it’s not obvious what you need to look at and what you can safely ignore for the time being. To remedy that, we’ll explore the server directory structure, locations of the key configuration files, log files, deployment and so on. It’s worth familiarizing yourself with the layout at this stage as it will help you understand the JBoss service architecture so that you’ll be able to find your way around when it comes to deploying your own applications.
</para>
+
<!-- Embedded sections -->
- <xi:include href="Directory_Structure.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
<xi:include href="Server_Configurations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Start_Stop_Server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- end embedded sections -->
+
+</section>
+
<section id="The_JBoss_Server___A_Quick_Tour-The_JMX_Console">
<title>The JMX Console</title>
<para>
@@ -92,7 +99,7 @@
In JBoss <literal>log4j</literal> is used for logging. If you are not familiar with the <literal>log4j</literal> package and would like to use it in your applications, you can read more about it at the Jakarta web site (<ulink url="http://jakarta.apache.org/log4j/"></ulink>).
</para>
<para>
- Logging is controlled from a central <filename>conf/log4j.xml</filename> file. This file defines a set of appenders specifying the log files, what categories of messages should go there, the message format and the level of filtering. By default, JBoss produces output to both the console and a log file (<filename>server.log</filename> in the <filename class="directory">log</filename> directory).
+ Logging is controlled from a central <filename>conf/jboss-log4j.xml</filename> file. This file defines a set of appenders specifying the log files, what categories of messages should go there, the message format and the level of filtering. By default, JBoss produces output to both the console and a log file (<filename>log/server.log</filename>).
</para>
<para>
There are 5 basic log levels used: <literal>DEBUG</literal>, <literal>INFO</literal>, <literal>WARN</literal>, <literal>ERROR</literal> and <literal>FATAL</literal>. The logging threshold on the console is <literal>INFO</literal>, which means that you will see informational messages, warning messages and error messages on the console but not general debug messages. In contrast, there is no threshold set for the <filename>server.log</filename> file, so all generated logging messages will be logged there.
@@ -109,7 +116,7 @@
This limits the level of logging to <literal>INFO</literal> for all JBoss classes, apart from those which have more specific overrides provided. If you were to change this to <literal>DEBUG</literal>, it would produce much more detailed logging output.
</para>
<para>
- As another example, let’s say you wanted to set the output from the container-managed persistence engine to <literal>DEBUG</literal> level and to redirect it to a separate file, <filename>cmp.log</filename>, in order to analyze the generated SQL commands. You would add the following code to the <filename>log4j.xml</filename> file:
+ As another example, let’s say you wanted to set the output from the container-managed persistence engine to <literal>DEBUG</literal> level and to redirect it to a separate file, <filename>cmp.log</filename>, in order to analyze the generated SQL commands. You would add the following code to the <filename>conf/jboss-log4j.xml</filename> file:
</para>
<programlisting><appender name="CMP" class="org.jboss.logging.appender.RollingFileAppender">
<errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"/>
@@ -139,10 +146,10 @@
<section id="Basic_Configuration_Issues-Security_Service">
<title>Security Service</title>
<para>
- The security domain information is stored in the file <filename>login-config.xml</filename> as a list of named security domains, each of which specifies a number of JAAS <footnote><para>
+ The security domain information is stored in the file <filename>conf/login-config.xml</filename> as a list of named security domains, each of which specifies a number of JAAS <footnote><para>
The Java Authentication and Authorization Service. JBoss uses JAAS to provide pluggable authentication modules. You can use the ones that are provided or write your own if you have more specific requirements.
</para>
- </footnote> login modules which are used for authentication purposes in that domain. When you want to use security in an application, you specify the name of the domain you want to use in the application’s JBoss-specific deployment descriptors, <filename>jboss.xml</filename> and/or <filename>jboss-web.xml</filename>. We will quickly look at how to do this to secure the JMX Console application.
+ </footnote> login modules which are used for authentication purposes in that domain. When you want to use security in an application, you specify the name of the domain you want to use in the application’s JBoss-specific deployment descriptors, <filename>jboss.xml</filename> (used in defining jboss specific configurations for an enterprise application) and/or <filename>jboss-web.xml</filename> (used in defining jboss for a Web application. We'll quickly look at how to do this to secure the JMX Console application that ship with JBoss.
</para>
<para>
Almost every aspect of the JBoss server can be controlled through the JMX Console, so it is important to make sure that, at the very least, the application is password protected. Otherwise, any remote user could completely control your server. To protect it, we will add a security domain to cover the application. <footnote><para>
@@ -201,7 +208,7 @@
</programlisting>
</para>
<para>
- This configuration uses a simple file based security policy. The configuration files are found in the <filename class="directory">conf/props</filename> directory of your server configuration. The usernames and passwords are stored in the <literal>conf/props/jmx-console-users.properties</literal> file and take the form "<literal>username=password</literal>". To assign a user to the <literal>JBossAdmin</literal> group add "<literal>username=JBossAdmin</literal>" to the <literal>jmx-console-roles.properties</literal> file. The existing file creates an <literal>admin</literal> user with the password <literal>admin</literal>. For security, please either remove the user or change the password to a stronger one.
+ This configuration uses a simple file based security policy. The configuration files are found in the <filename class="directory">conf/props</filename> directory of your server configuration. The usernames and passwords are stored in the <literal>conf/props/jmx-console-users.properties</literal> file and take the form "<literal>username=password</literal>". To assign a user to the <literal>JBossAdmin</literal> group add "<literal>username=JBossAdmin</literal>" to the <literal>jmx-console-roles.properties</literal> file (additional roles on that username can be added comma separated). The existing file creates an <literal>admin</literal> user with the password <literal>admin</literal>. For security, please either remove the user or change the password to a stronger one.
</para>
<para>
JBoss will re-deploy the JMX Console whenever you update its <filename>web.xml</filename>. You can check the server console to verify that JBoss has seen your changes. If you have configured everything correctly and re-deployed the application, the next time you try to access the JMX Console, it will ask you for a name and password. <footnote><para>
@@ -210,7 +217,7 @@
</footnote>
</para>
<para>
- The JMX Console isn't the only web based management interface to JBoss. There is also the Web Console. Although it's a Java applet, the corresponding web application can be secured in the same way as the JMX Console. The Web Console is in the file <filename>deploy/management/web-console.war</filename>. The only difference is that the Web Console is provided as a simple WAR file instead of using the exploded directory structure that the JMX Console did. The only real difference between the two is that editing the files inside the WAR file is a bit more cumbersome.
+ The JMX Console isn't the only web based management interface to JBoss. There is also the Web Console. Although it's a Java applet, the corresponding web application can be secured in the same way as the JMX Console. The Web Console is in the file <filename>deploy/management/console-mgr.sar/web-console.war.</filename>. The only difference is that the Web Console is provided as a simple WAR file instead of using the exploded directory structure that the JMX Console did. The only real difference between the two is that editing the files inside the WAR file is a bit more cumbersome.
</para>
</section>
@@ -229,7 +236,7 @@
<section id="The_JBoss_Server___A_Quick_Tour-The_Web_Container___Tomcat">
<title>The Web Container - Tomcat</title>
<para>
- JBoss Enterprise Application Platform comes with Tomcat as the default web container. The embedded Tomcat service is found in the <filename class="directory">deploy/jboss-web.deployer</filename> directory. All the necessary jar files needed by Tomcat can be found in there, as well as a <filename>web.xml</filename> file which provides a default configuration set for web applications.
+ JBoss Application Server comes with Tomcat as the default web container. The embedded Tomcat service is the expanded <filename class="directory">deploy/jboss-web.deployer</filename>. All the necessary jar files needed by Tomcat can be found in there, as well as a <filename>web.xml</filename> (under the ROOT.war/WEB-INF) file which provides a default configuration set for web applications.
</para>
<para>
If you are already familiar with configuring Tomcat, have a look at the <filename>server.xml</filename>, which contains a subset of the standard Tomcat format configuration information. As it stands, this includes setting up the HTTP connector on the default port 8080, an AJP connector on port 8009 (can be used if you want to connect via a web server such as Apache) and an example of how to configure an SSL connector (commented out by default).
Modified: projects/docs/trunk/Getting_Started/en-US/Using_Other_Databases.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Using_Other_Databases.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Using_Other_Databases.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -5,19 +5,32 @@
<chapter id="Using_other_Databases">
<title>Using other Databases</title>
<para>
- In the previous chapters, we’ve just been using the JBoss default datasource in our applications. This is provided by the embedded HSQL database instance and is bound to the JNDI name <literal>java:/DefaultDS</literal>. Having a database included with JBoss is very convenient for running examples and HSQL is adequate for many purposes. However, at some stage you will want to use another database, either to replace the default datasource or to access multiple databases from within the server.
+ In the previous chapters, we’ve just been using the JBossAS default datasource in our applications. This datasource is configured to use the embedded Hypersonic database instance shipped by default with the distribution. This datasource is bound to the JNDI name <literal>java:/DefaultDS</literal> and its descriptor is named <literal>hsqldb-ds.xml</literal> under the deploy directory
</para>
+ <para>
+ Having a database included with JBossAS is very convenient for running the server and examples out-of-the-box . However, this database is not a production quality database and as such should not be used with enterprise-class deployments. As a consequence of this JBoss Support does not provide any official support for Hypersonic.
+ </para>
+ <para>
+ In this chapter we will explain in details how to configure and deploy a datasource to connect JBossAS to the most popular database servers available on the market today.
+ </para>
+
<section id="Using_other_Databases-DataSource_Configuration_Files">
<title>DataSource Configuration Files</title>
<para>
- DataSource configuration file names end with the suffix <literal>-ds.xml</literal> so that they will be recognized correctly by the JCA deployer. The <literal>docs/example/jca </literal> directory contains sample files for a wide selection of databases and it is a good idea to use one of these as a starting point. For a full description of the configuration format the best place to look is the DTD file <literal>docs/dtd/jboss-ds_1_5.dtd</literal>. Additional documentation on the files and the JBoss JCA implementation can also be found in the <emphasis>JBoss 4 Application Server Guide</emphasis>.
+ Datasource configuration file names end with the suffix <literal>-ds.xml</literal> so that they will be recognized correctly by the JCA deployer. The <literal>docs/example/jca</literal> directory contains sample files for a wide selection of databases and it is a good idea to use one of these as a starting point. For a full description of the configuration format, the best place to look is the DTD file <literal>docs/dtd/jboss-ds_1_5.dtd</literal>. Additional documentation on the files and the JBoss JCA implementation can also be found in the JBoss Application Server Guide available at <ulink url="http://labs.jboss.com/projects/docs/"/>.
</para>
+
<para>
Local transaction datasources are configured using the <literal>local-tx-datasource</literal> element and XA-compliant ones using <literal>xa-tx-datasource</literal>. The example file <literal>generic-ds.xml</literal> shows how to use both types and also some of the other elements that are available for things like connection pool configuration. Examples of both local and XA configurations are available for Oracle, DB2 and Informix.
</para>
+
+
+
<para>
If you look at the example files <literal> firebird-ds.xml</literal>, <literal> facets-ds.xml</literal> and <literal>sap3-ds.xml</literal>, you’ll notice that they have a completely different format, with the root element being <literal>connection-factories</literal> rather than <literal>datasources</literal>. These use an alternative, more generic JCA configuration syntax used with a pre-packaged JCA resource adapter. The syntax is not specific to datasource configuration and is used, for example, in the <literal>jms-ds.xml</literal> file to configure the JMS resource adapter.
</para>
+ <para>We would also highly recommend consulting the JCA wiki pages at http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossJCA
+ </para>
<para>
Next, we’ll work through some step-by-step examples to illustrate what’s involved setting up a datasource for a specific database.
</para>
@@ -26,221 +39,291 @@
<section id="Using_other_Databases-Using_MySQL_as_the_Default_DataSource">
<title>Using MySQL as the Default DataSource</title>
<para>
- MySQL is a one of the most popular open source databases around and is used by many prominent organizations from Yahoo to NASA. The official JDBC driver for it is called <emphasis>Connector/J</emphasis>. For this example we’ve used MySQL 4.1.7 and Connector/J 3.0.15. You can download them both from <ulink url="http://www.mysql.com"></ulink> .
+ The MySQL® database has become the world's most popular open source database thanks to its consistent fast performance, high reliability and ease of use. This database server is used in millions of installations ranging from large corporations to specialized embedded applications across every continent of the world. . In this section, we'll be using the community version of their database server (GA 5.0.45) and the latest JDBC driver (GA 5.1.5) both available at <ulink url="http://www.mysql.com"></ulink>.
</para>
- <section id="Using_MySQL_as_the_Default_DataSource-Creating_a_Database_and_User">
- <title>Creating a Database and User</title>
+
+
+
+
+
+
+ <section id="Using_MySQL_as_the_Default_DataSource-Installing_the_JDBC_Driver_and_Deploying_the_DataSource">
+ <title>Installing the JDBC Driver and Deploying the datasource</title>
+
<para>
- We’ll assume that you’ve already installed MySQL and that you have it running and are familiar with the basics. Run the <literal>mysql</literal> client program from the command line so we can execute some administration commands. You should make sure that you are connected as a user with sufficient privileges (e.g. by specifying the <literal>-u root</literal> option to run as the MySQL root user).
+ To make the JDBC driver classes available to the JBoss Application Server, copy the archive <literal>mysql-mysql-connector-java-5.1.5-bin.jar</literal> from the Connector/J distribution to the <literal>lib</literal> directory in the <literal>default</literal> server configuration (assuming that is the server configuration you’re running).
</para>
<para>
- First create a database called <literal>jboss</literal> within MySQL for use by JBoss.
+ Then create a text file in the deploy directory called mysql-ds.xml with the following datasource descriptor:
</para>
-<programlisting>mysql> CREATE DATABASE jboss;
-Query OK, 1 row affected (0.05 sec)
+
+<programlisting> <![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<datasources>
+ <local-tx-datasource>
+ <jndi-name>DefaultDS</jndi-name>
+ <connection-url>jdbc:mysql://localhost:3306/test</connection-url>
+ <driver-class>com.mysql.jdbc.Driver</driver-class>
+ <user-name>root</user-name>
+ <password>jboss</password>
+ <valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker</valid-connection-checker-class-name>
+ <metadata>
+ <type-mapping>mySQL</type-mapping>
+ </metadata>
+ </local-tx-datasource>
+</datasources>
+]]>
</programlisting>
- <para>
- Then check that it has been created.
- </para>
-<programlisting>mysql> SHOW DATABASES;
-+----------+
-| Database |
-+----------+
-| jboss |
-| mysql |
-| test |
-+----------+
-3 rows in set (0.00 sec)
-</programlisting>
- <para>
- Next, create a user called <literal>jboss</literal> with password <literal>password</literal> to access the database.
- </para>
-<programlisting>mysql> GRANT ALL PRIVILEGES ON jboss.* TO jboss at localhost IDENTIFIED BY 'password';
-Query OK, 0 rows affected (0.06 sec)
-</programlisting>
- <para>
- Again, you can check that everything has gone smoothly.
- </para>
-<programlisting>mysql> select User,Host,Password from mysql.User;
-+-------+-----------+------------------+
-| User | Host | Password |
-+-------+-----------+------------------+
-| root | localhost | |
-| root | % | |
-| | localhost | |
-| | % | |
-| jboss | localhost | 5d2e19393cc5ef67 |
-+-------+-----------+------------------+
-5 rows in set (0.02 sec)
-</programlisting>
+
+<para>
+The datasource is pointing at the database called test provided by default with MySQL 5.x.
+Remember to update the connection url attributes as well as the combo username/password to match your environment setup.
+</para>
</section>
- <section id="Using_MySQL_as_the_Default_DataSource-Installing_the_JDBC_Driver_and_Deploying_the_DataSource">
- <title>Installing the JDBC Driver and Deploying the DataSource</title>
- <para>
- To make the JDBC driver classes available to JBoss, copy the file <literal>mysql-connector-java-3.0.15-ga-bin.jar</literal> from the Connector/J distribution to the <literal>lib</literal> directory in the <literal>default</literal> server configuration (assuming that is the configuration you’re running, of course). Then create a file in the <literal>deploy</literal> directory called <literal>mysql-ds.xml</literal> with the following datasource configuration. The database user name and password corresponds the MySql user we created in the previous section.
- </para>
-<programlisting><datasources>
- <local-tx-datasource>
- <jndi-name>MySqlDS</jndi-name>
- <connection-url>jdbc:mysql://localhost:3306/jboss</connection-url>
- <driver-class>com.mysql.jdbc.Driver</driver-class>
- <user-name>jboss</user-name>
- <password>password</password>
- </local-tx-datasource>
-</datasources>
+<section id="configuring_jbossmq_persistence_manager"><title>Configuring JBoss MQ Persistence Manager</title>
+ <para>
+ The persistence manager of JBoss MQ uses the default datasource to create tables to store JMS messages, transaction data and other indexes. The DDLs used by this service are vendor-specific and should be updated accordingly as follows:
+ From docs/examples/jms, copy mysql-jdbc2-service.xml over to deploy/jms. Then delete the existing hsqldb-jdbc2-service.xml file located in the same folder. Last, make sure to point the service at the right datasource jndi name i.e. “DefaultDS”:
+ </para>
+<programlisting> <![CDATA[
+<mbean code="org.jboss.mq.pm.jdbc2.PersistenceManager"
+ name="jboss.mq:service=PersistenceManager">
+ <depends optional-attribute-name="ConnectionManager">jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+....]]>
</programlisting>
- <para>
- Because we have added a new JAR file to the <literal>lib</literal> directory, you will need to make sure that the server is able to find the MySQL driver classes.
- </para>
- </section>
+
+<note><title>Note</title>
+<para>
+The StateManager and other services such as Timer or HiLo make use of standard DDLs thus don't require any changes.
+</para>
+</note>
+
+
+</section>
+
<section id="Using_MySQL_as_the_Default_DataSource-Testing_the_MySQL_DataSource">
<title>Testing the MySQL DataSource</title>
<para>
- We’ll use the CMP roster application to test the new database connection. In order to use MySql in our application, we'll need to set the datasource name a nd type-mapping in the <literal>jbosscmp-jdbc.xml</literal> file in the <literal>dd/team</literal> directory of the CMP roster application. Edit the file and add the following <literal>datasource</literal> and <literal>datasource-mapping</literal> elements to the <literal>defaults</literal> element.
+ Using the test client described in <xref linkend="creating_a_jdbc_client"/>, you may now verify the proper installation of your datasource.
</para>
-<programlisting><jbosscmp-jdbc>
- <defaults>
- <datasource>java:/MySqlDS</datasource>
- <datasource-mapping>mySQL</datasource-mapping>
- </defaults>
-
- <enterprise-beans>
-...
- </enterprise-beans>
-</jbosscmp-jdbc>
-</programlisting>
- <para>
- After restarting JBoss, you should be able to deploy the application and see the tables being created. . The tables should be visible from the MySQL client.
- </para>
-<programlisting>mysql> show tables;
-+-----------------------------------+
-| Tables_in_jboss |
-+-----------------------------------+
-| LeagueBean |
-| PlayerBean |
-| PlayerBean_teams_TeamBean_players |
-| TeamBean |
-+-----------------------------------+
-4 rows in set (0.00 sec)
-</programlisting>
- <para>
- You can see the JMS persistence tables in there too since we’re using MySQL as the default datasource.
- </para>
+
</section>
</section>
- <section id="Using_other_Databases-Setting_up_an_XADataSource_with_Oracle_9i">
- <title>Setting up an XADataSource with Oracle 9i</title>
+ <section id="Configuring_a_datasource_for_Oracle_DB">
+ <title>Configuring a datasource for Oracle DB</title>
<para>
- Oracle is one of the main players in the commercial database field and most readers will probably have come across it at some point. You can download it freely for non-commercial purposes from <ulink url="http://www.oracle.com"></ulink>
+ Oracle is one of the main players in the commercial database field and most readers will probably have come across it at some point. You can download it freely for non-commercial purposes from <ulink url="http://www.oracle.com/technology/products/database/xe/index.html"/>
</para>
<para>
- Installing and configuring Oracle is not for the faint of heart. It isn’t really just a simple database, but it is heavy on extra features and technologies which you may not actually want (another Apache web server, multiple JDKs, Orbs etc.) but which are usually installed anyway. So we’ll assume you already have an Oracle installation available. For this example, we’ve used Oracle 10g.
+ In this section, we'll connect the server to Oracle Database 10g Express Edition using the latest JDBC driver (11g) available at <ulink url="http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html"/>
</para>
- <section id="Setting_up_an_XADataSource_with_Oracle_9i-Padding_Xid_Values_for_Oracle_Compatibility">
- <title>Padding Xid Values for Oracle Compatibility</title>
- <para>
- If you look in the <literal>jboss-service.xml</literal> file in the <literal> default/conf</literal> directory, you’ll find the following service MBean.
- </para>
-<programlisting><!-- The configurable Xid factory. For use with Oracle, set pad to true -->
-<mbean code="org.jboss.tm.XidFactory"
- name="jboss:service=XidFactory">
- <!--attribute name="Pad">true</attribute-->
-</mbean>
-</programlisting>
- <para>
- The transaction service uses this to create XA transactions identifiers. The comment explains the situation: for use with Oracle you have to include the line which sets the attribute <literal>Pad</literal> to true. This activates padding the identifiers out to their maximum length of 64 bytes. Remember that you’ll have to restart JBoss for this change to be put into effect, but wait until you’ve installed the JDBC driver classes which we’ll talk about next.
- </para>
- </section>
+
+
<section id="Setting_up_an_XADataSource_with_Oracle_9i-Installing_the_JDBC_Driver_and_Deploying_the_DataSource">
<title>Installing the JDBC Driver and Deploying the DataSource</title>
<para>
- The Oracle JDBC drivers can be found in the directory <literal>$ORACLE_HOME/jdbc/lib</literal>. Older versions, which may be more familiar to some users, had rather uninformative names like <literal>classes12.zip</literal> but at the time of writing the latest driver version can be found in the file <literal>ojdbc14.jar</literal>. There is also a debug version of the classes with <literal>_g</literal> appended to the name which may be useful if you run into problems. Again, you should copy one of these to the <literal>lib</literal> directory of the JBoss <literal>default</literal> configuration. The basic driver class you would use for the non-XA setup is called <literal>oracle.jdbc.driver.OracleDriver</literal>. The <literal>XADataSource</literal> class, which we’ll use here, is called <literal>oracle.jdbc.xa.client.OracleXADataSource</literal>.
+ To make the JDBC driver classes available to JBoss Application Server, copy the archive ojdbc5.jar to the lib directory in the default server configuration (assuming that is the server configuration you’re running).
</para>
<para>
- For the configuration file, make a copy of the <literal>oracle-xa-ds.xml</literal> example file and edit it to set the correct URL, username and password.
+ Then create a text file in the <filename>deploy</filename> directory called <filename>oracle-ds.xml</filename> with the following datasource descriptor :
+
+ <programlisting><![CDATA[
+ <?xml version="1.0" encoding="UTF-8"?>
+ <datasources>
+ <local-tx-datasource>
+ <jndi-name>DefaultDS</jndi-name>
+ <connection-url>jdbc:oracle:thin:@localhost:1521:xe</connection-url>
+ <driver-class>oracle.jdbc.driver.OracleDriver</driver-class>
+ <user-name>SYSTEM</user-name>
+ <password>jboss</password>
+ <valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleValidConnectionChecker</valid-connection-checker-class-name>
+ <metadata>
+ <type-mapping>Oracle9i</type-mapping>
+ </metadata>
+ </local-tx-datasource>
+ </datasources>
+ ]]>
+ </programlisting>
+
+ The datasource is pointing at the database/SID called “xe” provided by default with Oracle XE.
</para>
-<programlisting><datasources>
- <xa-datasource>
- <jndi-name>XAOracleDS</jndi-name>
- <track-connection-by-tx>true</track-connection-by-tx>
- <isSameRM-override-value>false</isSameRM-override-value>
- <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>
- <xa-datasource-property name="URL">
- jdbc:oracle:thin:@monkeymachine:1521:jboss
- </xa-datasource-property>
- <xa-datasource-property name="User">jboss</xa-datasource-property>
- <xa-datasource-property name="Password">password</xa-datasource-property>
- <exception-sorter-class-name>
- org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter
- </exception-sorter-class-name>
- <no-tx-separate-pools/>
- </xa-datasource>
-
- <mbean code="org.jboss.resource.adapter.jdbc.vender.oracle.OracleXAExceptionFormatter"
- name="jboss.jca:service=OracleXAExceptionFormatter">
- <depends optional-attribute-name="TransactionManagerService">
- jboss:service=TransactionManager
- </depends>
- </mbean>
-</datasources>
-</programlisting>
<para>
- We’ve used the Oracle thin (pure java) driver here and assumed the database is running on the host <literal>monkeymachine</literal> and that the database name (or SID in Oracle terminology) is <literal>jboss</literal>. We’ve also assumed that you’ve created a user <literal>jboss</literal> with all the sufficient privileges. You can just use <literal>dba</literal> privileges for this example.
+ Of course, you need to update the connection url attributes as well as the username/password combination to match your environment setup.
</para>
-<programlisting>SQL> connect / as sysdba
-Connected.
-SQL> create user jboss identified by password;
-User created.
-SQL> grant dba to jboss;
-Grant succeeded.
-</programlisting>
+
+ </section>
+
+ <section><title>Configuring JBoss MQ Persistence Manager</title>
+ <para>The persistence manager of JBoss MQ uses the default datasource to create tables to store JMS messages, transaction data and other indexes. The DDLs used by this service are vendor-specific and should be updated accordingly as follows:
+ </para>
<para>
- Now copy the file to the <literal>deploy</literal> directory. You should get the following output.
- </para>
-<programlisting>11:33:45,174 INFO [WrapperDataSourceService] Bound connection factory for resource adapter
-for ConnectionManager 'jboss.jca:name=XAOracleDS,service=DataSourceBinding to JNDI name
-'java:XAOracleDS'
+ From <filename>docs/examples/jms</filename>, copy <filename>oracle-jdbc2-service.xml</filename> over to <filename>deploy/jms</filename>. Then delete the existing <filename>hsqldb-jdbc2-service.xml</filename> file located in the same folder. Last, make sure to point the service at the right datasource jndi name i.e. “DefaultDS”:
+
+<programlisting><![CDATA[
+<mbean code="org.jboss.mq.pm.jdbc2.PersistenceManager"
+ name="jboss.mq:service=PersistenceManager">
+<depends optional-attribute-name="ConnectionManager">jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+....]]>
</programlisting>
- <para>
- If you use the <literal>JNDIView</literal> service from the JMX console as before, you should see the name <literal>java:/XAOracleDS</literal> listed.
- </para>
+
+
+<note><title>Note</title>
+ <para>
+ The StateManager and other services such as Timer or HiLo make use of standard DDLs thus don't require any changes.
+ </para>
+</note>
+</para>
</section>
+
+
<section id="Setting_up_an_XADataSource_with_Oracle_9i-Testing_the_Oracle_DataSource">
<title>Testing the Oracle DataSource</title>
<para>
- Again we’ll use the CMP example to test out the new database connection. The <literal>jbosscmp-jdbc.xml</literal> file should contain the following.
+ Before you can verify the datasource configuration, Oracle XE should be reconfigured to avoid port conflict with JBossAS as by default they both start a web server on port 8080.
</para>
-<programlisting><jbosscmp-jdbc>
- <defaults>
- <datasource>java:/XAOracleDS</datasource>
- <datasource-mapping>Oracle9i</datasource-mapping>
- </defaults>
-</jbosscmp-jdbc>
-</programlisting>
- <para>
- There are other Oracle type-mappings available too. If you’re using an earlier version, have a look in the <literal>conf/standardjbosscmp-jdbc.xml</literal> file to find the correct name
+ <para>Open up an Oracle SQLcommand line and execute the following commands:
</para>
- <para>
- Deploy the application as before, check the output for errors and then check that the tables have been created using Oracle SQLPlus again from the command line.
- </para>
-<programlisting>SQL> select table_name from user_tables;
+<screen>
+<command>SQL> connect;
+Enter user-name: SYSTEM
+Enter password:</command>
+Connected.
+SQL> <command>begin
+2 dbms_xdb.sethttpport('8090');
+3 end;
+4 /</command>
+PL/SQL procedure successfully completed.
+SQL> <command>select dbms_xdb.gethttpport from dual;</command>
+GETHTTPPORT
+-----------
+8090
+</screen>
-TABLE_NAME
-------------------------------
-TEAMBEAN
-LEAGUEBEAN
-PLAYERBEAN
-PLAYERBEAN_TEAMS_TEAM_1OFLZV8
-</programlisting>
+<para>
+ The web server started by Oracle XE to provide http-based administration tools is now running on port 8090.
+ Start the JBossAS server instance as you would normally do. You are now ready to use the test client described in Chapter 6.5 to verify the proper installation of your datasource.
+</para>
+
</section>
+ </section>
+
+ <section><title>Configuring a datasource for Microsoft SQL Server 200x</title>
+ <para>In this section, we'll connect the server to MS SQL Server 2000 using the latest JDBC driver (v1.2) available at <ulink url="http://msdn2.microsoft.com/en-us/data/aa937724.aspx"/>.
+ </para>
+
+ <section><title>Installing the JDBC Driver and Deploying the DataSource</title>
+ <para>
+ To make the JDBC driver classes available to JBoss Application Server, copy the archive sqljdbc.jar from the sqljdbc_1.2 distribution to the lib directory in the default server configuration (assuming that is the server configuration you’re running).
+ </para>
+ <para>
+ Then create a text file in the deploy directory called mssql-ds.xml with the following datasource descriptor :
+<programlisting><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<datasources>
+ <local-tx-datasource>
+ <jndi-name>DefaultDS</jndi-name>
+ <connection-url>jdbc:sqlserver://localhost:1433;DatabaseName=pubs</connection-url>
+ <driver-class>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver-class>
+ <user-name>sa</user-name>
+ <password>jboss</password>
+ <check-valid-connection-sql>SELECT 1 FROM sysobjects</check-valid-connection-sql>
+ <metadata>
+ <type-mapping>MS SQLSERVER2000</type-mapping>
+ </metadata>
+ </local-tx-datasource>
+</datasources> ]]>
+</programlisting>
+
+The datasource is pointing at a database “pubs” provided by default with MS SQL Server 2000.
+</para>
+<para>
+Remember to update the connection url attributes as well as the username/password combination to match your environment setup.
+
+<note><title>Note</title>
+<para>The class MSSQLValidConnectionChecker is provided with the AS distribution. Unfortunately it throws an exception when the latest 2005 version of the MS driver is installed <ulink url="http://jira.jboss.com/jira/browse/JBAS-4911"/>.
+</para></note>
+</para>
+
+<section id="configuring_jboss_mq_persistence_manager"><title>Configuring JBoss MQ Persistence Manager</title>
+ <para>
+ The persistence manager of JBoss MQ uses the default datasource to create tables to store JMS messages, transaction data and other indexes. The DDLs used by this service are vendor-specific and should be updated accordingly as follows:
+ From <literal>docs/examples/jms</literal>, copy <literal>mssql-jdbc2-service.xml</literal> over to deploy/jms. Then delete the existing <literal>hsqldb-jdbc2-service.xml</literal> file located in the same folder. Last, make sure to point the service at the right datasource jndi name i.e. “DefaultDS”:
+<programlisting><![CDATA[
+<mbean code="org.jboss.mq.pm.jdbc2.PersistenceManager"
+ name="jboss.mq:service=PersistenceManager">
+ <depends optional-attribute-name="ConnectionManager">jboss.jca:service=DataSourceBinding,name=DefaultDS</depends>
+....]]>
+</programlisting>
+
+<note><title>Note</title>
+ <para>The StateManager and other services such as Timer or HiLo make use of standard DDLs thus don't require any changes.
+ </para>
+</note>
+
+</para>
+</section>
+
+<section id="testing_the_datasource"><title>Testing the datasource</title>
+ <para>Using the test client described in <xref linkend="creating_a_jdbc_client"/>, you may now verify the proper installation of your datasource.
+ </para>
+</section>
</section>
+</section>
+
+<section id="creating_a_jdbc_client"><title>Creating a JDBC client</title>
+ <para>
+ When testing a newly configured datasource we suggest using some very basic JDBC client code embedded in a JSP page.
+ First of all, you should create an exploded WAR archive under the deploy directory which is simply a folder named "<literal>jdbcclient.war</literal>".
+In this folder, create a text document named client.jsp and paste the code below:
+<programlisting><![CDATA[
+<%@page contentType="text/html"
+ import="java.util.*,javax.naming.*,javax.sql.DataSource,java.sql.*"
+ %>
+ <%
+
+ DataSource ds = null;
+ Connection con = null;
+ PreparedStatement pr = null;
+ InitialContext ic;
+ try {
+ ic = new InitialContext();
+ ds = (DataSource)ic.lookup( "java:/DefaultDS" );
+ con = ds.getConnection();
+ pr = con.prepareStatement("SELECT USERID, PASSWD FROM JMS_USERS");
+ ResultSet rs = pr.executeQuery();
+ while (rs.next()) {
+ out.println("<br> " +rs.getString("USERID") + " | " +rs.getString("PASSWD"));
+ }
+ rs.close();
+ pr.close();
+ }catch(Exception e){
+ out.println("Exception thrown " +e);
+ }finally{
+ if(con != null){
+ con.close();
+ }
+}]]></programlisting>
+
+Open up a web browser and hit the url: <ulink url="http://localhost:8080/jdbcclient/client.jsp"/>.
+A list of users and password should show up as a result of the jdbc query:
+<screen>
+dynsub | dynsub
+guest | guest
+j2ee | j2ee
+john | needle
+nobody | nobody
+</screen>
+
+ </para>
+</section>
+
</chapter>
Modified: projects/docs/trunk/Getting_Started/en-US/Using_Seam.xml
===================================================================
--- projects/docs/trunk/Getting_Started/en-US/Using_Seam.xml 2007-11-28 13:54:00 UTC (rev 67557)
+++ projects/docs/trunk/Getting_Started/en-US/Using_Seam.xml 2007-11-28 13:54:21 UTC (rev 67558)
@@ -9,20 +9,36 @@
</para>
<para>
- We have included two versions of the example application, one coded using EJB3 / JSF without using Seam, and one using Seam, to demonstrate clearly the difference in application development using the Seam framework.
+ If you are new to Seam, you can find more introductory information from the following url and book:
+<itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://docs.jboss.com/seam/2.0.0.GA/reference/en/html_single/">The Seam Reference Guide</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Beginning JBoss Seam</emphasis> by Joseph Faisal Nusairat, Apress 2007.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
</para>
<para>
-
+ We have included two versions of the example application, one coded using EJB3 / JSF without using Seam, and one using Seam, to demonstrate clearly the difference in application development using the Seam framework.
</para>
+
+
<section id="Using_Seam_Data_Model">
<title>
Data Model
</title>
<para>
- In the previous chapter we looked at the Data Model used in the EJB3/JSF implementation of this sample application. Let's start off our examination of the Seam implementation in the same way, by examining how the Data Model is implemented. This is done in the <literal>Todo.java</literal> file.
+ Let's start off our examination of the Seam implementation in the same way, by examining how the Data Model is implemented. This is done in the <literal>Todo.java</literal> file.
</para>
<programlisting>@Entity
@@ -56,7 +72,7 @@
}</programlisting>
<para>
- The <literal>@Entity</literal> annotation defines the class as an EJB3 session bean, and tells the container to map the <literal>Todo</literal> class to a relational database table. Each property of the class will become a column in the table. Each instance of the class will become a row in this table. Since we have not used the <literal>@Table</literal> annotation, Seam's "configuration by exception" default will name the table after the class.
+ The <literal>@Entity</literal> annotation defines the class as an EJB3 entity bean, and tells the container to map the <literal>Todo</literal> class to a relational database table. Each property of the class will become a column in the table. Each instance of the class will become a row in this table. Since we have not used the <literal>@Table</literal> annotation, Seam's "configuration by exception" default will name the table after the class.
</para>
<para>
@@ -374,7 +390,7 @@
</title>
<para>
- This completes our walkthrough of the sample Seam application. For further, detailed information on developing applications using the Seam framework, please refer to the "Seam Reference Guide".
+ This completes our walkthrough of the sample Seam application. For further, detailed information on developing applications using the Seam framework, please refer to the <ulink url="http://docs.jboss.com/seam/2.0.0.GA/reference/en/html_single/">The Seam Reference Guide</ulink>.
</para>
</section>
</chapter>
More information about the jboss-cvs-commits
mailing list