[jboss-cvs] JBossAS SVN: r84147 - in projects/docs/enterprise: 4.3.3/Server_Configuration_Guide/en-US and 3 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Feb 12 21:46:20 EST 2009
Author: irooskov at redhat.com
Date: 2009-02-12 21:46:20 -0500 (Thu, 12 Feb 2009)
New Revision: 84147
Modified:
projects/docs/enterprise/4.2.6/Getting_Started/en-US/Server_Configurations.xml
projects/docs/enterprise/4.3.3/Server_Configuration_Guide/en-US/Server_Configuration_Guide_CP03.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Framework.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Groovy.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/I18n.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jbpm.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Persistence.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Security.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Text.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Validation.xml
projects/docs/enterprise/4.3.4/Getting_Started/en-US/Server_Configurations.xml
projects/docs/enterprise/4.3.4/readme/en-US/Release_Notes_CP04.xml
Log:
updated getting started guide with JBPAPP-1498 fixes and updated seam guide for FP release with JBPAPP-1583 fix
Modified: projects/docs/enterprise/4.2.6/Getting_Started/en-US/Server_Configurations.xml
===================================================================
--- projects/docs/enterprise/4.2.6/Getting_Started/en-US/Server_Configurations.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.2.6/Getting_Started/en-US/Server_Configurations.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -56,10 +56,11 @@
If you want to know which services are configured in each of these instances, look at the <filename>jboss-service.xml</filename> file in the <filename class="directory">JBOSS_DIST/jboss-as/server/<instance-name>/conf/</filename> directory and also the configuration files in the <filename class="directory">JBOSS_DIST/jboss-as/server/<instance-name>/deploy</filename> directory.
<programlisting>
[vsr]$<literal>ls server/default/conf </literal>
-jbossjta-properties.xml jndi.properties standardjbosscmp-jdbc.xml
-jboss-log4j.xml login-config.xml standardjboss.xml
-jboss-minimal.xml props xmdesc
-jboss-service.xml standardjaws.xml
+jboss-log4j.xml jndi.properties standardjbosscmp-jdbc.xml
+jboss-minimal.xml login-config.xml xmdesc
+jboss-service.xml props
+jbossjta-properties.xml standardjboss.xml
+
</programlisting>
</para>
@@ -164,9 +165,7 @@
|+ bin
|+ client
|+ docs
- |+ icons
|+ lib // jboss.lib.url
- |+ scripts
|+ server
|+ all // jboss.server.name
|+ default // jboss.server.home.url
@@ -189,9 +188,7 @@
|+ jboss-web.deployer
|+ jbossws.sar
|+ jms
- |+ jms-ds.xml
|+ jmx-console.war
- |+ mail-ra.rar
|+ management
|+ uuid-key-generator.sar
- bsh-deployer.xml
@@ -208,6 +205,7 @@
- jboss-xa-jdbc.rar
- jmx-invoker-service.xml
- jsr88-service.xml
+ - mail-ra.rar
- mail-service.xml
- monitoring-service.xml
- properties-service.xml
@@ -568,14 +566,14 @@
<literal>uil2-service.xml</literal> configures the JMS version 2 unified invocation layer. Its a fast and reliable custom socket based transport that should be used for messaging between JVMs.
</entry>
</row>
- <row>
+ <!-- <row>
<entry>
<literal>jms-ds.xml</literal>
</entry>
<entry>
Contains configuration of the JMS resource adapter.
</entry>
- </row>
+ </row> -->
<row>
<entry>
<literal>jmx-console.war</literal>
@@ -690,7 +688,7 @@
<section id="The_JBoss_Server___A_Quick_Tour-Server_Configurations-The_all_Server_Configuration_File_Set">
<title>The "all" Server Configuration File Set</title>
<para>
- The "all" server configuration file set is located in the <filename class="directory">JBOSS_DIST/jboss-as/server/all</filename> directory. In addition to the services in the "default" set, the all configuration contains several other services in the <literal>conf/</literal> directory as shown below.
+ The "all" server configuration file set is located in the <filename class="directory">JBOSS_DIST/jboss-as/server/all</filename> directory. In addition to the services in the "default" set, the all configuration contains several other services in the <literal>deploy/</literal> directory as shown below.
</para>
<para>
<table id="The_all_Server_Configuration_File_Set-Additional_Services_in_conf_directory_for_all_configuration">
Modified: projects/docs/enterprise/4.3.3/Server_Configuration_Guide/en-US/Server_Configuration_Guide_CP03.xml
===================================================================
--- projects/docs/enterprise/4.3.3/Server_Configuration_Guide/en-US/Server_Configuration_Guide_CP03.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.3/Server_Configuration_Guide/en-US/Server_Configuration_Guide_CP03.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -28,7 +28,6 @@
</part>
<part id="Clustering_Configuration" label="III">
<title>Clustering Configuration</title>
- <!-- <xi:include href="Clustering_Intro.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" />
Modified: projects/docs/enterprise/4.3.4/Getting_Started/en-US/Server_Configurations.xml
===================================================================
--- projects/docs/enterprise/4.3.4/Getting_Started/en-US/Server_Configurations.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4/Getting_Started/en-US/Server_Configurations.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -162,9 +162,7 @@
|+ bin
|+ client
|+ docs
- |+ icons
|+ lib // jboss.lib.url
- |+ scripts
|+ server
|+ all // jboss.server.name
|+ default // jboss.server.home.url
@@ -187,9 +185,7 @@
|+ jboss-web.deployer
|+ jbossws.sar
|+ jboss-messaging.sar
- |+ jms-ds.xml
|+ jmx-console.war
- |+ mail-ra.rar
|+ management
|+ uuid-key-generator.sar
- bsh-deployer.xml
@@ -204,9 +200,11 @@
- jbossjca-service.xml
- jboss-local-jdbc.rar
- jboss-xa-jdbc.rar
+ - jms-ds.rar
- jms-ra.rar
- jmx-invoker-service.xml
- jsr88-service.xml
+ - mail-ra.rar
- mail-service.xml
- monitoring-service.xml
- properties-service.xml
@@ -695,8 +693,8 @@
<para>
The "all" server configuration file set is located in the <filename class="directory">JBOSS_DIST/jboss-as/server/all</filename> directory. In addition to the services in the "default" set, the all configuration contains several other services in the <literal>conf/</literal> directory as shown below.
</para>
- <table id="The_all_Server_Configuration_File_Set-Additional_Services_in_conf_directory_for_all_configuration">
- <title>Additional Services in "conf" directory for "all" configuration</title>
+ <table id="The_all_Server_Configuration_File_Set-Additional_Services_in_deploy_directory_for_all_configuration">
+ <title>Additional Services in "deploy" directory for "all" configuration</title>
<tgroup cols="2">
<!-- <colspec colname="c1" colnum="1" colwidth="4*"></colspec>
<colspec colname="c2" colnum="2" colwidth="4*"></colspec> -->
Modified: projects/docs/enterprise/4.3.4/readme/en-US/Release_Notes_CP04.xml
===================================================================
--- projects/docs/enterprise/4.3.4/readme/en-US/Release_Notes_CP04.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4/readme/en-US/Release_Notes_CP04.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -86,7 +86,7 @@
</listitem>
<listitem>
<para>
- JBoss Messaging 1.4.0.SP3-CP06
+ JBoss Messaging 1.4.0.SP3-CP07
</para>
</listitem>
<listitem>
@@ -369,7 +369,7 @@
<itemizedlist>
<listitem>
<para>
- <ulink url="http://jira.jboss.com/jira/browse/JBPAPP-1615">JBPAPP-1615</ulink>: The JBoss Messaging component of the Enterprise Application Platform has been upgraded to version 1.4.0.SP3-CP06. A list of the included fixes is as follows:
+ <ulink url="http://jira.jboss.com/jira/browse/JBPAPP-1615">JBPAPP-1615</ulink>: The JBoss Messaging component of the Enterprise Application Platform has been upgraded to version 1.4.0.SP3-CP07. A list of the included fixes is as follows:
</para>
<itemizedlist>
<listitem>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Framework.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Framework.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Framework.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -7,7 +7,7 @@
<para>
Seam makes it really easy to create applications by writing
- plain Java classes with annotations, which don't need to extend
+ plain Java classes with annotations, which do not need to extend
any special interfaces or superclasses. But we can simplify
some common programming tasks even further, by providing a set
of pre-built components which can be re-used either by
@@ -16,18 +16,18 @@
</para>
<para>
- The <emphasis>Seam Application Framework</emphasis> can reduce
+ The extremely simple <emphasis>Seam Application Framework</emphasis> can reduce
the amount of code you need to write when doing basic database
- access in a web application, using either Hibernate or JPA.
+ access in a web application, (using either Hibernate or JPA) with its simple calsses that are easy to understand and extend.
</para>
- <para>
+<!-- <para>
We should emphasize that the framework is extremely simple,
just a handful of simple classes that are easy to understand
and extend. The "magic" is in Seam itself—the same magic
you use when creating any Seam application even without using
this framework.
- </para>
+ </para> -->
<section>
<title>Introduction</title>
@@ -51,8 +51,7 @@
</framework:entity-home>]]></programlisting>
<para>
- If that looks a bit too much like "programming in XML" for
- your taste, you can use extension instead:
+ Seam components can also be extended instead if you do not with to deal with the above style of coding:
</para>
<programlisting role="JAVA"><![CDATA[
@@ -77,8 +76,8 @@
<para>
A second advantage is that your classes may be EJB stateful
session beans, if you like. (They do not have to be, they
- can be plain JavaBean components if you prefer.) If you are using
- JBoss EAP:
+ can be plain JavaBean components if you prefer.) When you are using
+ JBoss Enterprise Application Platform:
</para>
<programlisting role="JAVA"><![CDATA[@Stateful
@@ -184,7 +183,7 @@
<para>
Usually, it is much nicer to be able to refer to the <literal>Person</literal>
- merely as <literal>person</literal>, so let's make that possible by adding a
+ merely as <literal>person</literal>, so let us make that possible by adding a
line to <literal>components.xml</literal>:
</para>
@@ -222,8 +221,7 @@
</h:form>]]></programlisting>
<para>
- Well, that lets us create new <literal>Person</literal> entries. Yes,
- that is all the code that is required! Now, if we want to be able to
+ Well, those few lines of code allow us to create new <literal>Person</literal> entries. If we want to be able to
display, update and delete pre-existing <literal>Person</literal>
entries in the database, we need to be able to pass the entry
identifier to the <literal>PersonHome</literal>. Page parameters
@@ -237,7 +235,7 @@
</pages>]]></programlisting>
<para>
- Now we can add the extra operations to our JSF page:
+ We can add the extra operations to our JSF page:
</para>
<programlisting role="XHTML"><![CDATA[<h1>
@@ -256,9 +254,9 @@
<para>
When we link to the page with no request parameters, the page will
- be displayed as a "Create Person" page. When we provide a value for
+ be displayed as a <filename>Create Person</filename> page. When we provide a value for
the <literal>personId</literal> request parameter, it will be an
- "Edit Person" page.
+ <filename>Edit Person</filename> page.
</para>
<para>
@@ -397,8 +395,7 @@
<para>
The final step is to add validation functionality to the page, using
- <literal><s:validateAll></literal> and <literal><s:decorate></literal>,
- but I'll leave that for you to figure out.
+ <literal><s:validateAll></literal> and <literal><s:decorate></literal>.
</para>
</section>
@@ -437,7 +434,7 @@
max-results="20"/>]]></programlisting>
<para>
- We'll use a page parameter to determine the page to display:
+ We will use a page parameter to determine the page to display:
</para>
@@ -479,7 +476,7 @@
<para>
Real search screens let the user enter a bunch of optional search criteria
to narrow the list of results returned. The Query object lets you specify
- optional "restrictions" to support this important usecase:
+ optional restrictions to support this important usecase:
</para>
<programlisting role="XML"><![CDATA[<component name="examplePerson" class="Person"/>
@@ -495,7 +492,7 @@
</framework:entity-query>]]></programlisting>
<para>
- Notice the use of an "example" object.
+ Notice the use of an <varname>example</varname> object.
</para>
<programlisting role="XHTML"><![CDATA[<h1>Search for people</h1>
@@ -532,9 +529,9 @@
</event>]]></programlisting>
<para>
- Unfortunately Query objects don't work well with
+ Unfortunately Query objects do not work well with
<emphasis>join fetch</emphasis> queries - the use of pagination with
- these queries is not recommended, and you'll have to implement your own
+ these queries is not recommended, and you will have to implement your own
method of calculating the total number of results (by overriding
<literal>getCountEjbql()</literal>.
</para>
@@ -556,7 +553,7 @@
<literal>BusinessProcessController</literal>. These classes provide
nothing more than some convenience methods for access to commonly
used built-in components and methods of built-in components. They help
- save a few keystrokes (characters can add up!) and provide a great
+ save a few keystrokes and provide a great
launchpad for new users to explore the rich functionality built in
to Seam.
</para>
@@ -593,9 +590,9 @@
}]]></programlisting>
- <para>
+ <!-- <para>
As you can see, its not an earthshattering improvement...
- </para>
+ </para> -->
</section>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Groovy.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Groovy.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Groovy.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -7,14 +7,13 @@
<para>One aspect of JBoss Seam is its RAD (Rapid Application Development) capability. While not synonymous with RAD,
one interesting tool in this space is dynamic languages. Until recently, choosing a dynamic language was
required choosing a completely different development platform (a development platform with a set of APIs and a
- runtime so great that you would no longer want to use you old legacy Java [sic] APIs anymore, which would be
- lucky because you would be forced to use those proprietary APIs anyway). Dynamic languages built on top of the
+ runtime so great that you would no longer want to use the old legacy Java [sic] APIs anymore). Dynamic languages built on top of the
Java Virtual Machine, and <ulink url="http://groovy.codehaus.org">Groovy</ulink> in particular broke this
approach in silos.</para>
<para>JBoss Seam now unites the dynamic language world with the Java EE world by seamlessly integrating both static
- and dynamic languages. JBoss Seam lets the application developer use the best tool for the task, without context
- switching. Writing dynamic Seam components is exactly like writing regular Seam components. You use the same
+ and dynamic languages. JBoss Seam allows the application developer to use the best tool for the task, without context
+ switching. Writing dynamic Seam components is exactly like writing regular Seam components; you use the same
annotations, the same APIs, the same everything.</para>
<note>
@@ -46,7 +45,7 @@
<section>
<title>Writing Seam applications in Groovy</title>
- <para>There is not much to say about it. Since a Groovy object is a Java object, you can virtually write any
+ <para>Since a Groovy object is a Java object, you can virtually write any
Seam component, or any class for what it worth, in Groovy and deploy it. You can also mix Groovy classes and
Java classes in the same application.</para>
@@ -104,7 +103,7 @@
<section>
<title>Seam component</title>
- <para>Writing Seam components in Groovy is in no way different than in Java: annotations are used to
+ <para>Writing Seam components in Groovy is no different than in Java with annotations used to
mark the class as a Seam component.</para>
<programlisting role="JAVA">@Scope(ScopeType.SESSION)
@@ -143,7 +142,7 @@
<section>
<title>seam-gen</title>
- <para>Seam gen has a transparent integration with Groovy. You can write Groovy code in seam-gen backed
+ <para><literal>seam-gen</literal> has a transparent integration with Groovy. You can write Groovy code in seam-gen backed
projects without any additional infrastructure requirement. When writing a Groovy entity, simply place
your <filename>.groovy</filename> files in <filename>src/model</filename>. Unsurprisingly, when writing
an action, simply place your <filename>.groovy</filename> files in
@@ -158,8 +157,8 @@
comply with a 3-letter composite specification to support a multi-language component framework).</para>
<para>Beyond standard deployments, JBoss Seam has the ability, at development time, to redeploy JavaBeans Seam
- component classes without having to restart the application, saving a lot of time in the development / test
- cycle. The same support is provided for GroovyBeans Seam components when the <filename>.groovy</filename>
+ component classes without having to restart the application, saving a lot of time in the development and test
+ cycles. The same support is provided for GroovyBeans Seam components when the <filename>.groovy</filename>
files are deployed.</para>
<section>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/I18n.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/I18n.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/I18n.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -5,9 +5,9 @@
<title>Internationalization, localization and themes</title>
<para>
- Seam makes it easy to build internationalized applications. First, let's
+ Seam makes it easy to build internationalized applications. First, let us
walk through all the stages needed to internationalize and localize your
- app. Then we'll take a look at the components Seam bundles.
+ application and then we will take a look at the components Seam bundles.
</para>
<section>
@@ -21,7 +21,7 @@
<para>
Starting at the bottom, the first step is to ensure that your database
server and client is using the correct character encoding for your
- locale. Normally you'll want to use UTF-8. How to do this is outside
+ locale. Normally you will want to use UTF-8. How to do this is outside
the scope of this tutorial.
</para>
@@ -52,7 +52,7 @@
<title>Translated application strings</title>
<para>
- You'll also need localized strings for all the <emphasis>messages</emphasis>
+ You will also need localized strings for all the <emphasis>messages</emphasis>
in your application (for example field labels on your views). First
you need to ensure that your resource bundle is encoded using the
desired character encoding. By default ASCII is used. Although ASCII
@@ -62,7 +62,7 @@
<para>
Resource bundles must be created in ASCII, or use Unicode escape
- codes to represent Unicode characters. Since you don't compile a
+ codes to represent Unicode characters. Since you do not compile a
property file to byte code, there is no way to tell the JVM which
character set to use. So you must use either ASCII characters or
escape characters not in the ASCII character set.
@@ -112,7 +112,7 @@
<para>
Also JSF/Facelets should submit any requests using the specified
- character encoding, but to make sure any requests that don't specify
+ character encoding, but to make sure any requests that do not specify
an encoding you can force the request encoding using a servlet
filter. Configure this in <literal>components.xml</literal>:
</para>
@@ -198,10 +198,10 @@
<para>Seam provides a <literal>java.util.ResourceBundle</literal>
(available to the application as a <literal>
- org.jboss.seam.core.resourceBundle</literal>). You'll need to make your
+ org.jboss.seam.core.resourceBundle</literal>). You will need to make your
internationalized labels available via this special resource bundle. By
default, the resource bundle used by Seam is named
- <literal>messages</literal> and so you'll need to define your labels in
+ <literal>messages</literal> and so you will need to define your labels in
files named <literal> messages.properties</literal>, <literal>
messages_en.properties</literal>, <literal>
messages_en_AU.properties</literal>, etc. These files usually belong in
@@ -248,7 +248,7 @@
<section>
<title>Displaying labels</title>
- <para>If you define your labels using the Seam resource bundle, you'll
+ <para>If you define your labels using the Seam resource bundle, you will
be able to use them without having to type <literal> <f:loadBundle
... /></literal> on every page. Instead, you can simply type:</para>
@@ -334,8 +334,10 @@
</theme:available-themes>
</theme:theme-selector></programlisting>
- <para>Note that the first theme listed is the default theme.</para>
-
+<note>
+ <para>The first theme listed is the default theme.</para>
+</note>
+
<para>Themes are defined in a properties file with the same name as the
theme. For example, the <literal>default</literal> theme is defined as a
set of entries in <literal> default.properties</literal>. For example,
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jbpm.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jbpm.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jbpm.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -14,7 +14,7 @@
</para>
<para>
- Seam applications use jBPM for two different problems:
+ Seam applications use jBPM in two different situations:
</para>
<itemizedlist>
@@ -40,16 +40,16 @@
</itemizedlist>
<para>
- Don't get these two things confused ! They operate at very different levels
- or granularity. <emphasis>Pageflow</emphasis>, <emphasis>conversation</emphasis>
+ <emphasis>Pageflow</emphasis>, <emphasis>conversation</emphasis>
and <emphasis>task</emphasis> all refer to a single
- interaction with a single user. A business process spans many tasks.
+ interaction with a single user and operate at very different levels
+ or granularity. A business process spans many tasks.
Furthermore, the two applications of jBPM are totally orthogonal. You can
use them together or independently or not at all.
</para>
<para>
- You don't have to know jDPL to use Seam. If you're perfectly happy defining
+ You do not have to know jDPL to use Seam. If you are perfectly happy defining
pageflow using JSF or Seam navigation rules, and if your application is more
data-driven that process-driven, you probably don't need jBPM. But we're
finding that thinking of user interaction in terms of a well-defined graphical
@@ -78,8 +78,8 @@
<para>
Very simple applications will only need the stateless navigation
- model. Very complex applications will use both models in different
- places. Each model has its strengths and weaknesses!
+ model while complex applications will use both models in different
+ places; each model has its strengths and weaknesses.
</para>
<section>
@@ -250,11 +250,11 @@
the traditional view of modal/modeless interaction. Now, Seam
applications are not usually modal in the simple sense of the
word - indeed, avoiding application modal behavior is one of the
- main reasons for having conversations! However, Seam applications
+ main reasons for having conversations. However, Seam applications
can be, and often are, modal at the level of a particular
conversation. It is well-known that modal behavior is something
to avoid as much as possible; it is very difficult to predict the
- order in which your users are going to want to do things! However,
+ order in which your users are going to wish to opperate. However,
there is no doubt that the stateful model has its place.
</para>
@@ -302,13 +302,13 @@
interpreted as an undefined transition back to a previous state.
Since the stateful model enforces a defined set of transitions
from the current state, back buttoning is by default disallowed
- in the stateful model! Seam transparently detects the use of the
+ in the stateful model. Seam transparently detects the use of the
back button, and blocks any attempt to perform an action from
- a previous, "stale" page, and simply redirects the user to
- the "current" page (and displays a faces message). Whether you
+ a previous, <emphasis>stale</emphasis> page, and simply redirects the user to
+ the <emphasis>current</emphasis> page (and displays a faces message). Whether you
consider this a feature or a limitation of the stateful model
depends upon your point of view: as an application developer,
- it is a feature; as a user, it might be frustrating! You can
+ it is a feature; as a user, it might be frustrating. You can
enable backbutton navigation from a particular page node by
setting <literal>back="enabled"</literal>.
</para>
@@ -382,7 +382,7 @@
<title>Starting pageflows</title>
<para>
- We "start" a jPDL-based pageflow by specifying the name of the
+ We <emphasis>start</emphasis> a jPDL-based pageflow by specifying the name of the
process definition using a <literal>@Begin</literal>,
<literal>@BeginTask</literal> or <literal>@StartTask</literal>
annotation:
@@ -669,7 +669,7 @@
As jBPM processes are persistent across application restarts,
when using Seam in a production environment you won't want to
install the process definition every time the application starts.
- Therefore, in a production environment, you'll need to deploy
+ Therefore, in a production environment, you will need to deploy
the process to jBPM outside of Seam. In other words, only install
process definitions from <literal>components.xml</literal> when
developing your application.
@@ -682,7 +682,7 @@
<para>
We always need to know what user is currently logged in.
- jBPM "knows" users by their <emphasis>actor id</emphasis>
+ jBPM recognizes users by their <emphasis>actor id</emphasis>
and <emphasis>group actor ids</emphasis>. We specify the
current actor ids using the built in Seam component named
<literal>actor</literal>:
@@ -723,7 +723,7 @@
<para>
When a process reaches a task node, task instances are created. These must be
- assigned to users or user groups. We can either hardcode our actor ids, or
+ assigned to users or user groups. We can either hardcode our actor IDs, or
delegate to a Seam component:
</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Persistence.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Persistence.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Persistence.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -28,12 +28,12 @@
</para>
<para>
- Unfortunately, the so-called "stateless" architectures that preceded Seam and
+ Unfortunately, the <!-- so-called --> stateless architectures that preceded Seam and
EJB 3.0 had no construct for representing an optimistic transaction. So, instead,
these architectures provided persistence contexts scoped to the atomic
- transaction. Of course, this resulted in many problems for users, and is the
+ transaction. This resulted in many problems for users. <!--, and is the
cause of the number one user complaint about Hibernate: the dreaded
- <literal>LazyInitializationException</literal>. What we need is a construct
+ <literal>LazyInitializationException</literal>. --> What we need is a construct
for representing an optimistic transaction in the application tier.
</para>
@@ -110,11 +110,11 @@
<para>
The more transactions per request, the more likely we are to encounter atomicity
and isolation problems when our application is processing many concurrent requests.
- Certainly, all write operations should occur in the same transaction!
+ Certainly, all write operations should occur in the same transaction.
</para>
<para>
- Hibernate users developed the <emphasis>"open session in view"</emphasis> pattern to work
+ Hibernate users developed the <emphasis>open session in view</emphasis> pattern to work
around this problem. In the Hibernate community, "open session in view" was historically
even more important because frameworks like Spring use transaction-scoped persistence contexts.
So rendering the view would cause <literal>LazyInitializationException</literal>s when
@@ -125,27 +125,27 @@
This pattern is usually implemented as a single transaction which spans the entire request.
There are several problems with this implementation, the most serious being that we
can never be sure that a transaction is successful until we commit it—but by the
- time the "open session in view" transaction is committed, the view is fully rendered, and
+ time the <emphasis>open session in view</emphasis> transaction is committed, the view is fully rendered, and
the rendered response may already have been flushed to the client. How can we notify the
user that their transaction was unsuccessful?
</para>
<para>
Seam solves both the transaction isolation problem and the association fetching problem,
- while working around the problems with "open session in view". The solution comes in two
+ while working around the problems with <emphasis>open session in view</emphasis>. The solution comes in two
parts:
</para>
<itemizedlist>
<listitem>
<para>
- use an extended persistence context that is scoped to the conversation,
+ Use an extended persistence context that is scoped to the conversation,
instead of to the transaction
</para>
</listitem>
<listitem>
<para>
- use two transactions per request; the first spans the beginning of the restore view
+ Use two transactions per request; the first spans the beginning of the restore view
phase (some transaction managers begin the transaction later at the beginning of the
apply request vaues phase) until the end of the invoke application phase; the second spans the
render response phase
@@ -154,16 +154,16 @@
</itemizedlist>
<para>
- In the next section, we'll tell you how to set up a conversation-scope persistence
+ In the next section, we will tell you how to set up a conversation-scope persistence
context. But first we need to tell you how to enable Seam transaction management.
Note that you can use conversation-scoped persistence contexts without Seam
transaction management, and there are good reasons to use Seam transaction management
- even when you're not using Seam-managed persistence contexts. However, the two
+ even when you are not using Seam-managed persistence contexts. However, the two
facilities were designed to work together, and work best when used together.
</para>
<para>
- Seam transaction management is useful even if you're using EJB 3.0
+ Seam transaction management is useful even if you are using EJB 3.0
container-managed persistence contexts. But it is especially useful
if you use Seam outside a Java EE 5 environment, or in any other
case where you would use a Seam-managed persistence context.
@@ -269,7 +269,7 @@
<para>
Transaction synchronization provides callbacks for transaction related events
such as <literal>beforeCompletion()</literal> and <literal>afterCompletion()</literal>.
- By default, Seam uses it's own transaction synchronization component which requires explicit use of the
+ By default, Seam uses its own transaction synchronization component which requires explicit use of the
Seam transaction component when committing a transaction to ensure synchronization callbacks are
correctly executed. If in a Java EE 5 environment the
<literal><transaction:ejb-transaction/></literal>
@@ -283,7 +283,7 @@
<title>Seam-managed persistence contexts</title>
<para>
- If you're using Seam outside of a Java EE 5 environment, you can't rely upon the
+ If you are using Seam outside of a Java EE 5 environment, you can't rely upon the
container to manage the persistence context lifecycle for you. Even if you are
in an EE 5 environment, you might have a complex application with many loosly
coupled components that collaborate together in the scope of a single conversation,
@@ -292,7 +292,7 @@
</para>
<para>
- In either case, you'll need to use a <emphasis>managed persistence context</emphasis>
+ In either case, you will need to use a <emphasis>managed persistence context</emphasis>
(for JPA) or a <emphasis>managed session</emphasis> (for Hibernate) in your components.
A Seam-managed persistence context is just a built-in Seam component that manages an
instance of <literal>EntityManager</literal> or <literal>Session</literal> in the
@@ -382,12 +382,14 @@
...
</session-factory>]]></programlisting>
+<important>
<para>
- Note that Seam does not flush the session, so you should always enable
+ Seam does not flush the session, so you should always enable
<literal>hibernate.transaction.flush_before_completion</literal> to
ensure that the session is automatically flushed before the JTA transaction
commits.
</para>
+</important>
<para>
We can now have a managed Hibernate <literal>Session</literal> injected into our
@@ -465,7 +467,7 @@
<para>
Of course, you could set the <literal>flushMode</literal> to <literal>MANUAL</literal>
- from pages.xml, for example in a navigation rule:
+ from <filename>pages.xml</filename>, for example in a navigation rule:
</para>
<programlisting role="XML"><![CDATA[<begin-conversation flush-mode="MANUAL" />]]></programlisting>
@@ -475,7 +477,7 @@
</section>
<section>
- <title>Using the JPA "delegate"</title>
+ <title>Using the JPA <emphasis>delegate</emphasis></title>
<para>
The <literal>EntityManager</literal> interface lets you access a vendor-specific
@@ -487,8 +489,8 @@
</para>
<para>
- But regardless of whether you're using Hibernate (genius!) or something else
- (masochist, or just not very bright), you'll almost certainly want to use the
+ But regardless of whether you are using Hibernate or something else
+ you will almost certainly want to use the
delegate in your Seam components from time to time. One approach would be the
following:
</para>
@@ -501,9 +503,8 @@
}]]></programlisting>
<para>
- But typecasts are unquestionably the ugliest syntax in the Java language, so most
- people avoid them whenever possible. Here's a different way to get at the
- delegate. First, add the following line to <literal>components.xml</literal>:
+ Since most users avoid typecasts within the Java language, an alternative method to acessing the
+ delegate is described. First, add the following line to <literal>components.xml</literal>:
</para>
<programlisting role="XML"><![CDATA[<factory name="session"
@@ -544,10 +545,10 @@
.getSingleResult();]]></programlisting>
<para>
- Of course, you should never, ever write it like this:
+ The other way in which this can be written is not advised but included for completeness:
</para>
- <programlisting role="JAVA"><![CDATA[User user = em.createQuery("from User where username=" + user.getUsername()) //BAD!
+ <programlisting role="JAVA"><![CDATA[User user = em.createQuery("from User where username=" + user.getUsername())
.getSingleResult();]]></programlisting>
<para>
@@ -560,9 +561,9 @@
<title>Using Hibernate filters</title>
<para>
- The coolest, and most unique, feature of Hibernate is <emphasis>filters</emphasis>.
+ The most unique feature of Hibernate is <emphasis>filters</emphasis>.
Filters let you provide a restricted view of the data in the database. You can find
- out more about filters in the Hibernate documentation. But we thought we'd mention
+ out more about filters in the Hibernate documentation. Mentioned here is
an easy way to incorporate filters into a Seam application, one that works especially
well with the Seam Application Framework.
</para>
@@ -570,8 +571,8 @@
<para>
Seam-managed persistence contexts may have a list of filters defined, which will be
enabled whenever an <literal>EntityManager</literal> or Hibernate <literal>Session</literal>
- is first created. (Of course, they may only be used when Hibernate is the underlying
- persistence provider.)
+ is first created. (They can also be used when another underlying
+ persistence provider is in use.)
</para>
<programlisting role="XML"><![CDATA[<persistence:filter name="regionFilter">
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Security.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Security.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Security.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -200,7 +200,7 @@
<para>
In the above example, both <literal>User</literal> and <literal>UserRole</literal> are application-specific
entity beans. The <literal>roles</literal> parameter is populated with the roles that the user is a member
- of, which should be added to the <literal>Set</literal> as literal string values, e.g. "admin", "user".
+ of, which should be added to the <literal>Set</literal> as literal string values, for example <emphasis>admin</emphasis>, <emphasis>user</emphasis>.
In this case, if the user record is not found and a <literal>NoResultException</literal> thrown, the
authentication method returns <literal>false</literal> to indicate the authentication failed.
</para>
@@ -213,7 +213,7 @@
session is authenticated or not. If the session is not authenticated, then <literal>addRole()</literal>
should <emphasis>only</emphasis> be called during the authentication process. When called here, the
role name is placed into a temporary list of pre-authenticated roles. Once authentication is successful,
- the pre-authenticated roles then become "real" roles, and calling <literal>Identity.hasRole()</literal>
+ the pre-authenticated roles then become <emphasis>real</emphasis> roles, and calling <literal>Identity.hasRole()</literal>
for those roles will then return true. The following sequence diagram represents the list of pre-authenticated
roles as a first class object to show more clearly how it fits in to the authentication process.
@@ -244,7 +244,7 @@
</para>
<para>
- To give an example, let's say that upon a successful login that some user statistics must be
+ To give an example, let us say that upon a successful login that some user statistics must be
updated. We would do this by writing an event observer for the
<literal>org.jboss.seam.security.loginSuccessful</literal> event, like this:
</para>
@@ -323,8 +323,8 @@
<title>Handling Security Exceptions</title>
<para>
- To prevent users from receiving the default error page in response to a security error, it's recommended that
- <literal>pages.xml</literal> is configured to redirect security errors to a more "pretty" page. The two
+ To prevent users from receiving the default error page in response to a security error, it is recommended that
+ <literal>pages.xml</literal> is configured to redirect security errors to a more elegant page. The two
main types of exceptions thrown by the security API are:
</para>
@@ -382,7 +382,7 @@
<para>
You can ask Seam to redirect the user to a login screen when an unauthenticated user tries
- to access a particular view (or wildcarded view id) as follows:
+ to access a particular view (or wildcarded <varname>view-id</varname>) as follows:
</para>
<programlisting role="XML"><![CDATA[<pages login-view-id="/login.xhtml">
@@ -504,7 +504,7 @@
<programlisting role="XML"><![CDATA[<security:identity jaas-config-name="other"/>]]></programlisting>
<para>
- Please keep in mind that doing this does not mean that your user will be authenticated in whichever
+ Keep in mind that doing this does not mean that your user will be authenticated in whichever
container your Seam application is deployed in. It merely instructs Seam Security to authenticate
itself using the configured JAAS security policy.
</para>
@@ -621,7 +621,7 @@
</para>
<para>
- Roles are simple, consisting of only a name such as "admin", "user", "customer", etc. Permissions consist of
+ Roles are simple, consisting of only a name such as <emphasis>admin</emphasis>, <emphasis>user</emphasis>, <emphasis>customer</emphasis>, etc. Permissions consist of
both a name and an action, and are represented within this documentation in the form <literal>name:action</literal>,
for example <literal>customer:delete</literal>, or <literal>customer:insert</literal>.
</para>
@@ -632,7 +632,7 @@
<title>Securing components</title>
<para>
- Let's start by examining the simplest form of authorization, component security, starting with the
+ Let us start by examining the simplest form of authorization, component security, starting with the
<literal>@Restrict</literal> annotation.
</para>
@@ -799,7 +799,7 @@
</para>
<para>
- Now for something more complex. Let's say you have a <literal>h:dataTable</literal> control on a
+ Now for something more complex. Let us say you have a <literal>h:dataTable</literal> control on a
page listing records for which you may or may not wish to render action links depending on the
user's privileges. The <literal>s:hasPermission</literal> EL function allows us to pass in an
object parameter which can be used to determine whether the user has the requested permission
@@ -920,7 +920,7 @@
</itemizedlist>
<para>
- Here's an example of how an entity would be configured to perform a security check for any <literal>insert</literal>
+ Here is an example of how an entity would be configured to perform a security check for any <literal>insert</literal>
operations. Please note that the method is not required to do anything, the only important thing in regard to
security is how it is annotated:
</para>
@@ -957,7 +957,7 @@
</note>
<para>
- And here's an example of an entity permission rule that checks if the authenticated user is allowed to insert
+ And here is an example of an entity permission rule that checks if the authenticated user is allowed to insert
a new <literal>MemberBlog</literal> record (from the seamspace example). The entity for which the security
check is being made is automatically inserted into the working memory (in this case <literal>MemberBlog</literal>):
</para>
@@ -1079,7 +1079,7 @@
</components>]]></programlisting>
<para>
- Once the <literal>RuleBase</literal> component is configured, it's time to write the security rules.
+ Once the <literal>RuleBase</literal> component is configured, it is time to write the security rules.
</para>
</sect2>
@@ -1131,7 +1131,7 @@
<para>
Looking at the body of the rule definition we can notice two distinct sections. Rules have what is known
as a left hand side (LHS) and a right hand side (RHS). The LHS consists of the conditional part of the
- rule, i.e. a list of conditions which must be satisfied for the rule to fire. The LHS is represented by
+ rule, for instance, a list of conditions which must be satisfied for the rule to fire. The LHS is represented by
the <literal>when</literal> section. The RHS is the consequence, or action section of the rule that will
only be fired if all of the conditions in the LHS are met. The RHS is represented by the
<literal>then</literal> section. The end of the rule is denoted by the <literal>end;</literal> line.
@@ -1150,7 +1150,7 @@
</para>
<para>
- So what is the working memory? Also known as a "stateful session" in Drools terminology, the working memory
+ So what is the working memory? Also known as a <emphasis>stateful session</emphasis> in Drools terminology, the working memory
is a session-scoped object that contains the contextual information that is required by the rules engine to
make a decision about a permission check. Each time the <literal>hasPermission()</literal> method is called,
a temporary <literal>PermissionCheck</literal> object, or <emphasis>Fact</emphasis>, is inserted into the
@@ -1196,7 +1196,7 @@
</para>
<para>
- So what is the consequence of the rule firing? Let's take a look at the RHS of the rule:
+ So what is the consequence of the rule firing? Let us take a look at the RHS of the rule:
</para>
<programlisting><![CDATA[c.grant()]]></programlisting>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Text.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Text.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Text.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -6,7 +6,7 @@
of formatted text in forum posts, wiki pages, blogs, comments, etc. Seam provides the
<literal><s:formattedText/></literal> control for display of formatted text that
conforms to the <emphasis>Seam Text</emphasis> language. Seam Text is implemented using
- an ANTLR-based parser. You don't need to know anything about ANTLR to use it, however.
+ an ANTLR-based parser. You do not need to know anything about ANTLR to use it, however.
</para>
<section>
@@ -165,8 +165,8 @@
</p>]]></programlisting>
<para>
- Note that inline monospace formatting always escapes (most monospace formatted text is in fact
- code or tags with many special characters). So you can, for example, write:
+ Sine inline monospace formatting always escapes (most monospace formatted text is in fact
+ code or tags with many special characters), you can, for example, write:
</para>
<programlisting><![CDATA[This is a |<tag attribute="value"/>| example.]]></programlisting>
@@ -204,7 +204,7 @@
<title>Entering HTML</title>
<para>
- Text may even include a certain limited subset of HTML (don't worry, the subset is chosen
+ Text may even include a certain limited subset of HTML (the subset is chosen
to be safe from cross-site scripting attacks). This is useful for creating links:
</para>
@@ -221,7 +221,7 @@
</table>]]></programlisting>
<para>
- But you can do much more if you want!
+ There is also much more that can be achieved if you desire to delve.
</para>
</section>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Validation.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Validation.xml 2009-02-13 01:34:37 UTC (rev 84146)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Validation.xml 2009-02-13 02:46:20 UTC (rev 84147)
@@ -26,14 +26,14 @@
<para>
In practice, this approach usually violates DRY, since most
- "validation" actually enforces constraints that are part of
+ validation actually enforces constraints that are part of
the data model, and exist all the way down to the database
schema definition. Seam provides support for model-based
constraints defined using Hibernate Validator.
</para>
<para>
- Let's start by defining our constraints, on our
+ Let us start by defining our constraints, on our
<literal>Location</literal> class:
</para>
@@ -54,7 +54,7 @@
}]]></programlisting>
<para>
- Well, that's a decent first cut, but in practice it might be
+ Though default constraints are used here, in practice it might be
more elegant to use custom constraints instead of the ones
built into Hibernate Validator:
</para>
@@ -102,13 +102,15 @@
</h:form>]]></programlisting>
+<note>
<para>
- <emphasis>Note:</emphasis> specifying <literal>@NotNull</literal>
+ Specifying <literal>@NotNull</literal>
on the model does <emphasis>not</emphasis> eliminate the requirement
- for <literal>required="true"</literal> to appear on the control!
+ for <literal>required="true"</literal> to appear on the control.
This is due to a limitation of the JSF validation architecture.
</para>
-
+</note>
+
<para>
This approach <emphasis>defines</emphasis> constraints on the model, and
<emphasis>presents</emphasis> constraint violations in the view—a
@@ -145,7 +147,7 @@
<para>
This tag simply adds an <literal><s:validate></literal>
to every input in the form. For a large form, it can save a lot
- of typing!
+ of typing.
</para>
<para>
@@ -162,10 +164,10 @@
</para>
<para>
- That's quite a lot of functionality we need for each field
- of our form. We wouldn't want to have to specify highlighting
+ That is quite a lot of functionality we need for each field
+ of our form. We would not want to have to specify highlighting
and the layout of the image, message and input field for every
- field on the form. So, instead, we'll specify the common
+ field on the form. So, instead, we will specify the common
layout in a facelets template:
</para>
@@ -246,7 +248,7 @@
</h:form>]]></programlisting>
<para>
- It's better style to define explicit ids for
+ It is better style to define explicit IDs for
important controls on the page, especially if you want to do
automated testing for the UI, using some toolkit like
Selenium. If you don't provide explicit ids, JSF will generate
@@ -277,9 +279,9 @@
</h:form>]]></programlisting>
<para>
- And what if you want to specify a different message to be
- displayed when validation fails? You can use the Seam message
- bundle (and all it's goodies like el expressions inside the message,
+ If you wish to specify a different message to be
+ displayed when validation fails you can use the Seam message
+ bundle (and options like el expressions inside the message,
and per-view message bundles) with the Hibernate Validator:
</para>
More information about the jboss-cvs-commits
mailing list