User: kunle
Date: 01/03/29 18:30:43
Modified: src/docs cmp.xml customizingjaws.xml howtomssql.xml
jbossdocs.xml jdbc-database.xml
Added: src/docs howtojetty.xml
Log:
- added new info on JBoss-Jetty- updated MSSQL with Brendon's WebLogic info- add...
Revision Changes Path
1.4 +1 -1 manual/src/docs/cmp.xml
Index: cmp.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/cmp.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- cmp.xml 2001/03/21 08:30:20 1.3
+++ cmp.xml 2001/03/30 02:30:43 1.4
@@ -1,5 +1,5 @@
<?xml version = "1.0" encoding = "UTF-8"?>
-<chapter>
+<chapter id="cmp">
<title>Using container-managed persistence</title>
<para>Author:<author>
<firstname>Kevin</firstname>
1.5 +1 -1 manual/src/docs/customizingjaws.xml
Index: customizingjaws.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/customizingjaws.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- customizingjaws.xml 2001/03/29 04:47:52 1.4
+++ customizingjaws.xml 2001/03/30 02:30:43 1.5
@@ -1,5 +1,5 @@
<?xml version = "1.0" encoding = "UTF-8"?>
-<chapter>
+<chapter id="jaws">
<title>Customizing JAWS</title>
<para>Author:<author>
<firstname>Sebastien</firstname>
1.4 +408 -251 manual/src/docs/howtomssql.xml
Index: howtomssql.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/howtomssql.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- howtomssql.xml 2001/03/29 01:01:08 1.3
+++ howtomssql.xml 2001/03/30 02:30:43 1.4
@@ -2,7 +2,7 @@
<!-- edited with XML Spy v3.0 NT (http://www.xmlspy.com) by XML Spy (XML Spy) -->
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"docbookx/docbookx.dtd"> -->
<section id="howto-mssql">
- <title>HOWTO: Using MS SQL Server with JBoss</title>
+ <title>Using MS SQL Server with JBoss (includes Sun JDBC-ODBC bridge)</title>
<para>
<author>
<firstname>Kunle</firstname>
@@ -143,6 +143,14 @@
<entry>Commercial</entry>
</row>
<row>
+ <entry>WebLogic jDriver for Microsoft
SQL Server</entry>
+ <entry>
+ <ulink
url="http://e-docs.bea.com/wls/docs60//////mssqlserver4/index.html">WebLogic</ulink>
+ </entry>
+ <entry>Type 4</entry>
+ <entry>Commercial</entry>
+ </row>
+ <row>
<entry>Atinav aveConnect JDBC</entry>
<entry>
<ulink
url="http:/www.atinav.com/">www.atinav.com</ulink>
@@ -170,6 +178,12 @@
For the remainder of this document, the Sun JDBC-ODBC bridge,
the Merant DataDirect Connect JDBC 2.0 Client
and the i-net OPTA 2000 JDBC drivers will be used to
illustrate the use of MS SQL Server with JBoss.
</para>
+ <para>
+ In the sections that deal with configuration files, the
settings for other MS SQL Server JDBC drivers may be shown
+ in addition to those for the JDBC drivers identified above. In
this cases, it is assumed that you have installed
+ the drivers and you have ensured the driver files are
accessible to JBoss. See below for tips on making JDBC driver
+ files available to JBoss.
+ </para>
<section>
<title>Installing the Sun JBDC-ODBC bridge driver</title>
<para>
@@ -261,12 +275,12 @@
<itemizedlist>
<listitem>
<para>
- <link linkend="howto-mssql-jboss2">Configure
JBoss 2.0 FINAL</link>
+ <link linkend="howto-mssql-jboss2x">Configure
JBoss 2.1 and later</link>
</para>
</listitem>
<listitem>
<para>
- <link linkend="howto-mssql-jboss2x">Configure
JBoss 2.1 and later</link>
+ <link linkend="howto-mssql-jboss2">Configure
older JBoss 2.0 FINAL installations</link>
</para>
</listitem>
</itemizedlist>
@@ -274,139 +288,134 @@
Back to <link linkend="howto-mssql-intro-menu">install
menu</link>
</para>
</section>
- <section id="howto-mssql-jboss2">
- <title>Configure JBoss 2.0 FINAL</title>
+ <section id="howto-mssql-jboss2x">
+ <title>Configure JBoss 2.1 and later</title>
<section>
- <title>Tell JBoss about the new JDBC driver</title>
+ <title>Tell JBoss about the new JBDC driver</title>
<para>
- Now that you have installed a JDBC driver for MS SQL Server,
you need to tell JBoss that you would
- like it to use this driver. Do this by adding an entry for the
driver to the list of JDBC drivers
- that JBoss loads at startup. This list is stored in the
<filename>jbdc.drivers</filename> entry in the
- <filename>jboss.properties</filename> file. The
<filename>jboss.properties</filename> file can be
- found in <filename>%JBOSS_HOME%/conf/</filename>
- <replaceable><config-name></replaceable>.
- For a standard distribution of JBoss,
<replaceable><config-name></replaceable> is
- <filename>default</filename> whilst for the JBoss-Jetty it is
<filename>jetty</filename>. The
- <filename>jbdc.drivers</filename> entry should be a single,
continuous string of JDBC driver names
- separated with a comma.
- </para>
- <example>
- <title>Adding the Sun JDBC-ODBC bridge driver to the
JBoss JDBC driver list</title>
- <programlisting>
-jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
- </programlisting>
- </example>
- <example>
- <title>Adding the Merant DataDirect Connect JDBC
driver to the JBoss JDBC driver list</title>
- <programlisting>
-jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
- </programlisting>
- </example>
- <example>
- <title>Adding the i-net OPTA 2000 JDBC driver to the
JBoss JDBC driver list</title>
- <programlisting>
-jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>com.inet.tds.TdsDriver</replaceable>
- </programlisting>
- </example>
- </section>
- <section>
- <title>Check that JBoss now loads the new JDBC driver</title>
+ Now that you have installed a JDBC driver for MS SQL
Server, you need to tell JBoss that you would
+ like it to use this driver. Add an entry for the
driver to the list of drivers that JBoss loads at
+ startup. This list is stored in the
<filename>jboss.jcml</filename> file. The file can be found in
+ <filename>%JBOSS_HOME%/conf/</filename>
+
<replaceable><config-name></replaceable>.
+ For a standard distribution of JBoss,
<replaceable><config-name></replaceable> is
+ <filename>default</filename> whilst for the
JBoss-Jetty it is <filename>jetty</filename>.
+ The entry should be a single, continuous list of
comma-separated JDBC driver names.
+ </para>
<para>
- Start JBoss and ensure that the JDBC driver is found (the
relevant output would be similar to
- the output shown below). Stop JBoss afterwards.
- </para>
- <example>
- <title>JBoss startup output showing loaded Sun
JDBC-ODBC bridge driver</title>
- <programlisting>
-[JDBC] Loaded JDBC-driver:org.hsql.jdbcDriver
-[JDBC] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
-[JDBC] Loaded JDBC-driver:<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
- </programlisting>
- </example>
- <example>
- <title>JBoss startup output showing loaded Merant
DataDirect Connect JDBC driver</title>
- <programlisting>
-[JDBC] Loaded JDBC-driver:org.hsql.jdbcDriver
-[JDBC] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
-[JDBC] Loaded
JDBC-driver:<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
- </programlisting>
- </example>
- <example>
- <title>JBoss startup output showing loaded i-net OPTA
2000 JDBC driver</title>
- <programlisting>
-[JDBC] Loaded JDBC-driver:org.hsql.jdbcDriver
-[JDBC] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
-[JDBC] Loaded JDBC-driver:<replaceable>com.inet.tds.TdsDriver</replaceable>
- </programlisting>
- </example>
- </section>
- <section>
- <title>Declare a DB Connection pool</title>
+ Open the file and look for the entry that begins with
the following <filename>mbean</filename> tag:
+ </para>
<para>
- At this point, you know that the driver is correctly
installed. You will now set up a connection pool
- that your EJBeans can connect to. Add an MLET entry into the
<filename>jboss.conf</filename> file as
- shown below. The file can be found in
<filename>%JBOSS_HOME%/conf/</filename>
- <replaceable><config-name></replaceable>.
- </para>
+ <prompt><mbean
code="org.jboss.jdbc.JdbcProvider"
+ name="DefaultDomain:service=JdbcProvider"></prompt>
+ </para>
<para>
- For this tutorial, you will create a connection pool named
<replaceable>SQLServerPool</replaceable> as
- specified in the first argument in the MLET entry. The second
argument in the MLET entry should be your
- driver's <filename>XADataSource</filename> classname. If your
driver doesn't support
- <filename>XADataSource</filename> use
<filename>org.jboss.minerva.xa.XADataSourceImpl</filename> instead.
- </para>
- <example>
- <title>Connection pool MLET declaration for Sun
JDBC-ODBC bridge driver</title>
- <programlisting>
-<MLET CODE="org.jboss.jdbc.XADataSourceLoader" ARCHIVE="jboss.jar,rt.jar"
CODEBASE="../lib/ext/">
- <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
- <ARG TYPE="java.lang.String"
VALUE="org.jboss.minerva.xa.XADataSourceImpl">
-</MLET>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MLET declaration for Merant
DataDirect Connect JDBC driver</title>
- <programlisting>
-<MLET CODE="org.jboss.jdbc.XADataSourceLoader"
ARCHIVE="jboss.jar,base.jar,util.jar,sqlserver.jar" CODEBASE="../lib/ext/">
- <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
- <ARG TYPE="java.lang.String"
VALUE="org.jboss.minerva.xa.XADataSourceImpl">
-</MLET>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MLET declaration for i-net OPTA
2000 JDBC driver</title>
- <programlisting>
-<MLET CODE="org.jboss.jdbc.XADataSourceLoader" ARCHIVE="jboss.jar,Opta200.jar"
CODEBASE="../lib/ext/">
- <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
- <ARG TYPE="java.lang.String"
VALUE="com.inet.tds.XDataSource">
-</MLET>
- </programlisting>
- </example>
+ The list of drivers is kept in an
<filename><attribute></filename> sub-tag of this entry named
+ <filename>Drivers</filename>. Add your JBDC driver to
the list as shown below. When you've finished,
+ keep the file open in your editor.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Adding the Sun JDBC-ODBC bridge driver
to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
+ <attribute name="<replaceable>Drivers</replaceable>">
+ org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
+ </attribute>
+</mbean>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Adding the Merant DataDirect Connect
JDBC driver to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
+ <attribute name="<replaceable>Drivers</replaceable>">
+ org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
+ </attribute>
+</mbean>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Adding the i-net OPTA 2000 JDBC driver
to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
+ <attribute name="<replaceable>Drivers</replaceable>">
+ org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>com.inet.tds.TdsDriver</replaceable>
+ </attribute>
+</mbean>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Adding the WebLogic jDriver for
Microsoft SQL Server to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
+ <attribute name="<replaceable>Drivers</replaceable>">
+ org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>weblogic.jdbc.mssqlserver4.Driver</replaceable>
+ </attribute>
+</mbean>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
</section>
<section>
- <title>Configure the DB Connection pool</title>
+ <title>Create a DB Connection pool</title>
<para>
- Before you can use your spanking new connection pool, you need
to tell it how to find your
- database server (you can also take this chance to specifiy
other configuration parameters
- for the pool like <envar>LoggingEnabled</envar>). Tell your
pool how to connect to your
- database server by adding an MBEAN entry into the
<filename>jboss.jcml</filename> file as
- shown below. The file can be found in
- <filename>%JBOSS_HOME%/conf/</filename>
- <replaceable><config-name></replaceable>.
- </para>
- <example>
- <title>Connection pool MBEAN declaration for Sun
JDBC-ODBC bridge JDBC driver</title>
- <programlisting>
-<mbean
name=";DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ At this point, you have told JBoss about your driver.
You will now set up a connection pool that your
+ EJBeans can connect to. For this tutorial, you will
create a connection pool named
+ <replaceable>SQLServerPool</replaceable>. To create
the connection pool, locate the
+ <filename>mbean</filename> entry that begins with the
following line in the
+ <filename>jboss.jcml</filename> file (you should have
kept it open as advised in the last step):
+ </para>
+ <para>
+ <prompt><mbean
code="org.jboss.jdbc.XADataSourceLoader"
name="DefaultDomain:service=XADataSource,name=DefaultDS"></prompt>
+ </para>
+ <para>
+ Add the <filename>mbean</filename> entry given below
to the file just <emphasis>below</emphasis> the
+ <filename>mbean</filename> entry you have just located
above. This should be added after the closing
+ <filename></mbean></filename> tag!!.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
Sun JDBC-ODBC bridge JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ <attribute
name="DataSourceClass"><replaceable>org.opentools.minerva.jdbc.xa.wrapper.XADataSourceImpl</replaceable></attribute>
+ <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
<attribute
name="URL">jdbc:odbc:<replaceable>jboss_odbc</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
<attribute
name="Password"><replaceable>dbpassword</replaceable></attribute>
</mbean>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MBEAN declaration for Merant
DataDirect Connect JDBC driver</title>
- <programlisting>
-<mbean
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
Merant DataDirect Connect JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ <attribute
name="DataSourceClass"><replaceable>org.opentools.minerva.jdbc.xa.wrapper.XADataSourceImpl</replaceable></attribute>
+ <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
<attribute
name="URL">jdbc:sqlserver://<replaceable>servername</replaceable>:1433</attribute>
<attribute
name="Properties">DatabaseName=<replaceable>DatabaseName</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
@@ -424,12 +433,18 @@
<attribute name="IdleTimeout">1800000</attribute>
<attribute
name="MaxIdleTimeoutPercent">1.0</attribute>
</mbean>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MBEAN declaration for i-net
OPTA 2000 JDBC driver</title>
- <programlisting>
-<mbean
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
i-net OPTA 2000 JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ <attribute
name="DataSourceClass"><replaceable>com.inet.tds.XDataSource</replaceable></attribute>
+ <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
<attribute
name="Properties">host=<replaceable>ServerName</replaceable>;
database=<replaceable>DatabaseName</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
<attribute
name="Password"><replaceable>dbpassword</replaceable></attribute>
@@ -446,14 +461,58 @@
<attribute name="IdleTimeout">1800000</attribute>
<attribute
name="MaxIdleTimeoutPercent">1.0</attribute>
</mbean>
- </programlisting>
- </example>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
WebLogic jDriver for Microsoft SQL Server
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
+ <attribute
name="DataSourceClass"><replaceable>org.opentools.minerva.jdbc.xa.wrapper.XADataSourceImpl</replaceable></attribute>
+ <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
+ <attribute
name="URL">jdbc:weblogic:mssqlserver4:<replaceable>DatabaseName</replaceable>@<replaceable>ServerName</replaceable>:<replaceable>1433</replaceable></attribute>
+ <attribute
name="Properties">user=<replaceable>dbusername</replaceable>;
password=<replaceable>dbpassword</replaceable></attribute>
+ <attribute name="MinSize">4</attribute>
+ <attribute name="MaxSize">10</attribute>
+ <attribute name="GCEnabled">false</attribute>
+ <attribute name="GCMinIdleTime">1200000</attribute>
+ <attribute name="GCInterval">120000</attribute>
+ <attribute name="InvalidateOnError">false</attribute>
+ <attribute name="TimestampUsed">false</attribute>
+ <attribute name="Blocking">true</attribute>
+ <attribute name="LoggingEnabled">false</attribute>
+ <attribute name="IdleTimeoutEnabled">false</attribute>
+ <attribute name="IdleTimeout">1800000</attribute>
+ <attribute
name="MaxIdleTimeoutPercent">1.0</attribute>
+</mbean>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
</section>
<section>
<title>Check the DB Connection pool</title>
<para>
- Start JBoss and ensure that the JDBC driver is found (the
relevant output would be similar to
- the output shown below). Stop JBoss afterwards.
+ Start JBoss and ensure that the JDBC driver is found and the
connection pool is created.
+ The relevant out put is shown below for successful JBDC driver
load.
+ </para>
+ <informalexample>
+ <programlisting>
+[Transaction manager] Initializing
+[Transaction manager] Loaded JDBC-driver:org.hsql.jdbcDriver
+[Transaction manager] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
+[Transaction manager] Loaded
JDBC-driver:<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
+[Transaction manager] Loaded
JDBC-driver:<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
+[Transaction manager] Loaded
JDBC-driver:<replaceable>com.inet.tds.TdsDriver</replaceable>
+[Transaction manager] Loaded
JDBC-driver:<replaceable>weblogic.jdbc.mssqlserver4.Driver</replaceable>
+[Transaction manager] Initialized
+ </programlisting>
+ </informalexample>
+ <para>
+ And a litte later...the output for the connection pool. Stop
JBoss afterwards.
</para>
<informalexample>
<programlisting>
@@ -467,97 +526,160 @@
</para>
</section>
</section>
- <section id="howto-mssql-jboss2x">
- <title>Configure JBoss 2.1 and later</title>
+ <section id="howto-mssql-jboss2">
+ <title>Configure JBoss 2.0 FINAL</title>
<section>
- <title>Tell JBoss about the new JBDC driver</title>
- <para>
- Now that you have installed a JDBC driver for MS SQL Server,
you need to tell JBoss that you would
- like it to use this driver. Add an entry for the driver to the
list of drivers that JBoss loads at
- startup. This list is stored in the
<filename>jboss.jcml</filename> file. The file can be found in
- <filename>%JBOSS_HOME%/conf/</filename>
- <replaceable><config-name></replaceable>.
- For a standard distribution of JBoss,
<replaceable><config-name></replaceable> is
- <filename>default</filename> whilst for the JBoss-Jetty it is
<filename>jetty</filename>.
- The entry should be a single, continuous list of comma-separated
JDBC driver names.
- </para>
- <para>
- Open the file and look for the entry that begins with the
following <filename>mbean</filename> tag:
- </para>
+ <title>Tell JBoss about the new JDBC driver</title>
<para>
- <prompt><mbean
code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider"></prompt>
+ Now that you have installed a JDBC driver for MS SQL
Server, you need to tell JBoss that you would
+ like it to use this driver. Do this by adding an entry
for the driver to the list of JDBC drivers
+ that JBoss loads at startup. This list is stored in
the <filename>jbdc.drivers</filename> entry in the
+ <filename>jboss.properties</filename> file. The
<filename>jboss.properties</filename> file can be
+ found in <filename>%JBOSS_HOME%/conf/</filename>
+
<replaceable><config-name></replaceable>.
+ For a standard distribution of JBoss,
<replaceable><config-name></replaceable> is
+ <filename>default</filename> whilst for the
JBoss-Jetty it is <filename>jetty</filename>. The
+ <filename>jbdc.drivers</filename> entry should be a
single, continuous string of JDBC driver names
+ separated with a comma.
</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Adding the Sun JDBC-ODBC bridge driver
to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Adding the Merant DataDirect Connect
JDBC driver to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Adding the i-net OPTA 2000 JDBC driver
to the JBoss JDBC driver list
+ </para>
+ <informalexample>
+ <programlisting>
+jdbc.drivers=org.hsql.jdbcDriver,jdbc.idbDriver,<replaceable>com.inet.tds.TdsDriver</replaceable>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Check that JBoss now loads the new JDBC driver</title>
<para>
- The list of drivers is kept in an
<filename><attribute></filename> sub-tag of this entry named
- <filename>Drivers</filename>. Add your JBDC driver to the list
as shown below. When you've finished,
- keep the file open in your editor.
- </para>
- <example>
- <title>Adding the Sun JDBC-ODBC bridge driver to the
JBoss JDBC driver list</title>
- <programlisting>
-<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
- <attribute name="<replaceable>Drivers</replaceable>">
- org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
- </attribute>
-</mbean>
- </programlisting>
- </example>
- <example>
- <title>Adding the Merant DataDirect Connect JDBC
driver to the JBoss JDBC driver list</title>
- <programlisting>
-<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
- <attribute name="<replaceable>Drivers</replaceable>">
- org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
- </attribute>
-</mbean>
- </programlisting>
- </example>
+ Start JBoss and ensure that the JDBC driver is found
(the relevant output would be similar to
+ the output shown below). Stop JBoss afterwards.
+ </para>
<example>
- <title>Adding the i-net OPTA 2000 JDBC driver to the
JBoss JDBC driver list</title>
+ <title>JBoss startup output showing loaded JDBC
drivers</title>
<programlisting>
-<mbean code="org.jboss.jdbc.JdbcProvider"
name="DefaultDomain:service=JdbcProvider">
- <attribute name="<replaceable>Drivers</replaceable>">
- org.hsql.jdbcDriver,org.enhydra.instantdb.jdbc.idbDriver,<replaceable>com.inet.tds.TdsDriver</replaceable>
- </attribute>
-</mbean>
+[JDBC] Loaded JDBC-driver:org.hsql.jdbcDriver
+[JDBC] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
+[JDBC] Loaded JDBC-driver:<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
+[JDBC] Loaded
JDBC-driver:<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
+[JDBC] Loaded JDBC-driver:<replaceable>com.inet.tds.TdsDriver</replaceable>
</programlisting>
</example>
</section>
<section>
- <title>Create a DB Connection pool</title>
+ <title>Declare a DB Connection pool</title>
<para>
- At this point, you have told JBoss about your driver. You will
now set up a connection pool that your
- EJBeans can connect to. For this tutorial, you will create a
connection pool named
- <replaceable>SQLServerPool</replaceable>. To create the
connection pool, locate the
- <filename>mbean</filename> entry that begins with the
following line in the
- <filename>jboss.jcml</filename> file (you should have kept it
open as advised in the last step):
- </para>
+ At this point, you know that the driver is correctly
installed. You will now set up a connection pool
+ that your EJBeans can connect to. Add an MLET entry
into the <filename>jboss.conf</filename> file as
+ shown below. The file can be found in
<filename>%JBOSS_HOME%/conf/</filename>
+ <replaceable><config-name></replaceable>.
+ </para>
<para>
- <prompt><mbean
code="org.jboss.jdbc.XADataSourceLoader"
name="DefaultDomain:service=XADataSource,name=DefaultDS"></prompt>
+ For this tutorial, you will create a connection pool
named <replaceable>SQLServerPool</replaceable> as
+ specified in the first argument in the MLET entry. The
second argument in the MLET entry should be your
+ driver's <filename>XADataSource</filename> classname.
If your driver doesn't support
+ <filename>XADataSource</filename> use
<filename>org.jboss.minerva.xa.XADataSourceImpl</filename> instead.
</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Connection pool MLET declaration for
Sun JDBC-ODBC bridge driver
+ </para>
+ <informalexample>
+ <programlisting>
+<MLET CODE="org.jboss.jdbc.XADataSourceLoader" ARCHIVE="jboss.jar,rt.jar"
CODEBASE="../lib/ext/">
+ <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
+ <ARG TYPE="java.lang.String"
VALUE="org.jboss.minerva.xa.XADataSourceImpl">
+</MLET>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MLET declaration for
Merant DataDirect Connect JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<MLET CODE="org.jboss.jdbc.XADataSourceLoader"
ARCHIVE="jboss.jar,base.jar,util.jar,sqlserver.jar" CODEBASE="../lib/ext/">
+ <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
+ <ARG TYPE="java.lang.String"
VALUE="org.jboss.minerva.xa.XADataSourceImpl">
+</MLET>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MLET declaration for
i-net OPTA 2000 JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<MLET CODE="org.jboss.jdbc.XADataSourceLoader" ARCHIVE="jboss.jar,Opta200.jar"
CODEBASE="../lib/ext/">
+ <ARG TYPE="java.lang.String"
VALUE="<replaceable>SQLServerPool</replaceable>">
+ <ARG TYPE="java.lang.String"
VALUE="com.inet.tds.XDataSource">
+</MLET>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Configure the DB Connection pool</title>
<para>
- Add the <filename>mbean</filename> entry given below to the
file just <emphasis>below</emphasis> the
- <filename>mbean</filename> entry you have just located above.
This should be added after the closing
- <filename></mbean></filename> tag!!.
- </para>
- <example>
- <title>Connection pool MBEAN declaration for Sun
JDBC-ODBC bridge JDBC driver</title>
- <programlisting>
-<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
- <attribute
name="DataSourceClass"><replaceable>org.opentools.minerva.jdbc.xa.wrapper.XADataSourceImpl</replaceable></attribute>
- <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
+ Before you can use your spanking new connection pool,
you need to tell it how to find your
+ database server (you can also take this chance to
specifiy other configuration parameters
+ for the pool like <envar>LoggingEnabled</envar>). Tell
your pool how to connect to your
+ database server by adding an MBEAN entry into the
<filename>jboss.jcml</filename> file as
+ shown below. The file can be found in
+
<filename>%JBOSS_HOME%/conf/</filename><replaceable><config-name></replaceable>.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
Sun JDBC-ODBC bridge JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean
name=";DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
<attribute
name="URL">jdbc:odbc:<replaceable>jboss_odbc</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
<attribute
name="Password"><replaceable>dbpassword</replaceable></attribute>
</mbean>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MBEAN declaration for Merant
DataDirect Connect JDBC driver</title>
- <programlisting>
-<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
- <attribute
name="DataSourceClass"><replaceable>org.opentools.minerva.jdbc.xa.wrapper.XADataSourceImpl</replaceable></attribute>
- <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
Merant DataDirect Connect JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
<attribute
name="URL">jdbc:sqlserver://<replaceable>servername</replaceable>:1433</attribute>
<attribute
name="Properties">DatabaseName=<replaceable>DatabaseName</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
@@ -575,14 +697,16 @@
<attribute name="IdleTimeout">1800000</attribute>
<attribute
name="MaxIdleTimeoutPercent">1.0</attribute>
</mbean>
- </programlisting>
- </example>
- <example>
- <title>Connection pool MBEAN declaration for i-net
OPTA 2000 JDBC driver</title>
- <programlisting>
-<mbean code="<replaceable>org.jboss.jdbc.XADataSourceLoader</replaceable>"
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
- <attribute
name="DataSourceClass"><replaceable>com.inet.tds.XDataSource</replaceable></attribute>
- <attribute
name="PoolName"><replaceable>SQLServerPool</replaceable></attribute>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ <listitem>
+ <para>
+ Connection pool MBEAN declaration for
i-net OPTA 2000 JDBC driver
+ </para>
+ <informalexample>
+ <programlisting>
+<mbean
name="DefaultDomain:service=XADataSource,name=<replaceable>SQLServerPool</replaceable>">
<attribute
name="Properties">host=<replaceable>ServerName</replaceable>;
database=<replaceable>DatabaseName</replaceable></attribute>
<attribute
name="JDBCUser"><replaceable>dbusername</replaceable></attribute>
<attribute
name="Password"><replaceable>dbpassword</replaceable></attribute>
@@ -599,28 +723,16 @@
<attribute name="IdleTimeout">1800000</attribute>
<attribute
name="MaxIdleTimeoutPercent">1.0</attribute>
</mbean>
- </programlisting>
- </example>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
</section>
<section>
<title>Check the DB Connection pool</title>
<para>
- Start JBoss and ensure that the JDBC driver is found and the
connection pool is created.
- The relevant out put is shown below for successful JBDC driver
load.
- </para>
- <informalexample>
- <programlisting>
-[Transaction manager] Initializing
-[Transaction manager] Loaded JDBC-driver:org.hsql.jdbcDriver
-[Transaction manager] Loaded JDBC-driver:org.enhydra.instantdb.jdbc.idbDriver
-[Transaction manager] Loaded
JDBC-driver:<replaceable>sun.jdbc.odbc.JdbcOdbcDriver</replaceable>
-[Transaction manager] Loaded
JDBC-driver:<replaceable>com.merant.datadirect.jdbc.sqlserver.SQLServerDriver</replaceable>
-[Transaction manager] Loaded
JDBC-driver:<replaceable>com.inet.tds.TdsDriver</replaceable>
-[Transaction manager] Initialized
- </programlisting>
- </informalexample>
- <para>
- And a litte later...the output for the connection pool. Stop
JBoss afterwards.
+ Start JBoss and ensure that the JDBC driver is found (the
relevant output would be similar to
+ the output shown below). Stop JBoss afterwards.
</para>
<informalexample>
<programlisting>
@@ -637,30 +749,75 @@
<section id="howto-mssql-cmp">
<title>Configure DataType Mappings for CMP</title>
<para>
- To configure JBoss so that it uses your MS SQL Server
connection pool as the default data source for
- CMP operations, provide a <filename>jaws.xml</filename> file
as shown below.
+ To configure JBoss so that it uses your MS SQL Server
connection pool as the default data source, you can
+ choose to do one of the following:
</para>
- <example>
- <title>jaws.xml - CMP datatype mappings for MS SQL
Server</title>
- <programlisting><![CDATA[
+ <orderedlist>
+ <listitem>
+ <para>
+ Create a <filename>jaws.xml</filename> file in
the <filename>META-INF</filename> directory of your
+ application to override the default settings
in <filename>standardjaws.xml</filename> as shown below or...
+ </para>
+ <example>
+ <title>jaws.xml - CMP datatype mappings for MS
SQL Server</title>
+ <programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<jaws>
-<datasource>java:/SQLServerPool</datasource>
-<type-mapping>MS SQLSERVER</type-mapping>
-<default-entity>
- <remove-table>false</remove-table>
-</default-entity>
-<type-mappings>
- <type-mapping>
- <name>MS SQLSERVER</name>
+ <datasource>java:/SQLServerPool</datasource>
+ <type-mapping>MS SQLSERVER</type-mapping>
+ <default-entity>
+ <remove-table>false</remove-table>
+ </default-entity>
+ <type-mappings>
+ <type-mapping>
+ <name>MS SQLSERVER</name>
- <!-- INSERT MAPPINGS FROM standardjaws.xml HERE -->
+ <!-- COPY "MS SQLSERVER" MAPPINGS FROM standardjaws.xml HERE -->
- </type-mapping>
-</type-mappings>
+ </type-mapping>
+ </type-mappings>
</jaws>
- ]]></programlisting>
- </example>
+ ]]></programlisting>
+ </example>
+ </listitem>
+ <listitem>
+ <para>
+ Change the default settings in the
<filename>standardjaws.xml</filename> file in
+ <filename>%JBOSS_HOME%/conf</filename>
directly. This is useful in environments like mine where all
+ unused applications and files - such as
HypersonicSQL & InstantDB - are removed from the servers.
+ default settings
<filename>standardjaws.xml</filename> as shown below:
+ </para>
+ <para>
+ To change your default datasource and datatype
mapping, make the following highlighted changes to your
+ <filename>standardjaws.xml</filename> file.
+ </para>
+ <informalexample>
+ <programlisting>
+ <![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<jaws>
+ ]]>
+ <datasource><replaceable>java:/SQLServerPool</replaceable></datasource>
+ <type-mapping><replaceable>MS
SQLSERVER</replaceable></type-mapping>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </orderedlist>
+ <para>
+ For more information see:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="jaws"></xref> for
further information on configuring JAWS (aka JBossCMP).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="cmp"></xref> for useful
information on CMP development & deployment with JBoss.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
<section id="howto-mssql-trouble">
<title>Troubleshooting</title>
1.10 +3 -2 manual/src/docs/jbossdocs.xml
Index: jbossdocs.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/jbossdocs.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- jbossdocs.xml 2001/03/29 11:12:46 1.9
+++ jbossdocs.xml 2001/03/30 02:30:43 1.10
@@ -24,6 +24,7 @@
<!ENTITY howtojaxp.xml SYSTEM "howtojaxp.xml">
<!ENTITY howtojpda.xml SYSTEM "howtojpda.xml">
<!ENTITY howtomssql.xml SYSTEM "howtomssql.xml">
+ <!ENTITY howtojetty.xml SYSTEM "howtojetty.xml">
<!ENTITY jbosssx.xml SYSTEM "jbosssx.xml">
]>
<book>
@@ -45,9 +46,10 @@
&howtomdb.xml;
&designnotes.xml;
&jbosssx.xml;
-<chapter>
+<chapter id="howto">
<title>Howto</title>
&howtotomcat.xml;
+&howtojetty.xml;
&howtomssql.xml;
&howtormhexamples.xml;
&howtojmx.xml;
@@ -63,5 +65,4 @@
&howtojaxp.xml;
</chapter>
-
</book>
1.4 +3 -3 manual/src/docs/jdbc-database.xml
Index: jdbc-database.xml
===================================================================
RCS file: /cvsroot/jboss/manual/src/docs/jdbc-database.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- jdbc-database.xml 2001/03/21 08:30:20 1.3
+++ jdbc-database.xml 2001/03/30 02:30:43 1.4
@@ -1,5 +1,5 @@
-<?xml version = "1.0" encoding = "UTF-8"?>
-<chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="jdbc">
<title>JDBC/Database configuration</title>
<para>Author:<author>
<firstname>Aaron</firstname>
@@ -124,7 +124,7 @@
values for anything you didn't specify.</para>
<table>
<title>Connection pool parameters</title>
- <tgroup cols = "3">
+ <tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
1.1 manual/src/docs/howtojetty.xml
Index: howtojetty.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XML Spy v3.0 NT (http://www.xmlspy.com) by XML Spy (XML Spy) -->
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"docbookx/docbookx.dtd"> -->
<section id="howto-jetty">
<title>Using JBoss-Jetty (under construction)</title>
<para>
<author>
<firstname>Kunle</firstname>
<surname>Odutola</surname>
</author>
<email>[EMAIL PROTECTED]</email>
</para>
<para>
<author>
<firstname>Anthony</firstname>
<surname>Oguntimehin</surname>
</author>
</para>
<section id="howto-jbossjetty-intro">
<title>Introduction</title>
<para>
This document provides a concise and easy-to-read set of
instructions that
will get you up to speed quickly on the basics of installing and using the
JBoss J2EE application server suite and the Jetty HTTP Servlet server to
develop, deploy and run Enterprise Java applications.
</para>
<para>
<ulink url="http://www.jboss.org/">JBoss</ulink> is the brand
name of the leading, Open
Source, standards-compliant J2EE application server suite. The suite
includes
the JBossServer EJB v1.1 container and server (with partial support
for the EJB v2.0 standard),
the JBossMQ JMS 1.0 implemetation, the JBossNS JNDI
implementation, the JBossCMP advanced O/R
mapper and JDBC data object storage implementation and, the
JAAS-based JBossSX security
framework. All the JBoss applications are 100% Pure Java applications
and
are collectively the most innovative J2EE application server suite
available
with features including a much admired modular construction and an
advanced
JMX-based plug-in architecture.
</para>
<para>
<ulink url="http://jetty.mortbay.com/">Jetty</ulink> is an
Open Source, 100% Java
HTTP Servlet Server. It is designed to be light weight, high
performance, embeddable,
extensible and flexible, thus making it an ideal platform for
serving dynamic HTTP
requests from any Java application. Jetty is also standards
compliant and implements
the HTTP 1.1, Servlet API 2.2 and Java Server Pages 1.1
standards. It also supports
SSL as an additional security option for your application.
</para>
<para>
The JBoss organisation and key figures from Jetty's developer
community have collaborated to
produce an integrated version of JBoss and Jetty. In this
version - called
<emphasis>JBoss-Jetty</emphasis> - both JBossServer and Jetty
run within the same Java VM instance.
The benefit is greatly improved performance as all
interactions between JBossServer and Jetty are
now within a single VM. Consequently JBoss-Jetty is able to
offer the highest performance, Open
Source, 100% Pure Java J2EE platform for developing and deploying
innovative and critical
business systems and applications. Whatever your requirements,
JBoss-Jetty together offers you
superior return on investment (ROI) and substantially reduced
time to market (RTTM) compared to
other J2EE development and deployment environments.
</para>
<section id="howto-jbossjetty-intro-menu">
<title>C'mon, show me already</title>
<para>
Not so fast comrades. You need to obtain a copy of the
integrated JBoss-Jetty distribution from
the <ulink url="http://www.jboss.org/">JBoss
website</ulink>. General information about all JBoss
products as well as instructions on how to get a copy
of JBoss-Jetty for yourself can be found in
the <ulink url="../business/faq.html">JBoss
FAQ</ulink> or on the
<ulink url="http://www.jboss.org/">JBoss
website</ulink>. The rest of this document covers the following tasks:
</para>
<orderedlist>
<listitem>
<para>
<link
linkend="howto-jbossjetty-requirements">Check JBoss-Jetty system requirements</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-install">Install JBoss-Jetty on your system</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-run">Start the JBoss-Jetty server suite</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-deploy">Deploy an application with JBoss-Jetty</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-configure">Configure JBoss-Jetty (Optional)</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-trouble">View some JBoss-Jetty troubleshooting tips</link>
</para>
</listitem>
</orderedlist>
<para>
Now it is important to be aware that both the JBoss
application server suite and Jetty are still in active
development. They are both evolving as issues are reported, fixed and, new
features are identified and
added. This means that <emphasis>some of the
information contained in this document may be out of date with
respect to your copy of JBoss-Jetty</emphasis>. This
is even more likely to be the case if you have the latest
CVS or developer version of JBoss-Jetty, JBoss or
Jetty.
</para>
<para>
If this is the case with you or, if you have any
further comments or suggestions about this document or
JBoss-Jetty then please do one or more of the
following:
<itemizedlist>
<listitem>
<para>
Join the <ulink
url="http://www.jboss.org/newsite/business/list.html">JBoss Mailing List</ulink>
if your comments or suggestions are
relevant to JBoss.
</para>
</listitem>
<listitem>
<para>
Join the <ulink
url="http://jetty.mortbay.com/jetty/mailingLists.html">Jetty Mailing List</ulink>
if your comments or suggestions are
relevant to Jetty.
</para>
</listitem>
</itemizedlist>
You will then be able to contribute to the production
of this document and the development of JBoss-Jetty.
</para>
</section>
</section>
<section id="howto-jbossjetty-requirements">
<title>Check JBoss-Jetty system requirements</title>
<para>
Before you can use JBoss-Jetty you must ensure that your
computer's configuration meets or exceeds the
JBoss-Jetty system requirements. To ensure that your computer
can run JBoss-Jetty properly we will check
the following:
</para>
<itemizedlist>
<listitem>
<para>
<link
linkend="howto-jbossjetty-requirements-hardware">Server Hardware specification</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-requirements-java">Java Platform version</link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="howto-jbossjetty-requirements-database">Database Server integration
(optional)</link>
</para>
</listitem>
</itemizedlist>
<section id="howto-jbossjetty-requirements-hardware">
<title>Check Server Hardware specification</title>
<para>
JBoss-Jetty is a suite of enterprise application
server applications and, like all such complex software,
the physical computer on which JBoss-Jetty is deployed
should be configured according to the requirements
of the processing load that it will be expected to
serve. I don't cover Server Configuration and Capacity
Planning any further in this document. A minimum
<emphasis>recommended</emphasis> configuration for a
computer running JBoss-Jetty is shown below.
JBoss-Jetty would work - albeit more slowly - on lesser
specified systems:
</para>
<table>
<title>Minimum recommended specifications for a
JBoss-Jetty computer</title>
<tgroup cols="2" align="center" colsep="1" rowsep="1">
<tbody>
<row>
<entry>OPERATING SYSTEM</entry>
<entry>Microsoft Windows 2000
or Linux or Other OS</entry>
</row>
<row>
<entry>JAVA PLATFORM</entry>
<entry>JDK 1.3 (or JDK1.2.2 if
JDK1.3 is not available)</entry>
</row>
<row>
<entry>CPU</entry>
<entry>233Mhz AMD K6-2 or
Intel Pentium II</entry>
</row>
<row>
<entry>RAM</entry>
<entry>64MB (128MB for Windows
2000)</entry>
</row>
<row>
<entry>DISK INTERFACE
TYPE</entry>
<entry>UDMA/66</entry>
</row>
<row>
<entry>HARD DISK SIZE</entry>
<entry>6GB</entry>
</row>
<row>
<entry>NETWORKING</entry>
<entry>10/100Mbs Ethernet
NIC</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="howto-jbossjetty-requirements-java">
<title>Check Java Platform version</title>
<para>
JBoss-Jetty is a 100% Pure Java suite of enterprise
application servers and your system
<emphasis>must</emphasis> have a Java 2 JDK installed.
More specifically, the Java 2 JDK v1.3
(i.e. JDK1.3 or later) is <emphasis> recommended
</emphasis> for use with JBoss-Jetty. Although JBoss-Jetty
has not been tested an <emphasis>all</emphasis> JDK1.3
platforms, it <emphasis>should</emphasis> run on all
JDK1.3 installations regardless of the underlying OS
platform. Official JDKs are available to download from
Sun at <ulink
url="http://java.sun.com/jdk/">http://java.sun.com/jdk/</ulink>.
</para>
<note>
<para>
JBoss-Jetty can be used (and has been used)
with the Sun Java 2 JDK v1.2.2 but some features - most
notably <emphasis>hot deployment</emphasis> -
will not work. Since a JDK1.3 distribution is available
for most popular OS platforms, JDK v1.2.2 is
<emphasis>not recommended</emphasis> for use with JBoss-Jetty.
More information is available on the
<ulink
url="http://www.jboss.org/newsite/business/list.html">JBoss mailing list
archives</ulink>.
</para>
</note>
</section>
<section id="howto-jbossjetty-requirements-database">
<title>Check Database Server integration (optional)</title>
<para>
Most installations of JBoss-Jetty will require access
to a
<emphasis>relational database management system
(RDBMS)</emphasis> (or more informally a
<emphasis>database server</emphasis>). A database
server is used to store and manipulate data by JSP pages,
Servlets and EJBeans. This is often the basis of
dynamic web sites and web applications.
</para>
<para>
If you plan to use Entity beans with CMP with your
copy of JBoss-Jetty, then you will
<emphasis>need</emphasis> to ensure that JBoss-Jetty
has access to a database server. Examples of RDBMS
that can be used with JBoss-Jetty are Hypersonic
SQL(supplied with JBoss-Jetty), MySQL, Oracle 8i/9,
Sybase ASE, Microsoft Access and Microsoft SQL Server.
The criteria for choosing a database is as complex
as those for choosing an OS platform. As a result,
JBoss-Jetty doesn't mandate any particular RDBMS and can be
configured to work all the popular RDBMS and many
other RDBMS not listed here.
</para>
<note>
<para>
You will need an appropriate JDBC driver for
your database server before it can be used with JBoss-Jetty
(or indeed with any other Java application).
On the Microsoft Windows™ platforms, Sun's JDBC-ODBC
bridge may be used in lieu of a native JDBC
driver but, this is not a <emphasis>recommended</emphasis>
solution. You are well advised to obtain a
more robust JDBC driver for your chosen RDBMS. For more
information see:
<itemizedlist>
<listitem>
<para>
<xref
linkend="jdbc"></xref> for basic information on configuring JBoss-Jetty to use
a database server.
</para>
</listitem>
<listitem>
<para>
<xref
linkend="cmp"></xref> for more information on Container Managed Persistence using
a database server
</para>
</listitem>
<listitem>
<para>
<xref
linkend="howto"></xref> for documents addressing the configuration of specific RDBMS
</para>
</listitem>
</itemizedlist>
</para>
</note>
</section>
</section>
<section id="howto-jbossjetty-install">
<title>Install JBoss-Jetty on your system </title>
<para>
At this stage you have a system that meets JBoss-Jetty's
system requirements. You should also have a copy of
the JBoss-Jetty distribution. If you don't have JBoss, see the
<ulink url="../business/faq.html">JBoss FAQ</ulink> or the
<ulink url="http://www.jboss.org/">JBoss website</ulink>
for instructions on how to obtain it.
</para>
<para>
Depending on your requirements you would have either chosen to
download the JBoss binary distribution or you may
have downloaded a snapshot of the JBoss-Jetty source tree via
CVS. In the latter case you will need to build both
JBoss-Jetty. <emphasis>This document assumes you have the
JBoss-Jetty binary distribution</emphasis> but, the
process is easy enough that you should still be able to adapt
the instructions below if you follow the CVS route.
</para>
<para>
To install the files from the JBoss distribution archive onto
your system do the following:
</para>
<section>
<title>Create a JBoss-Jetty installation directory</title>
<para>
Create a directory on your system for the JBoss-Jetty
application. This directory will thereafter be
referred to as the <emphasis>JBoss installation
directory</emphasis> or just as
<envar>JBOSSJETTY_HOME</envar>. Below are the commands
for creating a JBoss-Jetty installation
directory on Windows and Linux/Unix platforms. In the
examples, the new directory is also made the
current working directory. You might choose a
different location for JBoss-Jetty on your system.
</para>
<informaltable>
<tgroup cols="2" align="center" colsep="0" rowsep="0">
<tbody>
<row>
<entry>Windows 95/98, Windows
NT or Windows 2000</entry>
<entry>Linux, Solaris and
other Unixes</entry>
</row>
<row>
<entry>
<programlisting>
<![CDATA[
mkdir C:\JavaApps\jboss-jetty
chdir C:\JavaApps\jboss-jetty
]]>
</programlisting>
</entry>
<entry>
<programlisting>
<![CDATA[
md /usr/bin/jboss-jetty
cd /usr/bin/jboss-jetty
]]>
</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section>
<title>Extract the JBoss-Jetty files to the installation
directory</title>
<para>
Change the current directory to the JBoss installation
directory (if you haven't already done so) and
extract the files fom the JBoss-Jetty distribution
archive to the installation directory. The general
form of the command to extract the files is:
</para>
<para>
<computeroutput>jar xvf
<replaceable>jBoss-archive-filename</replaceable></computeroutput>
</para>
<para>
As an example, let's say you have a JBoss-Jetty binary
distribution archive named
<filename>jboss-jetty.zip</filename> and it is stored
in a directory called <filename>C:\Packages</filename>
or <filename>~/packages</filename> on a Windows or
Linux/Unix computer respectively. To extract the JBoss-Jetty
files from the archive, you would type the following
commands on the Windows and Linux/Unix platforms.
</para>
<informaltable>
<tgroup cols="2" align="center" colsep="0" rowsep="0">
<tbody>
<row>
<entry>Windows 95/98, Windows
NT or Windows 2000</entry>
<entry>Linux, Solaris and
other Unixes</entry>
</row>
<row>
<entry>
<programlisting>
<![CDATA[
chdir C:\JavaApps\jboss-jetty
jar xvf C:\Packages\jboss-jetty.zip
]]>
</programlisting>
</entry>
<entry>
<programlisting>
<![CDATA[
cd /usr/bin/jboss-jetty
jar xvf ~/packages/jboss-jetty.zip
]]>
</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<note>
<para>
For the above command to work, the
<filename>bin</filename> sub-directory of the JDK directory tree
must be added to your <envar>PATH</envar>
environment variable. You might also be able to use a compatible
de-archiver such as
<filename>winzip</filename> or <filename>gzip</filename> to extract the files.
</para>
</note>
<para>
You should now have the JBoss-Jetty application's
files copied to the installation directory on your system.
</para>
</section>
</section>
<section id="howto-jbossjetty-run">
<title>Start the JBoss-Jetty server suite</title>
<para>
Now that you have copied the JBoss-Jetty application files
from the JBoss binary distribution archive to the
installation directory, the next step is real easy.
Jboss-Jetty is supplied with a command file called
<filename>run_with_jetty.bat</filename> (or
<filename>run_with_jetty.sh</filename> on Linux/Unix) that has been
carefully designed to start JBoss-Jetty. So, to start the
JBoss-Jetty application server suite, use the
<filename>run_with_jetty</filename> command as shown below:
</para>
<informaltable>
<tgroup cols="2" align="center" colsep="0" rowsep="0">
<tbody>
<row>
<entry>Windows 95/98, Windows
NT or Windows 2000</entry>
<entry>Linux, Solaris and
other Unixes</entry>
</row>
<row>
<entry>
<programlisting>
<![CDATA[
chdir C:\JavaApps\jboss-jetty
run_with_jetty
]]>
</programlisting>
</entry>
<entry>
<programlisting>
<![CDATA[
cd /usr/bin/jboss-jetty
./run_with_jetty
]]>
</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
When JBoss-Jetty is started, it should respond with about
three to fours screens of console messages. None of the
messages should be an error message. This is entirely normal.
In addition, JBoss-Jetty is preconfigured with an
application that it will automatically deploy when it is
started. This is to alert you immediately if, for any
reason, the application fails to deploy properly.
</para>
<para>
As a quick sanity test to ensure that all is well with your
copy of JBoss-Jetty, fire up a copy of your
favourite web browser and open the following URLs with it. If
you are reading this document on the same computer
that you have installed JBoss-Jetty, then you may just
click the links below (don't forget to use the BACK button
to return here!).
<itemizedlist>
<listitem>
<para>
<ulink
url="http://localhost:8080/jboss/">http://localhost:8080/jboss/</ulink> - this should
take you to
the sample application that was
automatically deployed when JBoss-Jetty was started.
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://localhost:8080/">http://localhost:8080/</ulink> - this should take you to
the HTML
documentation for Jetty.
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://localhost:8080/demo/">http://localhost:8080/demo/</ulink> - this should
take you to
some sample files that are normally
supplied with Jetty.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Now that you've seen how to start JBoss-Jetty and hopefully verified
that all is well, you should also know that
to stop JBoss-Jetty, you need to press the
<prompt>[CRTL]+[C]</prompt> key combination. This would trigger a
controlled shutdown process within JBoss-Jetty.
</para>
</section>
<section id="howto-jbossjetty-deploy">
<title>Deploy an application with JBoss-Jetty</title>
<para>
[TBD]
</para>
<para>
The procedure for deploying applications with JBoss-Jetty, the
application must be packaged as a JAR, WAR
or EAR file. Examples of what-to-do to deploy Jetty-specific
application types with JBoss-Jetty?
</para>
<section>
<title>Deploy a JSP-only web app with JBoss-Jetty</title>
<para>
In this section you will learn the basics of
deploying an application composed entirely of
<filename>.jsp</filename> files with
JBoss-Jetty. You will create and deploy an application named
<filename>hello</filename>. You will also
create a <filename>sample.jsp</filename> within
<filename>hello</filename> that will be
accessible as <filename>http://localhost/hello/sample.jsp</filename>
on the computer running JBoss-Jetty. For other
computers, just replace <filename>localhost</filename> with
the computer's IP name or address.
</para>
<orderedlist>
<listitem>
<para>
Open the file
<filename>jetty.xml</filename> in
<filename>%JBOSS_HOME%/jBoss-dir/conf/jetty/</filename>
your text editor
</para>
</listitem>
<listitem>
<para>
Add the following lines before
<prompt><![CDATA[</configure>]]></prompt>. These lines create an
application called hello and configure
it's deployment directory to be <filename>helloapp</filename>:
<programlisting>
<![CDATA[
<Call name="addWebApplication">
<Arg>/hello/*</Arg>
<Arg><SystemProperty name="jetty.home" default="."/>/webapps/helloapp/</Arg>
<Arg><SystemProperty name="jetty.home" default="."/>/etc/webdefault.xml/</Arg>
</Call>
]]>
</programlisting>
</para>
</listitem>
<listitem>
<para>
Save the changes to
<filename>jetty.xml</filename>
</para>
</listitem>
<listitem>
<para>
Create the directory
<filename>%JBOSS_HOME%/jetty-dir/webapps/helloapp</filename>
</para>
</listitem>
<listitem>
<para>
Create (or copy) a
<filename>.jsp</filename> file inside the newly created directory. Call this file
<filename>sample.jsp</filename>.
</para>
</listitem>
<listitem>
<para>
Make sure that you have a JDK
installed on the server.
</para>
</listitem>
<listitem>
<para>
On the JBoss-Jetty computer, start
jBoss/Jetty and surf to
<filename>http://localhost/hello/sample.jsp</filename>
</para>
</listitem>
<listitem>
<para>
You should find that the
<filename>sample.jsp</filename> file is automatically compiled and
it's output is displayed in your
browser.
</para>
</listitem>
</orderedlist>
<para>
The <filename>sample.jsp</filename> file was compiled
by default because you used
<filename>/etc/webdefault.xml</filename> as the third
argument of the <filename>addWebApplication</filename>
call above. Have a look at the contents of the file
<filename>%JBOSS_HOME%/jetty-dir/etc/webdefault.xml</filename> if you want learn more
about how to map calls
to a servlet (all .jsp files are processed by a
servlet that compiles them first according to webdefault.xml).
</para>
<para>
If you want to add more jsp-files, just drop them in
the <filename>helloapp</filename> directory and do as
you did with <filename>sample.jsp</filename>
previously.
</para>
</section>
</section>
<section id="howto-jbossjetty-configure">
<title>Configure your JBoss-Jetty installation</title>
<para>
</para>
</section>
<section id="howto-jbossjetty-trouble">
<title>JBoss-Jetty troubleshooting tips</title>
<para>
</para>
</section>
</section>
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/jboss-development
