[jboss-cvs] JBossAS SVN: r81999 - in projects/docs/community/5: Administration_And_Configuration_Guide/en-US and 3 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Dec 3 01:58:35 EST 2008
Author: skittoli at redhat.com
Date: 2008-12-03 01:58:34 -0500 (Wed, 03 Dec 2008)
New Revision: 81999
Added:
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/FAQ.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Pooling.xml
Modified:
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Administration_And_Configuration_Guide.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Book_Info.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/EJB3.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Transactions.xml
projects/docs/community/5/Administration_And_Configuration_Guide/en-US/resolved.xml
projects/docs/community/5/Administration_And_Configuration_Guide/pom.xml
projects/docs/community/5/Clustering_Guide/en-US/Book_Info.xml
projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml
projects/docs/community/5/Clustering_Guide/pom.xml
projects/docs/community/5/Installation_And_Getting_Started_Guide/en-US/About_the_Example_Applications.xml
Log:
updates
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Administration_And_Configuration_Guide.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Administration_And_Configuration_Guide.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Administration_And_Configuration_Guide.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -37,22 +37,23 @@
<xi:include href="Messaging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Alternative_DBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Pooling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="FAQ.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
+
-
-
<part id="Clustering" label="III">
<title>Clustering Guide</title>
<!--<xi:include href="Clustering_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <xi:include href="Clustering_Guide_Intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_JNDI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_EJBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_Entity_EJBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_HTTP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_JMS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Clustering_Guide_JBoss_Cache_JGroups.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_Intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_EJBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_Entity_EJBs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_HTTP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JMS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JBoss_Cache_JGroups.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
<!--<part id="Perfomance" label="IV">
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Alternative_DBs.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -648,7 +648,7 @@
<section>
<title>Specify Database Dialect for Java Persistence API</title>
- <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss AS. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <varname><JBoss_Home>/server/all/deploy/ejb3.deployer/META-INF/persistence.properties</varname> file. You need to un-comment the <varname>hibernate.dialect</varname> property and change its value to the following based on the database you setup. For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.</para>
+ <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss AS. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <literal><JBoss_Home>/server/all/deploy/ejb3.deployer/META-INF/persistence.properties</literal> file. You need to un-comment the <literal>hibernate.dialect</literal> property and change its value to the following based on the database you setup. For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.</para>
<itemizedlist>
<listitem><para>Oracle 9i: org.hibernate.dialect.Oracle9iDialect</para></listitem>
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Book_Info.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Book_Info.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Book_Info.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -3,14 +3,16 @@
]>
<bookinfo id="JBoss_Application_Server">
- <title>JBoss Application Server 5.0.0</title>
- <subtitle>Administration And Development Guide</subtitle>
- <issuenum>5.0</issuenum>
- <productnumber>0</productnumber>
- <pubdate>Mar 2008</pubdate>
+ <title>Administration And Configuration Guide</title>
+
+ <edition>2</edition>
+ <pubsnumber>2</pubsnumber>
+ <productname>JBoss Application Server</productname>
+ <productnumber>5</productnumber>
+ <pubdate>Nov 2008</pubdate>
<abstract>
<para>
- This book is a <literal>"Work In Progress"</literal> guide to the administration and configuration of the JBoss Application Server 5.
+ This book is a guide to the administration and configuration of the JBoss Application Server 5.
</para>
</abstract>
<subtitle>Authors</subtitle>
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/EJB3.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/EJB3.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/EJB3.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -41,11 +41,11 @@
<para>After you define a session bean, how does the client get a reference to it? As we discussed, the client does not create or destroy EJB3 components, it merely asks the server for a reference of an existing instance managed by the server. That is done via JNDI. In JBoss AS, the default local JNDI name for a session bean is dependent on the deployment packaging of the bean class.</para>
<itemizedlist>
- <listitem><para>If the bean is deployed in a standalone JAR file in the <varname>JBOSS_DIST/default/deploy</varname> directory, the bean is accessible via local JNDI name <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name of the bean as we showed earlier. The "local" JNDI in JBoss AS means that the JNDI name is relative to <varname>java:comp/env/</varname>.</para></listitem>
- <listitem><para>If the JAR file containing the bean is packaged in an EAR file, the local JNDI name for the bean is <varname>myapp/MyBean/local</varname>, where <varname>myapp</varname> is the root name of the EAR archive file (e.g., <varname>myapp.ear</varname>, see later for the EAR packaging of EJB3 beans). </para></listitem>
+ <listitem><para>If the bean is deployed in a standalone JAR file in the <literal>JBOSS_DIST/default/deploy</literal> directory, the bean is accessible via local JNDI name <literal>MyBean/local</literal>, where <literal>MyBean</literal> is the implementation class name of the bean as we showed earlier. The "local" JNDI in JBoss AS means that the JNDI name is relative to <literal>java:comp/env/</literal>.</para></listitem>
+ <listitem><para>If the JAR file containing the bean is packaged in an EAR file, the local JNDI name for the bean is <literal>myapp/MyBean/local</literal>, where <literal>myapp</literal> is the root name of the EAR archive file (e.g., <literal>myapp.ear</literal>, see later for the EAR packaging of EJB3 beans). </para></listitem>
</itemizedlist>
- <para>Of course, you should change <varname>local</varname> to <varname>remote</varname> if the bean interface is annotated with <varname>@Remote</varname> and the bean is accessed from outside of the server it is deployed on. Below is the code snippet to get a reference of the MyBean bean in a web application (e.g., in a servlet or a JSF backing bean) packaged in <varname>myapp.ear</varname>, and then invoke a managed method.</para>
+ <para>Of course, you should change <literal>local</literal> to <literal>remote</literal> if the bean interface is annotated with <literal>@Remote</literal> and the bean is accessed from outside of the server it is deployed on. Below is the code snippet to get a reference of the MyBean bean in a web application (e.g., in a servlet or a JSF backing bean) packaged in <literal>myapp.ear</literal>, and then invoke a managed method.</para>
<programlisting>
<![CDATA[
@@ -66,7 +66,7 @@
<para>What the client gets from the JNDI is essentially a "stub" or "proxy" of the bean instance. When the client invokes a method, the proxy figures out how to route the request to the server and marshal together the response.</para>
- <para>If you do not like the default JNDI names, you can always specify your own JNDI binding for any bean via the <varname>@LocalBinding</varname> annotation on the bean implementation class. The JNDI binding is always "local" under the <varname>java:comp/env/</varname> space. For instance, the following bean class definition results in the bean instances available under JNDI name <varname>java:comp/env/MyService/MyOwnName</varname>.</para>
+ <para>If you do not like the default JNDI names, you can always specify your own JNDI binding for any bean via the <literal>@LocalBinding</literal> annotation on the bean implementation class. The JNDI binding is always "local" under the <literal>java:comp/env/</literal> space. For instance, the following bean class definition results in the bean instances available under JNDI name <literal>java:comp/env/MyService/MyOwnName</literal>.</para>
<programlisting>
<![CDATA[
@@ -276,7 +276,7 @@
<section>
<title>Default Hibernate options</title>
- <para>Hibernate has many configuration properties. For the properties that you do not specify in the persistence.xml file, JBoss AS will provide a reasonable set of default values. The default Hibernate property values are specified in the <varname>JBOSS_DIST/server/default/deploy/ejb3.deployer/MEAT-INF/persistence.properties</varname> file. Below is the <varname>persistence.properties</varname> file bundled in JBoss AS 4.2. Notice the options that are commented out. They give you an idea of available properties in your <varname>persistence.xml</varname> file.</para>
+ <para>Hibernate has many configuration properties. For the properties that you do not specify in the persistence.xml file, JBoss AS will provide a reasonable set of default values. The default Hibernate property values are specified in the <literal>JBOSS_DIST/server/default/deploy/ejb3.deployer/MEAT-INF/persistence.properties</literal> file. Below is the <literal>persistence.properties</literal> file bundled in JBoss AS 4.2. Notice the options that are commented out. They give you an idea of available properties in your <literal>persistence.xml</literal> file.</para>
<programlisting>
<![CDATA[
@@ -309,7 +309,7 @@
<section id="EJB3_Services-Message_Driven_Beans">
<title>Message Driven Beans</title>
- <para>Messaging driven beans are specialized EJB3 beans that receive service requests via JMS messages instead of proxy method calls from the "stub". So, a crucial configuration parameter for the message driven bean is to specify which JMS message queue its listens to. When there is an incoming message in the queue, the server invokes the beans's <varname>onMessage()</varname> method, and passes in the message itself for processing. The bean class specifies the JMS queue it listens to in the @MessageDriven annotation. The queue is registered under the local JNDI java:comp/env/ name space.</para>
+ <para>Messaging driven beans are specialized EJB3 beans that receive service requests via JMS messages instead of proxy method calls from the "stub". So, a crucial configuration parameter for the message driven bean is to specify which JMS message queue its listens to. When there is an incoming message in the queue, the server invokes the beans's <literal>onMessage()</literal> method, and passes in the message itself for processing. The bean class specifies the JMS queue it listens to in the @MessageDriven annotation. The queue is registered under the local JNDI java:comp/env/ name space.</para>
<programlisting>
<![CDATA[
@@ -368,7 +368,7 @@
<section>
<title>Deploy the EJB3 JAR</title>
- <para>When you drop JAR files into the <varname>JBOSS_DIST/server/default/deploy/</varname> directory, it will be automatically picked up and processed by the server. All the EJB3 beans defined in the JAR file will then be available to other applications deployed inside or outside of the server via JNDI names like <varname>MyBean/local</varname>, where <varname>MyBean</varname> is the implementation class name for the session bean. The deployment is done via the JBoss EJB3 deployer in JBOSS_DIST/server/default/ejb3.deployer/. The META-INF/persistence.properties file we discussed earlier to configure the default behavior of EJB3 entity manager is located in the EJB3 deployer.</para>
+ <para>When you drop JAR files into the <literal>JBOSS_DIST/server/default/deploy/</literal> directory, it will be automatically picked up and processed by the server. All the EJB3 beans defined in the JAR file will then be available to other applications deployed inside or outside of the server via JNDI names like <literal>MyBean/local</literal>, where <literal>MyBean</literal> is the implementation class name for the session bean. The deployment is done via the JBoss EJB3 deployer in JBOSS_DIST/server/default/ejb3.deployer/. The META-INF/persistence.properties file we discussed earlier to configure the default behavior of EJB3 entity manager is located in the EJB3 deployer.</para>
<para>The EJB3 deployer automatically scans JARs on the classpath to look for EJB3 annotations. When it finds classes with EJB3 annotations, it would deploy them as EJB3 services. However, scanning all JARs on the classpath could be very time-consuming if you have large applications with many JARs deployed. In the JBOSS_DIST/server/default/ejb3.deployer/META-INF/jboss-service.xml file, you can tell the EJB3 deployer to ignore JARs you know do not contain EJB3 beans. The non-EJB3 JAR files shipped with the JBoss AS are already listed in the jboss.ejb3:service=JarsIgnoredForScanning MBean service:</para>
Added: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/FAQ.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/FAQ.xml (rev 0)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/FAQ.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -0,0 +1,47 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+ ]>
+
+<chapter id="faq">
+ <title>Frequently Asked Questions</title>
+ <section><title>I have problems with Oracle XA?</title>
+ <para>
+ Check that you:
+ <orderedlist>
+ <listitem>
+ <para> You have pad=true for the XidFactory? in conf/jboss-service.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <track-connection-by-tx/> in your oracle-xa-ds.xml (not necessarily for JBoss-5.x where it is enabled by default and the element is deprecated).
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <isSameRM-override-value>false</isSameRM-override-value> in your oracle-xa-ds.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <no-tx-separate-pools/> in your oracle-xa-ds.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>That your jbosscmp-jdbc.xml is specifying the same version of oracle as the one you use.
+ </para>
+ </listitem>
+ <listitem>
+ <para>That the oracle server you connect to has XA.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ Configuring Oracle Database for XA Support You can configure Oracle database to support XA resources. This enables you to use JDBC 2.0-compliant Oracle driver. To XA-initialize Oracle database, complete the following steps:
+ </para>
+ <para>
+ Make sure that Oracle JServer is installed with your database. If it is not installed, you must add it using Oracle Database Configuration Assistant. Choose "Change an Existing DB" and then select the database to which you want to add Oracle JServer. Choose "Next", then "Oracle JServer" and then "Finish". If the settings you have made to your database previously, are not suitable or insufficient for the Oracle JServer installation, the system prompts you to enter additional parameters. The database configuration file ( init.ora ) is located in <literal>\oracle\admin\<your_db_name>\pfile</literal> directory. Execute initxa.sql over your database. By default, this script file is located in <literal>\oracle\ora81\javavm\install</literal>. If errors occur during the execution of the file, you must execute the SQL statements from the file manually. Use DBA Studio to create a package and package body named JAVA_XA in SYS schema, and a synonym of this package (also named J!
AVA_XA) in PUBLIC schema.
+ </para>
+ <para>A slightly more detailed set of instructions can be found at <ulink url="http://www.ibm.com/developerworks/websphere/library/techarticles/0407_woolf/0407_woolf.html?ca=dnp-327#oracle_exception">Configuring and using XA distributed transactions in WebSphere Studio - Oracle Exception section</ulink>.</para>
+ </section>
+
+
+
+</chapter>
Added: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Pooling.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Pooling.xml (rev 0)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Pooling.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -0,0 +1,232 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+ ]>
+
+<chapter id="pooling">
+<title>Pooling</title>
+<section><title>Strategy</title>
+<para>
+<ulink url="http://www.jboss.org/wiki/JBossJCA">JBossJCA</ulink> uses a <literal>ManagedConnectionPool</literal> to perform the pooling. The <literal>ManagedConnectionPool</literal> is made up of subpools depending upon the strategy chosen and other pooling parameters.
+</para>
+
+<informaltable frame="all">
+<tgroup cols="5"><tbody>
+<row>
+<entry>
+<para>xml</para>
+</entry>
+<entry>
+<para>mbean</para>
+</entry>
+<entry>
+<para>Internal Name</para>
+</entry>
+<entry>
+<para>Description</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para/>
+</entry>
+<entry>
+<para>ByNothing</para>
+</entry>
+<entry>
+<para>OnePool</para>
+</entry>
+<entry>
+<para>A single pool of equivalent connections</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><application-managed-security/></para>
+</entry>
+<entry>
+<para>ByApplication</para>
+</entry>
+<entry>
+<para>PoolByCRI</para>
+</entry>
+<entry>
+<para>Use the connection properties from allocateConnection()</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain/></para>
+</entry>
+<entry>
+<para>ByContainer</para>
+</entry>
+<entry>
+<para>PoolBySubject</para>
+</entry>
+<entry>
+<para>A pool per Subject, e.g. preconfigured or EJB/Web login subjects</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain-and-applicaton/></para>
+</entry>
+<entry>
+<para>ByContainerAndApplicaton</para>
+</entry>
+<entry>
+<para>PoolBySubjectAndCri</para>
+</entry>
+<entry>
+<para>A per Subject and connection property combination</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row></tbody></tgroup>
+</informaltable>
+
+<note><title>Note</title>
+<para>The xml names imply this is just about security. This is misleading. </para>
+</note>
+
+<para>
+For <security-domain-and-application/> the Subject always overrides any user/password from createConnection(user, password) in the CRI: </para>
+
+<screen>(
+ConnectionRequestInfo
+) </screen>
+</section>
+
+
+<section><title>Transaction stickness</title>
+<para>
+You can force the same connection from a (sub-)pool to get reused throughout a transaction with the <track-connection-by-tx/> flag
+</para>
+
+<note><title>Note</title>
+<para>This is the only supported behaviour for <emphasis>"local"</emphasis> transactions. This element is deprecated in JBoss-5.x where transaction stickiness is enabled by default. XA users can explicitly enable interleaving with <interleaving/> element.</para>
+</note>
+</section>
+
+<section><title>Workaround for Oracle</title>
+<para>Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts using <no-tx-separate-pools/>.</para>
+</section>
+
+<section><title>Pool Access</title>
+<para>
+The pool is designed for concurrent usage.
+</para>
+
+<para>
+Upto <max-pool-size/> threads can be inside the pool at the same time (or using connections from a pool).
+</para>
+<para>
+Once this limit is reached, threads wait for the <blocking-timeout-seconds/> to use the pool before throwing a <ulink url="http://www.jboss.org/wiki/WhatDoesTheMessageNoManagedConnectionsAvailableMean">No Managed Connections Available</ulink>
+</para>
+</section>
+
+<section><title>Pool Filling</title>
+<para>
+The number of connections in the pool is controlled by the pool sizes.
+</para>
+<itemizedlist>
+<listitem>
+<para><min-pool-size/> - When the number of connections falls below this size, new connections are created</para>
+</listitem>
+<listitem>
+<para><max-pool-size/> - No more than this number of connections are created</para>
+</listitem>
+<listitem>
+<para><prefill/> - Feature Request has been implemented for 4.0.5. Note: the only pooling strategy that supports this feature is OnePool?, or ByNothing? pooling criteria.</para>
+</listitem>
+</itemizedlist>
+<para>
+The pool filling is done by a separate "Pool Filler" thread rather than blocking application threads.</para>
+</section>
+
+<section><title>Idle Connections</title>
+<para>
+You can configure connections to be closed when they are idle. e.g. If you just had a peak period and now want to reap the unused ones. This is done via the <idle-timeout-minutes/>.</para>
+
+<para>
+Idle checking is done on a separate "Idle Remover" thread on an LRU (least recently used) basis. The check is done every idle-timeout-minutes divided by 2 for connections unused for idle-timeout-minutes.</para>
+<para>
+The pool itself operates on an MRU (most recently used) basis. This allows the excess connections to be easily identified.
+</para>
+<para>
+Should closing idle connections cause the pool to fall below the min-pool-size, new/fresh connections are created.
+</para>
+<note><title>Note</title>
+<para>If you have long running transactions and you use interleaving (i.e. don't track-connection-by-tx) make sure the idle timeout is greater than the transaction timeout. When interleaving the connection is returned to the pool for others to use. If however nobody does use it, it would be a candidate for removal before the transaction is committed.
+</para>
+</note>
+</section>
+
+<section><title>Dead connections</title>
+<para>
+The JDBC protocol does not provide a natural <literal>connectionErrorOccured()</literal> event when a connection is broken. To support dead/broken connection checking there are a number of plugins.</para>
+
+<section><title>Valid connection checking</title>
+<para>
+The simplest format is to just run a "quick" sql statement:
+
+<screen><check-valid-connection-sql>select 1 from dual</check-valid-connection-sql></screen>
+
+before handing the connection to the application. If this fails, another connection is selected until there are no more connections at which point new connections are constructed.
+</para>
+
+<para>
+The potentially more performant check is to use vendor specific features, e.g. Oracle's or MySQL's pingDatabase() via the
+<screen><valid-connection-checker-class-name/></screen>
+</para>
+</section>
+
+<section><title>Errors during SQL queries</title>
+<para>
+You can check if a connection broke during a query by the looking the error codes or messages of the SQLException for FATAL errors rather than normal SQLExceptions. These codes/messages can be vendor specific, e.g.
+<screen><exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter</exception-sorter-class-name></screen>
+
+For
+
+<screen>FATAL</screen>
+
+errors the connection will be closed.</para>
+</section>
+
+<section><title>Changing/Closing/Flushing the pool</title>
+
+<itemizedlist>
+<listitem>
+<para><ulink url="http://www.jboss.org/wiki/HowDoIChangeThePoolingParameters">change or flush()</ulink> the pool</para>
+</listitem>
+<listitem>
+<para>closing/undeploying the pool will do a flush first</para>
+</listitem>
+</itemizedlist>
+
+</section>
+
+<section><title>Other pooling</title>
+<para><ulink url="http://www.jboss.org/wiki/IWantToPluginACustomThirdpartyDataSource">Thirdparty Pools</ulink> - only if you know what you are doing</para>
+
+</section>
+</section>
+
+
+
+
+
+</chapter>
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Transactions.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Transactions.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/Transactions.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -4,10 +4,18 @@
<chapter id="transaction"><title>JBoss Transactions</title>
<para>JBoss Transactions runs in the <emphasis>all</emphasis> server configurations or customized configurations based on the <emphasis>all</emphasis> configuration. </para>
-<para>
-<inlinegraphic fileref="images/transactions-architecture.png" width=""/>
-</para>
+
+<figure id="transactions_architecture">
+ <title>Transactions Architecture</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/transactions-architecture.png" />
+ </imageobject>
+ </mediaobject>
+</figure>
+
+
<section><title>Why do you need JBoss Transaction</title>
<para>
In todays business environment data corruption can have serious consequences for the enterprise including service unavailability, system reconciliation costs, and damage to customer relationships and business reputation. The JBoss Transaction Service (JBossTS) protects businesses from data corruption by guaranteeing complete, accurate business transactions for Java based applications (including those written for the JEE and EJB frameworks) thereby eliminating the risks and costs associated with time-consuming manual reconciliation following failures.
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/en-US/resolved.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/en-US/resolved.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/en-US/resolved.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -2,14 +2,16 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<book><!--<title>JBoss AS 5 Administration and Configuration Guide</title>-->
<bookinfo id="JBoss_Application_Server">
- <title>JBoss Application Server 5.0.0</title>
- <subtitle>Administration And Development Guide</subtitle>
- <issuenum>5.0</issuenum>
- <productnumber>0</productnumber>
- <pubdate>Mar 2008</pubdate>
+ <title>Administration And Configuration Guide</title>
+
+ <edition>2</edition>
+ <pubsnumber>2</pubsnumber>
+ <productname>JBoss Application Server</productname>
+ <productnumber>5</productnumber>
+ <pubdate>Nov 2008</pubdate>
<abstract>
<para>
- This book is a <literal>"Work In Progress"</literal> guide to the administration and configuration of the JBoss Application Server 5.
+ This book is a guide to the administration and configuration of the JBoss Application Server 5.
</para>
</abstract>
<subtitle>Authors</subtitle>
@@ -5085,10 +5087,18 @@
<chapter id="transaction"><title>JBoss Transactions</title>
<para>JBoss Transactions runs in the <emphasis>all</emphasis> server configurations or customized configurations based on the <emphasis>all</emphasis> configuration. </para>
-<para>
-<inlinegraphic fileref="images/transactions-architecture.png" width=""/>
-</para>
+
+<figure id="transactions_architecture">
+ <title>Transactions Architecture</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/transactions-architecture.png"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+
<section><title>Why do you need JBoss Transaction</title>
<para>
In todays business environment data corruption can have serious consequences for the enterprise including service unavailability, system reconciliation costs, and damage to customer relationships and business reputation. The JBoss Transaction Service (JBossTS) protects businesses from data corruption by guaranteeing complete, accurate business transactions for Java based applications (including those written for the JEE and EJB frameworks) thereby eliminating the risks and costs associated with time-consuming manual reconciliation following failures.
@@ -5515,12 +5525,12 @@
</itemizedlist>
</para>
<para>
- JBoss Messaging will be the default JMS provider in later versions of JBoss Enterprise Application Platform, and JBoss Service Integration Platform. It will also be the default JMS provider in JBoss Application Server 5, and is the default JMS provider for JBoss ESB.</para>
+ JBoss Messaging will be the default JMS provider in later versions of JBoss Enterprise Application Platform, and JBoss Service Integration Platform. It is also the default JMS provider in JBoss Application Server 5, and is the default JMS provider for JBoss ESB.</para>
<para>JBoss Messaging is an integral part of Red Hat's strategy for messaging.</para>
<para>Compared with JBossMQ, JBoss Messaging offers improved performance in both single node and clustered environments.</para>
<para>JBoss Messaging also features a much better modular architecture that will allow us to add more features in the future.</para>
<para>JBoss Messaging provides an open source and standards-based messaging platform that brings enterprise-class messaging to the mass market. It also implements a high performance, robust messaging core that is designed to support the largest and most heavily utilized SOAs, enterprise service buses (ESBs) and other integration needs ranging from the simplest to the highest demand networks.</para>
-<para>It will allow you to smoothly distribute your application load across your cluster, intelligently balancing and utilizing each nodes CPU cycles, with no single point of failure, providing a highly scalable and performant clustering implementation.</para>
+<para>It allows you to smoothly distribute your application load across your cluster, intelligently balancing and utilizing each nodes CPU cycles, with no single point of failure, providing a highly scalable and performance clustering implementation.</para>
<para>JBoss Messaging includes a JMS front-end to deliver messaging in a standards-based format as well as being designed to be able to support other messaging protocols in the future.</para>
<para>JBoss Messaging is destined to become an integral part of the JBoss Enterprise Application Platform, and the new Service Integration Platform.</para>
<para>JBoss Messaging is also an integral part of Red Hat's strategy for messaging. JBoss Messaging is committed to AMQP ( <ulink url="http://www.amqp.org/">AMQP</ulink>)- the new messaging standard from Red Hat and others. Later versions of JBoss Messaging will support AMQP, and JBoss Messaging will be focussed on becoming the premier AMQP Java broker.</para>
@@ -6613,7 +6623,7 @@
<section>
<title>Specify Database Dialect for Java Persistence API</title>
- <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss AS. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <varname><JBoss_Home>/server/all/deploy/ejb3.deployer/META-INF/persistence.properties</varname> file. You need to un-comment the <varname>hibernate.dialect</varname> property and change its value to the following based on the database you setup. For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.</para>
+ <para>The Java Persistence API (JPA) entity manager can save EJB3 entity beans to any backend database. Hibernate provides the JPA implementation in JBoss AS. Hibernate has a dialect auto-detection mechanism that works for most databases including the dialects for databases referenced in this appendix which are listed below. If a specific dialect is needed for alternative databases, you can configure the database dialect in the <literal><JBoss_Home>/server/all/deploy/ejb3.deployer/META-INF/persistence.properties</literal> file. You need to un-comment the <literal>hibernate.dialect</literal> property and change its value to the following based on the database you setup. For a complete list of dialects, refer to the Hibernate Reference Guide, Chapter 3, Section 4.1 SQL Dialects.</para>
<itemizedlist>
<listitem><para>Oracle 9i: org.hibernate.dialect.Oracle9iDialect</para></listitem>
@@ -7185,16 +7195,286 @@
</chapter>
+ <chapter id="pooling">
+<title>Pooling</title>
+<section><title>Strategy</title>
+<para>
+<ulink url="http://www.jboss.org/wiki/JBossJCA">JBossJCA</ulink> uses a <literal>ManagedConnectionPool</literal> to perform the pooling. The <literal>ManagedConnectionPool</literal> is made up of subpools depending upon the strategy chosen and other pooling parameters.
+</para>
+
+<informaltable frame="all">
+<tgroup cols="5"><tbody>
+<row>
+<entry>
+<para>xml</para>
+</entry>
+<entry>
+<para>mbean</para>
+</entry>
+<entry>
+<para>Internal Name</para>
+</entry>
+<entry>
+<para>Description</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para/>
+</entry>
+<entry>
+<para>ByNothing</para>
+</entry>
+<entry>
+<para>OnePool</para>
+</entry>
+<entry>
+<para>A single pool of equivalent connections</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><application-managed-security/></para>
+</entry>
+<entry>
+<para>ByApplication</para>
+</entry>
+<entry>
+<para>PoolByCRI</para>
+</entry>
+<entry>
+<para>Use the connection properties from allocateConnection()</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain/></para>
+</entry>
+<entry>
+<para>ByContainer</para>
+</entry>
+<entry>
+<para>PoolBySubject</para>
+</entry>
+<entry>
+<para>A pool per Subject, e.g. preconfigured or EJB/Web login subjects</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row>
+<row>
+<entry>
+<para><security-domain-and-applicaton/></para>
+</entry>
+<entry>
+<para>ByContainerAndApplicaton</para>
+</entry>
+<entry>
+<para>PoolBySubjectAndCri</para>
+</entry>
+<entry>
+<para>A per Subject and connection property combination</para>
+</entry>
+<entry>
+<para/>
+</entry>
+</row></tbody></tgroup>
+</informaltable>
+
+<note><title>Note</title>
+<para>The xml names imply this is just about security. This is misleading. </para>
+</note>
+
+<para>
+For <security-domain-and-application/> the Subject always overrides any user/password from createConnection(user, password) in the CRI: </para>
+
+<screen>(
+ConnectionRequestInfo
+) </screen>
+</section>
+
+
+<section><title>Transaction stickness</title>
+<para>
+You can force the same connection from a (sub-)pool to get reused throughout a transaction with the <track-connection-by-tx/> flag
+</para>
+
+<note><title>Note</title>
+<para>This is the only supported behaviour for <emphasis>"local"</emphasis> transactions. This element is deprecated in JBoss-5.x where transaction stickiness is enabled by default. XA users can explicitly enable interleaving with <interleaving/> element.</para>
+</note>
+</section>
+
+<section><title>Workaround for Oracle</title>
+<para>Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts using <no-tx-separate-pools/>.</para>
+</section>
+
+<section><title>Pool Access</title>
+<para>
+The pool is designed for concurrent usage.
+</para>
+
+<para>
+Upto <max-pool-size/> threads can be inside the pool at the same time (or using connections from a pool).
+</para>
+<para>
+Once this limit is reached, threads wait for the <blocking-timeout-seconds/> to use the pool before throwing a <ulink url="http://www.jboss.org/wiki/WhatDoesTheMessageNoManagedConnectionsAvailableMean">No Managed Connections Available</ulink>
+</para>
+</section>
+
+<section><title>Pool Filling</title>
+<para>
+The number of connections in the pool is controlled by the pool sizes.
+</para>
+<itemizedlist>
+<listitem>
+<para><min-pool-size/> - When the number of connections falls below this size, new connections are created</para>
+</listitem>
+<listitem>
+<para><max-pool-size/> - No more than this number of connections are created</para>
+</listitem>
+<listitem>
+<para><prefill/> - Feature Request has been implemented for 4.0.5. Note: the only pooling strategy that supports this feature is OnePool?, or ByNothing? pooling criteria.</para>
+</listitem>
+</itemizedlist>
+<para>
+The pool filling is done by a separate "Pool Filler" thread rather than blocking application threads.</para>
+</section>
+
+<section><title>Idle Connections</title>
+<para>
+You can configure connections to be closed when they are idle. e.g. If you just had a peak period and now want to reap the unused ones. This is done via the <idle-timeout-minutes/>.</para>
+
+<para>
+Idle checking is done on a separate "Idle Remover" thread on an LRU (least recently used) basis. The check is done every idle-timeout-minutes divided by 2 for connections unused for idle-timeout-minutes.</para>
+<para>
+The pool itself operates on an MRU (most recently used) basis. This allows the excess connections to be easily identified.
+</para>
+<para>
+Should closing idle connections cause the pool to fall below the min-pool-size, new/fresh connections are created.
+</para>
+<note><title>Note</title>
+<para>If you have long running transactions and you use interleaving (i.e. don't track-connection-by-tx) make sure the idle timeout is greater than the transaction timeout. When interleaving the connection is returned to the pool for others to use. If however nobody does use it, it would be a candidate for removal before the transaction is committed.
+</para>
+</note>
+</section>
+
+<section><title>Dead connections</title>
+<para>
+The JDBC protocol does not provide a natural <literal>connectionErrorOccured()</literal> event when a connection is broken. To support dead/broken connection checking there are a number of plugins.</para>
+
+<section><title>Valid connection checking</title>
+<para>
+The simplest format is to just run a "quick" sql statement:
+
+<screen><check-valid-connection-sql>select 1 from dual</check-valid-connection-sql></screen>
+
+before handing the connection to the application. If this fails, another connection is selected until there are no more connections at which point new connections are constructed.
+</para>
+
+<para>
+The potentially more performant check is to use vendor specific features, e.g. Oracle's or MySQL's pingDatabase() via the
+<screen><valid-connection-checker-class-name/></screen>
+</para>
+</section>
+
+<section><title>Errors during SQL queries</title>
+<para>
+You can check if a connection broke during a query by the looking the error codes or messages of the SQLException for FATAL errors rather than normal SQLExceptions. These codes/messages can be vendor specific, e.g.
+<screen><exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter</exception-sorter-class-name></screen>
+
+For
+
+<screen>FATAL</screen>
+
+errors the connection will be closed.</para>
+</section>
+
+<section><title>Changing/Closing/Flushing the pool</title>
+
+<itemizedlist>
+<listitem>
+<para><ulink url="http://www.jboss.org/wiki/HowDoIChangeThePoolingParameters">change or flush()</ulink> the pool</para>
+</listitem>
+<listitem>
+<para>closing/undeploying the pool will do a flush first</para>
+</listitem>
+</itemizedlist>
+
+</section>
+
+<section><title>Other pooling</title>
+<para><ulink url="http://www.jboss.org/wiki/IWantToPluginACustomThirdpartyDataSource">Thirdparty Pools</ulink> - only if you know what you are doing</para>
+
+</section>
+</section>
+
+
+
+
+
+</chapter>
+ <chapter id="faq">
+ <title>Frequently Asked Questions</title>
+ <section><title>I have problems with Oracle XA?</title>
+ <para>
+ Check that you:
+ <orderedlist>
+ <listitem>
+ <para> You have pad=true for the XidFactory? in conf/jboss-service.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <track-connection-by-tx/> in your oracle-xa-ds.xml (not necessarily for JBoss-5.x where it is enabled by default and the element is deprecated).
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <isSameRM-override-value>false</isSameRM-override-value> in your oracle-xa-ds.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>You have <no-tx-separate-pools/> in your oracle-xa-ds.xml.
+ </para>
+ </listitem>
+ <listitem>
+ <para>That your jbosscmp-jdbc.xml is specifying the same version of oracle as the one you use.
+ </para>
+ </listitem>
+ <listitem>
+ <para>That the oracle server you connect to has XA.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ Configuring Oracle Database for XA Support You can configure Oracle database to support XA resources. This enables you to use JDBC 2.0-compliant Oracle driver. To XA-initialize Oracle database, complete the following steps:
+ </para>
+ <para>
+ Make sure that Oracle JServer is installed with your database. If it is not installed, you must add it using Oracle Database Configuration Assistant. Choose "Change an Existing DB" and then select the database to which you want to add Oracle JServer. Choose "Next", then "Oracle JServer" and then "Finish". If the settings you have made to your database previously, are not suitable or insufficient for the Oracle JServer installation, the system prompts you to enter additional parameters. The database configuration file ( init.ora ) is located in <literal>\oracle\admin\<your_db_name>\pfile</literal> directory. Execute initxa.sql over your database. By default, this script file is located in <literal>\oracle\ora81\javavm\install</literal>. If errors occur during the execution of the file, you must execute the SQL statements from the file manually. Use DBA Studio to create a package and package body named JAVA_XA in SYS schema, and a synonym of this package (also named J!
AVA_XA) in PUBLIC schema.
+ </para>
+ <para>A slightly more detailed set of instructions can be found at <ulink url="http://www.ibm.com/developerworks/websphere/library/techarticles/0407_woolf/0407_woolf.html?ca=dnp-327#oracle_exception">Configuring and using XA distributed transactions in WebSphere Studio - Oracle Exception section</ulink>.</para>
+ </section>
+
+
+
+</chapter>
</part>
+
-
-
<part id="Clustering" label="III">
<title>Clustering Guide</title>
<!--<xi:include href="Clustering_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <chapter id="cluster.chapt">
+ <chapter id="cluster.chapt" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_Intro.xml">
<title>Clustering</title>
<subtitle>High Availability Enterprise Services via JBoss Clusters</subtitle>
@@ -7513,7 +7793,7 @@
</section>
</section>
</chapter>
- <chapter id="clustering-jndi">
+ <chapter id="clustering-jndi" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml">
<title>Clustered JNDI Services</title>
<para>
JNDI is one of the most important services provided by the application server. The JBoss HA-JNDI (High Availability JNDI) service brings the following features to JNDI:</para>
@@ -7942,7 +8222,7 @@
</section>
</chapter>
- <chapter id="clustering-session">
+ <chapter id="clustering-session" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_EJBs.xml">
<title>Clustered Session EJBs</title>
<para>Session EJBs provide remote invocation services. They are clustered based on the client-side
interceptor architecture. The client application for a clustered session bean is exactly the same as the
@@ -8435,7 +8715,7 @@
</itemizedlist>
</section>
</chapter>
- <chapter id="clustering-entity">
+ <chapter id="clustering-entity" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_Entity_EJBs.xml">
<title>Clustered Entity EJBs</title>
<para>In a JBoss AS cluster, the entity bean instance caches need to be kept in sync across all nodes. If an entity bean provides remote services, the service methods need to be load balanced as well.</para>
@@ -8808,7 +9088,7 @@
</section>
</chapter>
- <chapter id="clustering-http">
+ <chapter id="clustering-http" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_HTTP.xml">
<title>HTTP Services</title>
<para>HTTP session replication is used to replicate the state associated with your web clients on other
nodes of a cluster. Thus, in the event one of your node crashes, another node in the cluster will be
@@ -9559,7 +9839,7 @@
</chapter>
- <chapter id="clustering-jms">
+ <chapter id="clustering-jms" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JMS.xml">
<title>JBoss Messaging Clustering Notes</title>
<section><title>Unique server peer id</title>
@@ -9634,7 +9914,7 @@
</section>
</chapter>
- <chapter id="jbosscache.chapt">
+ <chapter id="jbosscache.chapt" xml:base="http://anonsvn.jboss.org/repos/jbossas/projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JBoss_Cache_JGroups.xml">
<title>JBossCache and JGroups Services</title>
<para>JGroups and JBossCache provide the underlying communication, node replication and caching services, for
JBoss AS clusters. Those services are configured as MBeans. There is a set of JBossCache and JGroups MBeans
Modified: projects/docs/community/5/Administration_And_Configuration_Guide/pom.xml
===================================================================
--- projects/docs/community/5/Administration_And_Configuration_Guide/pom.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Administration_And_Configuration_Guide/pom.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -58,11 +58,11 @@
<finalName>index.html</finalName>
</format>
- <!-- <format>
+ <format>
<formatName>pdf</formatName>
<stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource>
<finalName>Administration_And_Configuration_Guide.pdf</finalName>
- </format>-->
+ </format>
<!--<format>
<formatName>eclipse</formatName>
<stylesheetResource>classpath:/xslt/main-eclipse.xsl</stylesheetResource>
Modified: projects/docs/community/5/Clustering_Guide/en-US/Book_Info.xml
===================================================================
--- projects/docs/community/5/Clustering_Guide/en-US/Book_Info.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Clustering_Guide/en-US/Book_Info.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -3,8 +3,8 @@
<bookinfo>
<title>JBoss Application Server Clustering Guide</title>
- <issuenum>4.2</issuenum>
- <productnumber>2</productnumber>
+ <issuenum>5</issuenum>
+ <productnumber>0</productnumber>
<abstract>
<para>
This book is the Jboss Application Server clustering guide.
Modified: projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml
===================================================================
--- projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Clustering_Guide/en-US/Clustering_Guide_JNDI.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -191,7 +191,29 @@
<para>
Do not attempt to simplify things by placing a jndi.properties file in your deployment or by editing the AS's conf/jndi.properties file. Doing either will almost certainly break things for your application and quite possibly across the application server. If you want to externalize your client configuration, one approach is to deploy a properties file not named jndi.properties, and then programatically create a Properties object that loads that file's contents.
</para>
+<note><title>Note</title>
+ <para>
+ Previously, HANamingServiceMBean.bindAddress served two functions:
+
+ From <filename>trunk/cluster/src/etc/hajndi-service.xml</filename>:
+ <programlisting><!-- Bind address of bootstrap and HA-JNDI RMI endpoints -->
+ <attribute name="BindAddress">${jboss.bind.address}</attribute></programlisting>
+
+ The bootstrap and HA-JNDI RMI endpoints are now defined separately:
+ <programlisting>
+ <!-- Bind address of bootstrap endpoint -->
+ <attribute name="BindAddress">${jboss.bind.address}</attribute>
+ <!-- Bind address of the HA-JNDI RMI endpoint -->
+ <attribute name="RmiBindAddress">${jboss.bind.address}</attribute>
+ </programlisting>
+ They each default to the same value.
+ Users may want to override the RMI bind address if deployed on a multi-homed machine, and want to use an specific network interface for HA-JNDI RMI calls.
+ This ability already exists in the standard NamingService.
+ </para>
+</note>
+
+
<section><title>Accessing HA-JNDI Resources from EJBs and WARs -- Environment Naming Context</title>
<para>If your HA-JNDI client is an EJB or servlet, the least intrusive way to configure the lookup of resources is to bind the resources to the environment naming context of the bean or webapp performing the lookup. The binding can then be configured to use HA-JNDI instead of a local mapping. Following is an example of doing this for a JMS connection factory and queue (the most common use case for this kind of thing.</para>
<para>Within the bean definition in the ejb-jar.xml or in the war's web.xml you will need to define two resource-ref mappings, one for the connection factory and one for the destination.</para>
Modified: projects/docs/community/5/Clustering_Guide/pom.xml
===================================================================
--- projects/docs/community/5/Clustering_Guide/pom.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Clustering_Guide/pom.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -1,85 +1,102 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.jboss.jbossas</groupId>
+ <artifactId>clustering-guide-${translation}</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <packaging>jdocbook</packaging>
+ <name>Clustering Guide (${translation})</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jdocbook-plugin</artifactId>
+ <version>2.0.0</version>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-docbook-xslt</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss</groupId>
+ <artifactId>jbossorg-jdocbook-style</artifactId>
+ <version>1.0.0</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <!--minmemory>1024m</minmemory>
+ <maxmemory>1024m</maxmemory -->
+ <sourceDocumentName>Clustering_Guide.xml</sourceDocumentName>
+ <sourceDirectory>en-US</sourceDirectory>
+ <imageResource>
+ <directory>en-US</directory>
+ <includes>
+ <include>images/*</include>
+ </includes>
+ </imageResource>
+ <!-- <cssResource>
+ <directory>src/main/css</directory>
+ </cssResource> -->
+ <!--put back css -->
+
+ <formats>
+ <format>
+ <formatName>pdf</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource>
+ <finalName>Clustering_Guide.pdf</finalName>
+ </format>
+ <format>
+ <formatName>html</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+
+ <format>
+ <formatName>html_single</formatName>
+ <stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>
+
+ <!--<format>
+ <formatName>eclipse</formatName>
+ <stylesheetResource>classpath:/xslt/main-eclipse.xsl</stylesheetResource>
+ <finalName>index.html</finalName>
+ </format>-->
+ </formats>
+ <options>
+ <xincludeSupported>true</xincludeSupported>
+ <xmlTransformerType>saxon</xmlTransformerType>
+ <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme -->
+ <!-- could also locate the docbook dependency and inspect its version... -->
+ <!--docbookVersion>1.72.0</docbookVersion -->
+ <docbookVersion>1.72.0</docbookVersion>
+ <transformerParameters>
+ <property>
+ <name>javax.xml.parsers.DocumentBuilderFactory</name>
+ <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value>
+ </property>
+ <property>
+ <name>javax.xml.parsers.SAXParserFactory</name>
+ <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value>
+ </property>
+ <!--<javax.xml.parsers.DocumentBuilderFactory>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</javax.xml.parsers.DocumentBuilderFactory>
+ <javax.xml.parsers.SAXParserFactory>org.apache.xerces.jaxp.SAXParserFactoryImpl</javax.xml.parsers.SAXParserFactory>
+ <javax.xml.validation.SchemaFactory:http\://www.w3.org/2001/XMLSchema>org.apache.xerces.jaxp.validation.XMLSchemaFactory</javax.xml.validation.SchemaFactory:http\://www.w3.org/2001/XMLSchema>-->
+ </transformerParameters>
+ </options>
+ </configuration>
+ </plugin>
+</plugins>
+</build>
- <modelVersion>4.0.0</modelVersion>
-
-
- <groupId>org.hibernate-sandbox</groupId>
- <artifactId>docbook-testing</artifactId>
- <version>1.0-SNAPSHOT</version>
- <packaging>jdocbook</packaging>
- <name>Clustering Guide (${translation})</name>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.jboss.maven.plugins</groupId>
- <artifactId>maven-jdocbook-plugin</artifactId>
- <version>2.0.0</version>
- <extensions>true</extensions>
- <!--dependencies>
- <dependency>
- <groupId>org.hibernate</groupId>
- <artifactId>hibernate-docbook-xslt</artifactId>
- <type>jdocbook-style</type>
- <version>0.1</version>
- </dependency>
- </dependencies-->
- <configuration>
- <sourceDocumentName>Clustering_Guide.xml</sourceDocumentName>
- <imageResource>
- <directory>en-US</directory>
- <excludes>
- <exclude>*.xml</exclude>
- </excludes>
- </imageResource>
- <cssResource>
- <directory>en-US</directory>
- <excludes>
- <exclude>*.xml</exclude>
- </excludes>
- </cssResource>
- <formats>
- <format>
- <formatName>pdf</formatName>
- <!--stylesheetResource>classpath:/standard/fopdf.xsl</stylesheetResource-->
- <finalName>Clustering_Guide.pdf</finalName>
- </format>
- <format>
- <formatName>html</formatName>
- <!--stylesheetResource>classpath:/standard/html_chunk.xsl</stylesheetResource-->
- <finalName>index.html</finalName>
- </format>
-<!--
- <format>
- <formatName>html_single</formatName>
- <stylesheetResource>classpath:/xslt/nochunk-html.xsl</stylesheetResource>
- </format>
--->
-<!-- <format>
- <formatName>eclipse</formatName>
- <stylesheetResource>classpath:/xslt/main-eclipse.xsl</stylesheetResource>
- <finalName>index.html</finalName>
- </format>
--->
- </formats>
- <options>
- <xincludeSupported>true</xincludeSupported>
- <xmlTransformerType>saxon</xmlTransformerType>
- <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme -->
- <!-- could also locate the docbook dependency and inspect its version... -->
- <docbookVersion>1.72.0</docbookVersion>
- </options>
-
- <sourceDirectory>${basedir}/en-US</sourceDirectory>
- </configuration>
- </plugin>
- </plugins>
- </build>
-
- <properties>
- <translation>en-US</translation>
- </properties>
-
+<properties>
+ <translation>en-US</translation>
+</properties>
</project>
Modified: projects/docs/community/5/Installation_And_Getting_Started_Guide/en-US/About_the_Example_Applications.xml
===================================================================
--- projects/docs/community/5/Installation_And_Getting_Started_Guide/en-US/About_the_Example_Applications.xml 2008-12-03 06:46:29 UTC (rev 81998)
+++ projects/docs/community/5/Installation_And_Getting_Started_Guide/en-US/About_the_Example_Applications.xml 2008-12-03 06:58:34 UTC (rev 81999)
@@ -3,84 +3,13 @@
]>
<chapter id="About_the_Example_Applications">
- <title>About the Example Applications</title>
+ <title>Sample Applications</title>
<para>
- 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;
- </para>
- </listitem>
- <listitem>
- <para>The same application using the SEAM framework.</para>
- </listitem>
- </itemizedlist>
+ The JBoss Application Server, ships with various sample applications under <literal>JBOSS_HOME/docs/examples</literal>.
</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 (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.
+ For further details, please refer to the accompanying <filename>readme.txt</filename> for the respective sample applications under the above directory.
</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.
- </para>
- <para>
- Within the <filename class="directory">JBOSS_DIST/doc/examples/<seamejb3|jsfejb3></filename> directory, you will find the following sub-directories: <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">src</emphasis>: contains the Java source code files.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">view</emphasis>: contains the web pages.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">resources</emphasis>: contains all the configuration files used.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <section id="About_the_Example_Applications-Install_Ant">
- <title>Install Ant</title>
- <para>
- To compile and package the examples, you must have Apache Ant 1.6+ installed in your machine. You can download it from <ulink url="http://ant.apache.org"></ulink> and have it installed in few steps: <itemizedlist>
- <listitem>
- <para>
- Unzip the downloaded file to the directory of your choice.
- </para>
- </listitem>
- <listitem>
- <para>
- Create an environment variable called <literal>ANT_HOME</literal> pointing to the Ant installation directory. You can do this by adding the following line to your <filename>.bashrc</filename> file (substituting with the actual location of the ant directory on your system): <programlisting>
-export ANT_HOME=/home/user/apache-ant-1.7.0
-</programlisting>
- </para>
-
- <para>
- On Windows you do this by opening the Control Panel from the Start Menu, switching it to classic view if necessary, then opening System/Advanced/Environment Variables. Create a new variable, call it <literal>ANT_HOME</literal> and set it to be the ant directory.
- </para>
- </listitem>
- <listitem>
- <para>
- Add <literal>$ANT_HOME/bin</literal> to the system path to be able to run <literal>ant</literal> from the command line. You can do this by adding the following line to your <filename>.bashrc</filename> file: <programlisting>
-export PATH=$PATH:$ANT_HOME/bin
-</programlisting>
- </para>
- <para>
- On Windows you do this by opening the Control Panel from the Start Menu, switching it to classic view if necessary, then editing the <literal>PATH</literal> environment variable found in System/Advanced/Environment Variables/System Variables/Path. Add a semicolon and the path to the ant <filename class="directory">bin</filename> directory.
- </para>
- </listitem>
- <listitem>
- <para>
- Verify your Ant installation. To do this type <literal> ant -version</literal> at the command prompt. Your output should look something like this: <programlisting>
-Apache Ant version 1.7.0 compiled on December 13 2006
-</programlisting>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
+
</chapter>
More information about the jboss-cvs-commits
mailing list