10:22 a.m.
Author: denis.forveille
Date: 2009-08-25 11:22:31 -0400 (Tue, 25 Aug 2009)
New Revision: 11425
Modified:
branches/community/Seam_2_2/doc/Seam_Reference_Guide/en-US/Websphere.xml
Log:
Typos + text quality
JBSEAM-4324
Modified: branches/community/Seam_2_2/doc/Seam_Reference_Guide/en-US/Websphere.xml
===================================================================
--- branches/community/Seam_2_2/doc/Seam_Reference_Guide/en-US/Websphere.xml 2009-08-25
14:57:46 UTC (rev 11424)
+++ branches/community/Seam_2_2/doc/Seam_Reference_Guide/en-US/Websphere.xml 2009-08-25
15:22:31 UTC (rev 11425)
@@ -34,13 +34,13 @@
<para>
The following sections in this chapter assume that WebSphere is correctly
installed and is
- functional, and a profile has been successfully created.
+ functional, and a WebSphere "profile" has been successfully created.
</para>
<para>
- This chapter explain how to compile, deploy and run some sample applications in
WebSphere. These sample applications require
+ This chapter explains how to compile, deploy and run some sample applications in
WebSphere. These sample applications require
a database. WebSphere comes by default with a set of sample applications called
"Default Application". This set of sample applications
- use a Derby database running on the Derby instance installed with WebSphere. In
order to keep this simple we'll use this Derby database created
+ use a Derby database running on the Derby instance installed within WebSphere. In
order to keep this simple we'll use this Derby database created
for the "Default Applications". However, to run the sample application
with the Derby database "as-is", a patched Hibernate
dialect must be used (The patch changes the default "auto" key
generation strategy) as explained in <xref linkend="glassfish" />.
If you want to use another database, it's just a matter of creating a
connection pool in WebSphere pointing to this database,
@@ -68,10 +68,10 @@
Click on the server name (<literal>server1</literal>)
</listitem>
<listitem>
- On the right navigation menu, select <literal>Web Container Settings/Web
container</literal>)
+ On the right navigation menu, select <literal>Web Container Settings/Web
container</literal>
</listitem>
<listitem>
- On the right navigation menu, select <literal>custom
properties</literal>) and add the following properties:
+ On the right navigation menu, select <literal>custom
properties</literal> and add the following properties:
<itemizedlist>
<listitem>
<literal>prependSlashToResource = true</literal>
@@ -82,7 +82,7 @@
</itemizedlist>
</listitem>
<listitem>
- Save and restart the server
+ Save the configuration and restart the server
</listitem>
</itemizedlist>
</para>
@@ -93,9 +93,7 @@
<para>
In order to use component injection, Seam needs to know how to lookup for session
beans bound to the JNDI name space.
Seam provides two mechanisms to configure the way it will search for such
resources:
- <itemizedlist>
- <listitem>
- The global <literal>jndi-pattern</literal> switch on the
<literal><core:init></literal>. in
<literal>components.xml</literal>.
+ <itemizedlist><listitem>The global
<literal>jndi-pattern</literal> switch on the
<literal><core:init></literal>tag in
<literal>components.xml</literal>.
The switch can use a special placeholder
"<literal>#{ejbName}</literal>" that resolves to the unqualified
name of the EJB
</listitem>
<listitem>
@@ -110,7 +108,7 @@
</para>
<para>
- By default, WebSphere will bind the session bean in
+ By default, WebSphere will bind session beans in
its local JNDI name space under a "short" binding name that adheres to the
following pattern
<literal>ejblocal:<package.qualified.local.interface.name></literal>.
</para>
@@ -120,15 +118,13 @@
<para>
As explained before, Seam needs to lookup for session bean as they appear in
JNDI.
Basically, there are three strategies, in order of complexity:
- <itemizedlist>
- <listitem>
- Specify which JNDI name Seam must use for each session bean using the
<literal>@JndiName</literal> annotation in the java source file
+ <itemizedlist><listitem>Specify which JNDI name Seam must use for
each session bean using the <literal>@JndiName</literal> annotation in the
java source file,
</listitem>
<listitem>
- Override the default session bean names generated by WebSphere to conform to the
<literal>jndi-pattern</literal> attribute
+ Override the default session bean names generated by WebSphere to conform to the
<literal>jndi-pattern</literal> attribute,
</listitem>
<listitem>
- Use EJB references
+ Use EJB references.
</listitem>
</itemizedlist>
</para>
@@ -182,7 +178,7 @@
That's all folks! No need to update any file during the development, nor to
define any EJB to EJB or web to EJB reference!
</para>
<para>
- Compared to the other strategies, this strategy has the advantage not to have to
manage any EJBs reference and also not to have to maintain extra files.
+ Compared to the other strategies, this strategy has the advantage to not have to
manage any EJBs reference and also to not have to maintain extra files.
The only drawback is one extra line in the java source code with the
<literal>@JndiName</literal> annotation
</para>
</section>
@@ -272,9 +268,9 @@
<title>Configuring timeouts for Stateful Session Beans</title>
<para>
A timeout value has to be set for each stateful session bean used in the
application because stateful bean must not expire in WebSphere while Seam
- might still need thenm.
+ might still need them.
At the time of writing this document, WebSphere does not provide a way to
configure a global timeout at neither the cluster,
- server, application nor ejb-jar level. It has to be done for each stateful bean
individually.
+ server, application nor ejb-jar level. It has to be done for each stateful bean
individually. By default, the default timeout is 10 minutes.
This is done by adding a file named
<literal>META-INF/ibm-ejb-jar-ext.xml</literal> in the EJB module, and declare
the timeout value for each bean:
<programlisting role="XML"><![CDATA[<?xml
version="1.0" encoding="UTF-8"?>
<ejb-jar-ext
@@ -292,7 +288,7 @@
<para>
The <literal>time-out</literal> is expressed in seconds and must be
higher than the Seam conversation expiration timeout
and a few minutes higher than the user's HTTP session timeout (The session
expiration timeout can trigger a few minutes
- after the number of minutes declared to expire s for the HTTP session
expiration).
+ after the number of minutes declared to expire the HTTP session).
</para>
</section>
@@ -307,9 +303,14 @@
</para>
<para>
- For running this example, we'll use the second JNDI mapping strategy
("Override the default names generated by WebSphere")
- as we don't want to change the java code to add the
<literal>@JndiName</literal> annotation as in the first strategy.
+ The example already has a breakout of configurations and build scripts for
WebSphere. First thing, we are going to do
+ is build and deploy this example. Then we'll go over some key changes that
we needed.
</para>
+
+ <para>
+ The tailored configuration files for WebSphere use the second JNDI mapping
strategy ("Override the default names generated by WebSphere")
+ as the goal was to not change any java code to add the
<literal>@JndiName</literal> annotation as in the first strategy.
+ </para>
<section>
<title>Building the <literal>jee5/booking</literal>
example</title>
@@ -323,7 +324,7 @@
<section id="jee5-websphere-deploy">
<title>Deploying the <literal>jee5/booking</literal>
example</title>
<para>
- The steps below are for the WAS version stated above.The ports are default
values, if you changed them, you must substitute the values.
+ The steps below are for the WAS version stated above.The ports are the default
values, if you changed them, you must substitute the values.
<orderedlist>
<listitem>
Log in to the administration console
@@ -441,7 +442,7 @@
</listitem>
<listitem>
<para>
- To start the application select our application in the list, then
click on the <literal>Start</literal>
+ To start the application, select the application in the list, then
click on the <literal>Start</literal>
button at the top of the table.
</para>
</listitem>
@@ -472,13 +473,13 @@
<para>
<literal>META-INF/ibm-ejb-jar-bnd.xml</literal>
— This WebSphere specific file has been added as we use the
second JNDI mapping strategy.
- It defines, for each session bean, the name WebSphere will use to bind it
its JNDI name space
+ It defines, for each session bean, the name WebSphere will use to bind it
in its JNDI name space
</para>
</listitem>
<listitem>
<para>
<literal>META-INF/ibm-ejb-jar-ext.xml</literal>
- — This WebSphere specific file defines to WebSphere, the timeout
value for each stateful bean
+ — This WebSphere specific file defines the timeout value for each
stateful bean
</para>
</listitem>
<listitem>
@@ -488,7 +489,7 @@
switching to the WebSphere transaction manager lookup class,
turning off the
<literal>hibernate.transaction.flush_before_completion</literal> toggle,
and forcing the Hibernate dialect to be
<literal>GlassfishDerbyDialect</literal>
- how as using the integrated Derby database
+ as we are using the integrated Derby database
</para>
</listitem>
<listitem>
@@ -566,7 +567,7 @@
Follow the same instructions as for the
<literal>jee5/booking</literal> sample. Select the
<literal>examples/jpa/dist-websphere7/jboss-seam-jpa.war</literal> file on the
first page and on the
<literal>Map context roots for Web modules</literal> page (after
the <literal>Map virtual host for Web module</literal>),
- enter the context root you want to use for your application in the
<literal>Contect Root</literal> input field.
+ enter the context root you want to use for your application in the
<literal>Context Root</literal> input field.
</para>
<para>
@@ -592,7 +593,7 @@
<listitem>
<para>
<literal>import.sql</literal>
- — due to the cutomized hibernate Derby dialect, the
<literal>ID</literal>
+ — due to the customized hibernate Derby dialect, the
<literal>ID</literal>
column can not be populated by this file and was removed.
</para>
</listitem>