[jboss-cvs] JBossAS SVN: r84228 - projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sun Feb 15 22:34:10 EST 2009
Author: irooskov at redhat.com
Date: 2009-02-15 22:34:09 -0500 (Sun, 15 Feb 2009)
New Revision: 84228
Modified:
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Annotations.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Cache.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Components.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Configuration.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Controls.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Dependencies.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Elenhancements.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Hsearch.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jms.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Mail.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Remoting.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Revision_History.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Spring.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Testing.xml
projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Webservices.xml
Log:
updated Seam Reference Guide with editorial corrections for JBPAPP-1583
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Annotations.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Annotations.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Annotations.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -5,12 +5,12 @@
<title>Seam annotations</title>
<para>
- When you write a Seam application, you'll use a lot of annotations. Seam
+ When you write a Seam application, you will use a lot of annotations. Seam
lets you use annotations to achieve a declarative style of programming.
- Most of the annotations you'll use are defined by the EJB 3.0
+ Most of the annotations you will use are defined by the EJB 3.0
specification. The annotations for data validation are defined by the
Hibernate Validator package. Finally, Seam defines its own set of
- annotations, which we'll describe in this chapter.
+ annotations, which we will describe in this chapter.
</para>
<para>
@@ -153,12 +153,14 @@
component instance will not be visible to nested child
conversations, which will get their own instance.
</para>
+ <warning>
<para>
- Warning: this is ill-defined, since it implies that a
+ This implies that a
component will be visible for some part of a request cycle,
and invisible after that. It is not recommended that
- applications use this feature!
+ applications use this feature.
</para>
+ </warning>
</listitem>
</varlistentry>
<varlistentry id="startup-annotation">
@@ -428,7 +430,7 @@
</variablelist>
<para>
- Note that it is quite common for these annotations to occur together,
+ It is quite common for these annotations to occur together,
for example:
</para>
@@ -769,7 +771,7 @@
<listitem>
<programlisting role="JAVA"><![CDATA[@StartTask]]></programlisting>
<para>
- "Starts" a jBPM task. Specifies that a long-running
+ <emphasis>Starts</emphasis> a jBPM task. Specifies that a long-running
conversation begins when this method returns a non-null
outcome without exception. This conversation is associated
with the jBPM task specified in the named request
@@ -864,7 +866,7 @@
<listitem>
<programlisting role="JAVA"><![CDATA[@EndTask]]></programlisting>
<para>
- "Ends" a jBPM task. Specifies that a long-running
+ <emphasis>Ends</emphasis> a jBPM task. Specifies that a long-running
conversation ends when this method returns a non-null
outcome, and that the current task is complete. Triggers a
jBPM transition. The actual transition triggered will be
@@ -1000,7 +1002,7 @@
<para>
Synonym for javax.ejb.ApplicationException, for use in a pre -Java EE 5 environment. Applied to an exception to denote that
it is an application exception and should be reported to the
- client directly(i.e., unwrapped).
+ client directly(for instance, unwrapped).
</para>
<para>
<emphasis>Do not use this annotation on EJB 3.0 components,
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Cache.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Cache.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Cache.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -6,21 +6,7 @@
<para>
In almost all enterprise applications, the database is the primary
- bottleneck, and the least scalable tier of the runtime environment.
- People from a PHP/Ruby environment will try to tell you that so-called
- "shared nothing" architectures scale well. While that may be literally
- true, I don't know of many interesting multi-user applications which
- can be implemented with no sharing of resources between different
- nodes of the cluster. What these silly people are really thinking of
- is a "share nothing except for the database" architecture. Of course,
- sharing the database is the primary problem with scaling a multi-user
- application—so the claim that this architecture is highly scalable
- is absurd, and tells you a lot about the kind of applications that these
- folks spend most of their time working on.
- </para>
-
- <para>
- Almost anything we can possibly do to share the database <emphasis>less
+ bottleneck, and the least scalable tier of the runtime environment. So anything we can possibly do to share the database <emphasis>less
often</emphasis> is worth doing.
</para>
@@ -33,8 +19,8 @@
<itemizedlist>
<listitem>
<para>
- The database, of course, has its own cache. This is
- super-important, but can't scale like a cache in the
+ The database has its own cache. This is
+ particularly important, but cannot scale like a cache in the
application tier.
</para>
</listitem>
@@ -66,10 +52,10 @@
persistence context associated with a conversation-scoped stateful
session bean) acts as a cache of data that has been read in the
current conversation. This cache tends to have a pretty high
- hitrate! Seam optimizes the replication of Seam-managed persistence
+ hitrate. Seam optimizes the replication of Seam-managed persistence
contexts in a clustered environment, and there is no requirement for
transactional consistency with the database (optimistic locking is
- sufficient) so you don't need to worry too much about the performance
+ sufficient) so you do not need to worry too much about the performance
implications of this cache, unless you read thousands of objects into
a single persistence context.
</para>
@@ -100,9 +86,9 @@
</itemizedlist>
<para>
- For more information about the second-level cache, you'll need to refer to
+ For more information about the second-level cache, you will need to refer to
the documentation of your ORM solution, since this is an extremely complex
- topic. In this section we'll discuss the use of JBossCache directly, via
+ topic. In this section we will discuss the use of JBossCache directly, via
the <literal>pojoCache</literal> component, or as the page fragment cache,
via the <literal><s:cache></literal> control.
</para>
@@ -115,7 +101,7 @@
of <literal>org.jboss.cache.aop.PojoCache</literal>. You can safely put
any immutable Java object in the cache, and it will be replicated across
the cluster (assuming that replication is enabled). If you want to
- keep mutable objects in the cache, you'll need to run the JBossCache
+ keep mutable objects in the cache, you will need to run the JBoss Cache
bytecode preprocessor to ensure that changes to the objects will be
automatically detected and replicated.
</para>
@@ -124,8 +110,8 @@
To use <literal>pojoCache</literal>, all you need to do is put the
JBossCache jars in the classpath, and provide a resource named
<literal>treecache.xml</literal> with an appropriate cache configuration.
- JBossCache has many scary and confusing configuration settings, so
- we won't discuss them here. Please refer to the JBossCache documentation
+ JBoss Cache has many scary and confusing configuration settings, so
+ we won't discuss them here. Please refer to the JBoss Cache documentation
for more information.
</para>
@@ -136,7 +122,7 @@
<para>
- For an EAR deployment of Seam, we recommend that the JBossCache jars and
+ For an EAR deployment of Seam, we recommend that the JBoss Cache jars and
configuration go directly into the EAR. Make sure you place both
<literal>jboss-cache.jar</literal> and <literal>jgroups.jar</literal>
in your EAR's lib folder.
@@ -169,7 +155,7 @@
}]]></programlisting>
<para>
- If you want to have multiple JBossCache configurations in your application,
+ If you want to have multiple JBoss Cache configurations in your application,
use <literal>components.xml</literal>:
</para>
@@ -181,11 +167,11 @@
<title>Page fragment caching</title>
<para>
- The most interesting user of JBossCache is the <literal><s:cache></literal>
+ The most interesting use of JBoss Cache is the <literal><s:cache></literal>
tag, Seam's solution to the problem of page fragment caching in JSF.
<literal><s:cache></literal> uses <literal>pojoCache</literal> internally,
- so you need to follow the steps listed above before you can use it. (Put the jars
- in the EAR, wade through the scary configuration options, etc.)
+ so you need to follow the steps listed above before you can use it. <!-- (Put the jars
+ in the EAR, wade through the scary configuration options, etc.) -->
</para>
<para>
@@ -206,16 +192,16 @@
</s:cache>]]></programlisting>
<para>
- The <literal>key</literal> let's you have multiple cached versions of each page
+ The <literal>key</literal> will let you have multiple cached versions of each page
fragment. In this case, there is one cached version per blog. The
<literal>region</literal> determines the JBossCache node that all version will
- be stored in. Different nodes may have different expiry policies. (That's the
- stuff you set up using the aforementioned scary configuration options.)
+ be stored in. Different nodes may have different expiry policies (setup during the previous steps). <!--(That is the
+ stuff you set up using the aforementioned scary configuration options.) -->
</para>
<para>
- Of course, the big problem with <literal><s:cache></literal> is that it
- is too stupid to know when the underlying data changes (for example, when the
+ The issue with the <literal><s:cache></literal> tag is that it
+ is unable to recognize when the underlying data changes (for example, when the
blogger posts a new entry). So you need to evict the cached fragment manually:
</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Components.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Components.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Components.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -4,22 +4,22 @@
<chapter id="components">
<title>Built-in Seam components</title>
<para>
- This chapter describes Seam's built-in components, and their
- configuration properties. The built-in components will be created even if they
+ This chapter describes Seam's built in components, and their
+ configuration properties. The built in components will be created even if they
are not listed in your <literal>components.xml</literal> file, but if you need to
override default properties or specify more than one component of a certain type,
<literal>components.xml</literal> is used.
</para>
<para>
- Note that you can replace any of the built in components with
+ You can replace any of the built in components with
your own implementations simply by specifying the name of one
of the built in components on your own class using
<literal>@Name</literal>.
</para>
<para>
- Note also that even though all the built in components use a
+ Even though all the built in components use a
qualified name, most of them are aliased to unqualified names by
default. These aliases specify <literal>auto-create="true"</literal>,
so you do not need to use <literal>create=true</literal> when
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Configuration.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Configuration.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Configuration.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -4,19 +4,19 @@
<chapter id="configuration">
<title>Configuring Seam and packaging Seam applications</title>
<para> Configuration is a very boring topic and an extremely tedious pastime. Unfortunately, several lines of XML
- are required to integrate Seam into your JSF implementation and servlet container. There's no need to be too put
- off by the following sections; you'll never need to type any of this stuff yourself, since you can just copy and
- paste from the example applications! </para>
+ are required to integrate Seam into your JSF implementation and servlet container. There is no need to be too put
+ off by the following sections; you will never need to type any of this stuff yourself, since you can just copy and
+ paste from the example applications. </para>
<sect1>
<title>Basic Seam configuration</title>
- <para> First, let's look at the basic configuration that is needed whenever we use Seam with JSF. </para>
+ <para> First, let us look at the basic configuration that is needed whenever we use Seam with JSF. </para>
<sect2>
<title>Integrating Seam with JSF and your servlet container</title>
- <para> Of course, you need a faces servlet! </para>
+ <para>You will need a faces servlet.</para>
<programlisting role="XML"><![CDATA[<servlet>
<servlet-name>Faces Servlet</servlet-name>
@@ -42,7 +42,7 @@
<para> Some JSF implementations have a broken implementation of server-side state saving that interferes
with Seam's conversation propagation. If you have problems with conversation propagation during form
- submissions, try switching to client-side state saving. You'll need this in <literal>web.xml</literal>: </para>
+ submissions, try switching to client-side state saving. You will need this in <literal>web.xml</literal>: </para>
<programlisting role="XML"><![CDATA[<context-param>
<param-name>javax.faces.STATE_SAVING_METHOD</param-name>
@@ -51,11 +51,11 @@
<para>
There is a minor gray area in the JSF specification regarding the mutability of view state values. Since
- Seam uses the JSF view state to back its PAGE scope this can become an issue in some cases. If you're
- using server side state saving with the JSF-RI and you want a PAGE scoped bean to keep its exact value
+ Seam uses the JSF view state to back its <emphasis>PAGE</emphasis> scope this can become an issue in some cases. If you are
+ using server side state saving with the JSF-RI and you want a <emphasis>PAGE</emphasis> scoped bean to keep its exact value
for a given view of a page you will need to specify the following context-param. Otherwise if a user
- uses the "back" button a PAGE scoped component will have the latest value if it has changed not the
- value of the "back" page. (see
+ uses the <emphasis>back</emphasis> button a <emphasis>PAGE</emphasis> scoped component will have the latest value if it has changed not the
+ value of the <emphasis>back</emphasis> page. (see
<ulink url="https://javaserverfaces-spec-public.dev.java.net/issues/show_bug.cgi?id=295">
Spec Issue
</ulink>
@@ -109,7 +109,7 @@
<sect2>
<title>Seam servlet filters</title>
- <para> Seam doesn't need any servlet filters for basic operation. However, there are several features which
+ <para> Seam does not need any servlet filters for basic operation. However, there are several features which
depend upon the use of filters. To make things easier, Seam lets you add and configure
servlet filters just like you would configure other built-in Seam components. To take advantage of this
feature, we must first install a master filter in <literal>web.xml</literal>: </para>
@@ -145,7 +145,7 @@
<para>
<literal>regex-url-pattern</literal> — Used to specify which requests are filtered, the
default is all requests. <literal>regex-url-pattern</literal> is a true regular expression
- match for request path. It's worth noting when composing the regular expression that the request path does not contain
+ match for request path. It is worth noting when composing the regular expression that the request path does not contain
the server or request context path.
</para>
</listitem>
@@ -163,7 +163,7 @@
<para> This filter provides the exception mapping functionality in <literal>pages.xml</literal> (almost
all applications will need this). It also takes care of rolling back uncommitted transactions when
uncaught exceptions occur. (According to the Java EE specification, the web container should do this
- automatically, but we've found that this behavior cannot be relied upon in all application servers.
+ automatically, but we have found that this behavior cannot be relied upon in all application servers.
And it is certainly not required of plain servlet engines like Tomcat.) </para>
<para> By default, the exception handling filter will process all requests, however this behavior may be
@@ -252,7 +252,7 @@
<para>
If RichFaces is used in your project, Seam will install the
RichFaces Ajax filter for you, making sure to install it
- before all other built-in filters. You don't need to install
+ before all other built-in filters. You do not need to install
the RichFaces Ajax filter in <literal>web.xml</literal>
yourself.
</para>
@@ -335,7 +335,7 @@
parameter named <literal>conversationId</literal>. You are responsible for ensuring that it gets
sent in the request. </para>
- <para> You are also responsible for ensuring propagation of any new conversation id back to the client.
+ <para> You are also responsible for ensuring propagation of any new conversation ID back to the client.
Seam exposes the conversation id as a property of the built in component
<literal>conversation</literal>. </para>
@@ -401,15 +401,16 @@
<programlisting role="XML"><![CDATA[<core:init jndi-name="#{ejbName}/local" />]]></programlisting>
- <para> You'll have to experiment to find the right setting for other application servers. Note that some
- servers (such as GlassFish) require you to specify JNDI names for all EJB components explicitly (and
- tediously). In this case, you can pick your own pattern ;-) </para>
+ <para> You will have to experiment to find the right setting for other application servers.</para>
+
+ <important><para>
+ Some servers (such as GlassFish) require you to specify JNDI names for all EJB components explicitly. In this case, you can pick your own pattern.</para></important>
<para>
In an EJB3 environment, we recommend the use of a special built-in component for transaction management,
that is fully aware of container transactions, and can correctly process transaction success events
- registered with the <literal>Events</literal> component. If you don't add this line to your
- <literal>components.xml</literal> file, Seam won't know when container-managed transactions end:
+ registered with the <literal>Events</literal> component. If you do not add this line to your
+ <literal>components.xml</literal> file, Seam will not know when container-managed transactions end:
</para>
<programlisting role="XML"><![CDATA[<transaction:ejb-transaction/>]]></programlisting>
@@ -417,7 +418,7 @@
</sect2>
<sect2>
- <title>Don't forget!</title>
+ <title>The Final Item</title>
<para> There is one final item you need to know about. You must place a <literal>seam.properties</literal>,
<literal>META-INF/seam.properties</literal> or <literal>META-INF/components.xml</literal> file in
@@ -427,14 +428,11 @@
<para> In a web archive (WAR) file, you must place a <literal>seam.properties</literal> file in the
<literal>WEB-INF/classes</literal> directory if you have any Seam components included here. </para>
- <para> That's why all the Seam examples have an empty <literal>seam.properties</literal> file. You can't
- just delete this file and expect everything to still work! </para>
+ <para> That is why all the Seam examples have an empty <literal>seam.properties</literal> file and why this file must be included for everything to work correctly.</para>
- <para> You might think this is silly and what kind of idiot framework designers would make an empty file
- affect the behavior of their software?? Well, this is a workaround for a limitation of the
- JVM—if we didn't use this mechanism, our next best option would be to force you to list every
- component explicitly in <literal>components.xml</literal>, just like some other competing frameworks do!
- I think you'll like our way better. </para>
+ <para>The <literal>seam.properties</literal> file is the result of a workaround for a limitation of the
+ JVM—if we did not use this mechanism, our next best option would be to force you to list every
+ component explicitly in <literal>components.xml</literal>.</para>
</sect2>
@@ -471,7 +469,7 @@
non-standard features you will need to write you own implementation of
the <literal>PersistenceProvider</literal>. Use
<literal>HibernatePersistenceProvider</literal> as a starting
- point (don't forget to give back to the community :). Then you
+ point. Then you
will need to tell <literal>seam</literal> to use it as before.
</para>
<programlisting role="XML"><![CDATA[<component name="org.jboss.seam.persistence.persistenceProvider"
@@ -479,8 +477,7 @@
</component>]]></programlisting>
<para>All that is left is updating the <literal>persistence.xml</literal>
file with the correct provider class, and what ever properties your
- provider needs. Don't forget to package your new provider's jar files in the
- application if they are needed.
+ provider needs. Your new provider's jar files will need to be packaged in the application if they are needed.
</para>
</sect1>
@@ -496,12 +493,12 @@
</imageobject>
</mediaobject>
- <para> If you're running in a Java EE 5 environment, this is all the configuration required to start using Seam! </para>
+ <para> If you are running in a Java EE 5 environment, this is all the configuration required to start using Seam. </para>
<sect2>
<title>Packaging</title>
- <para> Once you've packaged all this stuff together into an EAR, the archive structure will look something
+ <para> Once you have packaged all this stuff together into an EAR, the archive structure will look something
like this: </para>
<programlisting><![CDATA[my-application.ear/
@@ -560,9 +557,8 @@
<para> Seam ships with several example applications that are deployable in any Java EE container that
supports EJB 3.0. </para>
- <para> I really wish that was all there was to say on the topic of configuration but unfortunately we're
- only about a third of the way there. If you're too overwhelmed by all this tedious configuration stuff,
- feel free to skip over the rest of this section and come back to it later. </para>
+ <para> I really wish that was all there was to say on the topic of configuration but unfortunately we are
+ only about a third of the way there; feel free to skip over the rest of this section and come back to it later. </para>
</sect2>
@@ -571,10 +567,10 @@
<sect1>
<title>Configuring Seam in J2EE</title>
- <para> Seam is useful even if you're not yet ready to take the plunge into EJB 3.0. In this case you would use
- Hibernate3 or JPA instead of EJB 3.0 persistence, and plain JavaBeans instead of session beans. You'll miss
- out on some of the nice features of session beans but it will be very easy to migrate to EJB 3.0 when you're
- ready and, in the meantime, you'll be able to take advantage of Seam's unique declarative state management
+ <para> Seam is useful even if you are not yet ready to delve into EJB 3.0. In this case you would use
+ Hibernate3 or JPA instead of EJB 3.0 persistence, and plain JavaBeans instead of session beans. You will miss
+ out on some of the nice features of session beans but it will be very easy to migrate to EJB 3.0 when you are
+ ready and, in the meantime, you will be able to take advantage of Seam's unique declarative state management
architecture. </para>
<mediaobject>
@@ -675,16 +671,16 @@
<title>Configuring Seam in Java SE, without JBoss Embedded</title>
<para> It is possible to use Seam completely outside of an EE environment. In this case, you need to tell Seam
- how to manage transactions, since there will be no JTA available. If you're using JPA, you can tell
- Seam to use JPA resource-local transactions, ie. <literal>EntityTransaction</literal>, like so: </para>
+ how to manage transactions, since there will be no JTA available. If you are using JPA, you can tell
+ Seam to use JPA resource-local transactions for instance. <literal>EntityTransaction</literal>, like so: </para>
<programlisting role="XML"><![CDATA[<transaction:entity-transaction entity-manager="#{entityManager}"/>]]></programlisting>
- <para> If you're using Hibernate, you can tell Seam to use the Hibernate transaction API like this: </para>
+ <para> If you are using Hibernate, you can tell Seam to use the Hibernate transaction API like this: </para>
<programlisting role="XML"><![CDATA[<transaction:hibernate-transaction session="#{session}"/>]]></programlisting>
- <para> Of course, you'll also need to define a datasource.</para>
+ <para>You will also need to define a datasource.</para>
<para> A better alternative is to use JBoss Embedded to get access to the EE APIs. </para>
@@ -822,8 +818,8 @@
<sect1>
<title>Configuring jBPM in Seam</title>
- <para> Seam's jBPM integration is not installed by default, so you'll need to enable jBPM by installing a
- built-in component. You'll also need to explicitly list your process and pageflow definitions. In
+ <para> Seam's jBPM integration is not installed by default, so you will need to enable jBPM by installing a
+ built-in component. You will also need to explicitly list your process and pageflow definitions. In
<literal>components.xml</literal>: </para>
<programlisting role="XML"><![CDATA[<bpm:jbpm>
@@ -869,7 +865,7 @@
<title>Packaging</title>
<para> There is not yet any well-defined packaging format for jBPM configuration and process/pageflow
- definition files. In the Seam examples we've decided to simply package all these files into the root of
+ definition files. In the Seam examples we have decided to package all these files into the root of
the EAR. In future, we will probably design some other standard packaging format. So the EAR looks
something like this: </para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Controls.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Controls.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Controls.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -257,7 +257,7 @@
<literal><tr:commandButton /></literal>).
</para>
<para>
- You must specify an id on the action source. You can only have one
+ You must specify an ID on the action source. You can only have one
default action per form.
</para>
@@ -452,7 +452,7 @@
<para><emphasis>Description</emphasis></para>
<para>
- "Decorate" a JSF input field when validation fails or when
+ <emphasis>Decorate</emphasis> a JSF input field when validation fails or when
<literal>required="true"</literal> is set.
</para>
@@ -568,7 +568,7 @@
<para><emphasis>Description</emphasis></para>
<para>
- "Decorate" a JSF input field with the label. The label is placed
+ <emphasis>Decorate</emphasis> a JSF input field with the label. The label is placed
inside the HTML <literal><label></literal> tag, and is
associated with the nearest JSF input component. It is often
used with <literal><s:decorate></literal>.
@@ -599,7 +599,7 @@
<para><emphasis>Description</emphasis></para>
<para>
- "Decorate" a JSF input field with the validation error message.
+ <emphasis>Decorate</emphasis> a JSF input field with the validation error message.
</para>
<para><emphasis>Attributes</emphasis></para>
@@ -848,7 +848,7 @@
<para>
Renders a file upload control. This control must be used within
a form with an encoding type of
- <literal>multipart/form-data</literal>, i.e:
+ <literal>multipart/form-data</literal>, for instance:
</para>
<programlisting role="XHTML"><![CDATA[<h:form enctype="multipart/form-data">]]></programlisting>
@@ -1074,7 +1074,7 @@
</variablelist>
<para>
- It's easy to create your own transform - create a
+ It is easy to create your own transform; create a
<literal>UIComponent</literal> which implements
<literal>org.jboss.seam.ui.graphicImage.ImageTransform</literal>.
Inside the <literal>applyTransform()</literal>method use
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Dependencies.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Dependencies.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Dependencies.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -18,7 +18,7 @@
<title>Sun's JDK 6 Considerations</title>
<para>
Earlier versions of Sun's JDK 6 contained an incompatible
- version of JAXB and required overriding it using the "endorsed"
+ version of JAXB and required overriding it using the <emphasis>endorsed</emphasis>
directory. Sun's JDK6 Update 4 release upgraded to JAXB 2.1 and
removed this requirement. When building, testing, or executing be
sure to use this version or higher.
@@ -914,7 +914,7 @@
</para>
<para>
- We aren't actually going to discuss how to use Maven here, but just run
+ We are not actually going to discuss how to use Maven here, but just run
over some basic POMs you could use.
</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Elenhancements.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Elenhancements.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Elenhancements.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -15,7 +15,7 @@
<para>
Standard EL does not allow you to use a method with user defined
- parameters — of course, JSF listener methods (e.g. a
+ parameters; JSF listener methods (for example, a
<literal>valueChangeListener</literal>) take parameters provided by JSF.
</para>
@@ -57,11 +57,11 @@
value="Book Hotel"/>]]></programlisting>
<para>
- It's important to fully understand how this extension to EL works.
+ It is important to fully understand how this extension to EL works.
When the page is rendered, the parameter <emphasis>names</emphasis>
are stored (for example, <literal>hotel.id</literal> and
<literal>user.username</literal>), and evaluated (as value
- expressions) when the page is submitted. You can't pass objects as
+ expressions) when the page is submitted. You cannot pass objects as
parameters!
</para>
@@ -69,7 +69,7 @@
You must ensure that the parameters are available not only when the
page is rendered, but also when it is submitted. If the arguments can
not be resolved when the page is submitted the action method will be
- called with <literal>null</literal> arguments!
+ called with <literal>null</literal> arguments.
</para>
<para>
@@ -82,7 +82,7 @@
Unified EL also supports value expressions, used to bind a field to
a backing bean. Value expressions use JavaBean naming conventions
and expect a getter/setter pair. Often JSF expects a value
- expression where only retrieval (get) is needed (e.g. the
+ expression where only retrieval (get) is needed (for example, the
<literal>rendered</literal> attribute). Many objects, however, don't
have appropriately named property accessors or require parameters.
</para>
@@ -159,9 +159,9 @@
component set like <literal><rich:dataTable /></literal>
). Neither <literal><s:link /></literal> or
<literal><s:button /></literal> submit the form (and
- therefore produce a bookmarkable link) so a "magic" parameter
- is needed to recreate the item when the action method is
- called. This magic parameter can only be added when a
+ therefore produce a bookmarkable link) so another parameter
+ is required to recreate the item when the action method is
+ called. This parameter can only be added when a
data table backed by a <literal>DataModel</literal> is used.
</para>
</listitem>
@@ -172,7 +172,7 @@
<literal>MethodExpression</literal> is created, the parameter
types are passed in by JSF. In the case of a method binding,
JSF assumes that there are no parameters to pass. With this
- extension, we can't know the parameter types until after the
+ extension, we cannot know the parameter types until after the
expression has been evaluated. This has two minor
consequences:
</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Hsearch.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Hsearch.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Hsearch.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -7,7 +7,7 @@
<section>
<title>Introduction</title>
- <para>Full text search engines like Apache Lucene™ are a very powerful
+ <para>Full text search engines like Apache Lucene are a very powerful
technology that bring full text and efficient queries to applications.
Hibernate Search, which uses Apache Lucene under the covers, indexes your
domain model with the addition of a few annotations, takes care of the
@@ -107,7 +107,7 @@
</itemizedlist>
<note>
- <para>If you deploy those in a EAR, don't forget to update
+ <para>If you deploy those in a EAR, do not forget to update
<filename>application.xml</filename></para>
</note>
</section>
@@ -179,7 +179,7 @@
same way <classname>FullTextSession</classname> extends
<classname>Session</classname>.</para>
- <para>When an EJB 3.0 Session or Message Driven Bean injection is used (i.e.
+ <para>When an EJB 3.0 Session or Message Driven Bean injection is used (for instance,
via the @PersistenceContext annotation), it is not possible to replace the
<classname>EntityManager</classname> interface by the
<classname>FullTextEntityManager</classname> interface in the declaration
@@ -212,7 +212,7 @@
necessary.</para>
</important>
- <para>Check the DVDStore or the blog examples of the JBoss Seam
+ <para>Check the <literal>DVDStore</literal> or the blog examples of the JBoss Seam
distribution for a concrete use of Hibernate Search.</para>
</section>
</chapter>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jms.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jms.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Jms.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -39,7 +39,7 @@
the underlying dispatcher mechanism. The default dispatcher, based upon a
<literal>ScheduledThreadPoolExecutor</literal> performs efficiently but provides no
support for persistent asynchronous tasks, and hence no guarantee that a task
- will ever actually be executed. If you're working in an environment that supports
+ will ever actually be executed. If you are working in an environment that supports
EJB 3.0, and add the following line to <literal>components.xml</literal>:
</para>
@@ -106,7 +106,7 @@
{
public void processPayment(Payment payment)
{
- //do some work!
+ //code to go here
}
}]]></programlisting>
@@ -250,7 +250,7 @@
processor.schedulePayment(new Date(), 60*60*1000, cal.getTime(), payment);
]]></programlisting>
- <para>Note that the method returns the <literal>QuartzTriggerHandle</literal> object, which you can use later to stop, pause, and resume the scheduler. The <literal>QuartzTriggerHandle</literal> object is serializable, so you can save it into the database if you need to keep it around for extended period of time.</para>
+ <para>The method returns the <literal>QuartzTriggerHandle</literal> object, which you can use later to stop, pause, and resume the scheduler. The <literal>QuartzTriggerHandle</literal> object is serializable, so you can save it into the database if you need to keep it around for extended period of time.</para>
<programlisting role="JAVA"><![CDATA[QuartzTriggerHandle handle =
processor.schedulePayment(payment.getPaymentDate(),
@@ -286,7 +286,7 @@
processor.schedulePayment(new Date(), "0 10,44 14 ? 3 WED", payment);
]]></programlisting>
- <para>The <literal>@IntervalBusinessDay</literal> annotation supports invocation on the "nth Business Day" scenario. For instance, the following asynchronous method runs at 14:00 on the 2nd business day of each month. By default, it excludes all weekends and US federal holidays until 2010 from the business days.
+ <para>The <literal>@IntervalBusinessDay</literal> annotation supports invocation on the <emphasis>nth Business Day</emphasis> scenario. For instance, the following asynchronous method runs at 14:00 on the 2nd business day of each month. By default, it excludes all weekends and US federal holidays until 2010 from the business days.
</para>
<programlisting role="JAVA"><![CDATA[
@@ -307,7 +307,7 @@
new NthBusinessDay(2, "14:00", WEEKLY), payment);
]]></programlisting>
- <para>The <literal>NthBusinessDay</literal> object contains the configuration of the invocation trigger. You can specify more holidays (e.g., company holidays, non-US holidays etc.) via the <literal>additionalHolidays</literal> property.</para>
+ <para>The <literal>NthBusinessDay</literal> object contains the configuration of the invocation trigger. You can specify more holidays (for example, company holidays, non-US holidays etc.) via the <literal>additionalHolidays</literal> property.</para>
<programlisting role="JAVA"><![CDATA[
public class NthBusinessDay implements Serializable
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Mail.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Mail.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Mail.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -13,11 +13,11 @@
<para>
The examples/mail project contains an example of the email support in
action. It demonstrates proper packaging, and it contains a number of
- example that demonstrate the key features currently supported.
+ examples that demonstrate the key features currently supported.
</para>
<para>
- You can also test your mail's using Seam's integration testing environment.
+ You can also test your mail project using Seam's integration testing environment.
See <xref linkend="testing.mail" />.
</para>
@@ -25,8 +25,8 @@
<title>Creating a message</title>
<para>
- You don't need to learn a whole new template language to use Seam Mail
- — an email is just facelet!
+ You do not need to learn a whole new template language to use Seam Mail
+ — an email is just facelet.
</para>
<programlisting role="XHTML"><![CDATA[<m:message xmlns="http://www.w3.org/1999/xhtml"
@@ -108,7 +108,7 @@
<programlisting role="XHTML"><![CDATA[<m:attachment value="/WEB-INF/lib/jboss-seam-mail.jar" fileName="this-is-so-cool.jar"/>]]></programlisting>
<para>
- You could also attach a <literal>java.io.File</literal>, a <literal>java.net.URL</literal>:
+ You could also attach a <literal>java.io.File</literal> and a <literal>java.net.URL</literal>:
</para>
<programlisting role="XHTML"><![CDATA[<m:attachment value="#{numbers}"/>]]></programlisting>
@@ -120,13 +120,13 @@
<programlisting role="XHTML"><![CDATA[<m:attachment value="#{person.photo}" contentType="image/png"/>]]></programlisting>
<para>
- You'll notice that for a <literal>byte[]</literal> and a <literal>java.io.InputStream</literal>
+ You will notice that for a <literal>byte[]</literal> and a <literal>java.io.InputStream</literal>
you need to specify the MIME type of the attachment (as that
information is not carried as part of the file).
</para>
<para>
- And it gets even better, you can attach a Seam generated PDF, or any
+ You can also attach a Seam generated PDF, or any
standard JSF view, just by wrapping a <literal><m:attachment></literal>
around the normal tags you would use:
</para>
@@ -175,7 +175,7 @@
<title>HTML/Text alternative part</title>
<para>
- Whilst most mail readers nowadays support HTML, some don't, so you can
+ Whilst most mail readers nowadays support HTML, some do not, so you can
add a plain text alternative to your email body:
</para>
@@ -190,7 +190,7 @@
<title>Multiple recipients</title>
<para>
- Often you'll want to send an email to a group of recipients (for
+ Often you will want to send an email to a group of recipients (for
example your users). All of the recipient mail tags can be placed
inside a <literal><ui:repeat></literal>:
</para>
@@ -206,7 +206,7 @@
<para>
Sometimes, however, you need to send a slightly different message to
- each recipient (e.g. a password reset). The best way to do this is to
+ each recipient (for example, a password reset). The best way to do this is to
place the whole message inside a <literal><ui:repeat></literal>:
</para>
@@ -256,17 +256,17 @@
<para>
You can also use facelets source tags in your email, but you must place
them in a jar in <literal>WEB-INF/lib</literal> - referencing the
- <literal>.taglib.xml</literal> from <literal>web.xml</literal> isn't
+ <literal>.taglib.xml</literal> from <literal>web.xml</literal> is not
reliable when using Seam Mail (if you send your mail asynchronously
Seam Mail doesn't have access to the full JSF or Servlet context, and
- so doesn't know about <literal>web.xml</literal> configuration
+ so does not know about <literal>web.xml</literal> configuration
parameters).
</para>
<para>
- If you do need more configure Facelets or JSF when sending mail, you'll
+ If you do need more configure Facelets or JSF when sending mail, you will
need to override the Renderer component and do the configuration
- programmatically - only for advanced users!
+ programmatically; this should only be configured by advanced users
</para>
@@ -287,7 +287,7 @@
<para>
The body, subject and recipient (and from) name will be encoded.
- You'll need to make sure facelets uses the correct charset for parsing
+ You will need to make sure facelets uses the correct charset for parsing
your pages by setting encoding of the template:
</para>
@@ -298,7 +298,7 @@
<title>Other Headers</title>
<para>
- Sometimes you'll want to add other headers to your email. Seam
+ Sometimes you will want to add other headers to your email. Seam
provides support for some (see <xref linkend="mail.tags" />). For
example, we can set the importance of the email, and ask for a read
receipt:
@@ -325,9 +325,9 @@
If you are using EJB then you can use a MDB (Message Driven Bean) to
receive email. JBoss provides a JCA adaptor —
<literal>mail-ra.rar</literal> — but the version distributed with
- JBoss AS has a number of limitations (and isn't bundled in some versions)
+ JBoss AS has a number of limitations (and is not bundled in some versions)
therefore we recommend using the <literal>mail-ra.rar</literal>
- distributed with Seam is recommended (it's in the <literal>extras/</literal>
+ distributed with Seam is recommended (it is in the <literal>extras/</literal>
directory in the Seam bundle). <literal>mail-ra.rar</literal> should
be placed in <literal>$JBOSS_HOME/server/default/deploy</literal>; if the
version of JBoss AS you use already has this file, replace it.
@@ -376,7 +376,7 @@
</para>
<para>
- If you aren't using JBoss AS you can still use <literal>mail-ra.rar</literal>
+ If you are not using JBoss AS you can still use <literal>mail-ra.rar</literal>
or you may find your application server includes a similar adapter.
</para>
@@ -388,10 +388,10 @@
<para>
To include Email support in your application, include <literal>jboss-seam-mail.jar</literal>
in your <literal>WEB-INF/lib</literal> directory. If you are using JBoss
- AS there is no further configuration needed to use Seam's email support.
+ Enterprise Application Platform there is no further configuration needed to use Seam's email support.
Otherwise you need to make sure you have the JavaMail API, an
- implementation of the JavaMail API present (the API and impl used in
- JBoss AS are distributed with seam as <literal>lib/mail.jar</literal>),
+ implementation of the JavaMail API present (the API and impl used in the
+ JBoss Enterprise Application Platform are distributed with Seam as <literal>lib/mail.jar</literal>),
and a copy of the Java Activation Framework (distributed with Seam as
<literal>lib/activation.jar</literal>.
</para>
@@ -404,7 +404,7 @@
<para>
The <literal>mailSession</literal> component uses JavaMail to talk to a
- 'real' SMTP server.
+ correctly configured SMTP server.
</para>
<section>
@@ -424,7 +424,7 @@
<title>JNDI lookup in JBoss AS</title>
<para>
- The JBossAS <literal>deploy/mail-service.xml</literal> configures a
+ The JBoss Enterprise Application Platform <literal>deploy/mail-service.xml</literal> file configures a
JavaMail session binding into JNDI. The default service
configuration will need altering for your network.
<ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JavaMail">http://wiki.jboss.org/wiki/Wiki.jsp?page=JavaMail</ulink>
@@ -474,7 +474,7 @@
Seam's mail examples use Meldware (from <ulink url="http://buni.org">buni.org</ulink>)
as a mail server. Meldware is a groupware package that provides
<literal>SMTP</literal>, <literal>POP3</literal>, <literal>IMAP</literal>,
- webmail, a shared calendar and an graphical admin tool; it's written as a
+ webmail, a shared calendar and an graphical admin tool; it is written as a
JEE application so can be deployed onto JBoss AS alongside your Seam
application.
</para>
@@ -513,7 +513,7 @@
</components>]]></programlisting>
<para>
- Here we've created two users, <literal>duke</literal>, who has two email
+ Here we have created two users, <literal>duke</literal>, who has two email
addresses and an administrator with the username <literal>root</literal>.
</para>
@@ -579,7 +579,7 @@
<term><m:from></term>
<listitem>
<para>
- Set's the From: address for the email. You can only have one of
+ Sets the From: address for the email. You can only have one of
these per email.
</para>
<itemizedlist>
@@ -602,7 +602,7 @@
<term><m:replyTo></term>
<listitem>
<para>
- Set's the Reply-to: address for the email. You can only have one
+ Sets the Reply-to: address for the email. You can only have one
of these per email.
</para>
<itemizedlist>
@@ -687,19 +687,19 @@
<term><m:header></term>
<listitem>
<para>
- Add a header to the email (e.g. <literal>X-Sent-From: JBoss Seam</literal>)
+ Add a header to the email (for example, <literal>X-Sent-From: JBoss Seam</literal>)
</para>
<itemizedlist>
<listitem>
<para>
<literal>name</literal> — The name of the header to
- add (e.g. <literal>X-Sent-From</literal>).
+ add (for example, <literal>X-Sent-From</literal>).
</para>
</listitem>
<listitem>
<para>
<literal>value</literal> — The value of the header to
- add (e.g. <literal>JBoss Seam</literal>).
+ add (for example, <literal>JBoss Seam</literal>).
</para>
</listitem>
</itemizedlist>
@@ -790,7 +790,7 @@
<term><m:subject></term>
<listitem>
<para>
- Set's the subject for the email.
+ Sets the subject for the email.
</para>
</listitem>
</varlistentry>
@@ -798,7 +798,7 @@
<term><m:body></term>
<listitem>
<para>
- Set's the body for the email. Supports an <literal>alternative</literal>
+ Sets the body for the email. Supports an <literal>alternative</literal>
facet which, if an HTML email is generated can contain
alternative text for a mail reader which doesn't support html.
</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Remoting.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Remoting.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Remoting.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -4,7 +4,7 @@
<chapter id="remoting">
<title>Remoting</title>
<para> Seam provides a convenient method of remotely accessing components from a web page, using AJAX (Asynchronous
- Javascript and XML). The framework for this functionality is provided with almost no up-front development effort -
+ Javascript and XML). The framework for this functionality is provided with almost no up-front development effort,
your components only require simple annotating to become accessible via AJAX. This chapter describes the steps
required to build an AJAX-enabled web page, then goes on to explain the features of the Seam Remoting framework in
more detail. </para>
@@ -24,7 +24,7 @@
</servlet-mapping>]]></programlisting>
<para> The next step is to import the necessary Javascript into your web page. There are a minimum of two scripts
- that must be imported. The first one contains all the client-side framework code that enables remoting
+ that must be imported. The first contains all the client-side framework code that enables remoting
functionality: </para>
<programlisting role="XHTML"><![CDATA[<script type="text/javascript" src="seam/resource/remoting/resource/remote.js"></script>]]></programlisting>
@@ -68,8 +68,8 @@
<section>
<title>A Hello World example</title>
- <para> Let's step through a simple example to see how the <literal>Seam</literal> object works. First of all,
- let's create a new Seam component called <literal>helloAction</literal>. </para>
+ <para> Let us step through a simple example to see how the <literal>Seam</literal> object works. First of all,
+ we will create a new Seam component called <literal>helloAction</literal>. </para>
<programlisting role="JAVA"><![CDATA[@Stateless
@Name("helloAction")
@@ -80,7 +80,7 @@
}]]></programlisting>
<para>You also need to create a local interface for our new component - take special note of the
- <literal>@WebRemote</literal> annotation, as it's required to make our method accessible via remoting:</para>
+ <literal>@WebRemote</literal> annotation, as it is required to make our method accessible via remoting:</para>
<programlisting role="JAVA"><![CDATA[@Local
public interface HelloLocal {
@@ -88,16 +88,16 @@
public String sayHello(String name);
}]]></programlisting>
- <para> That's all the server-side code we need to write. Now for our web page - create a new page and import the
+ <para> That is all the server-side code we need to write. Now for our web page we will create a new page and import the
<literal>helloAction</literal> component: </para>
<programlisting role="XHTML"><![CDATA[<s:remote include="helloAction"/>]]></programlisting>
- <para> To make this a fully interactive user experience, let's add a button to our page: </para>
+ <para> To make this a fully interactive user experience, let us add a button to our page: </para>
<programlisting role="XHTML"><![CDATA[<button onclick="javascript:sayHello()">Say Hello</button>]]></programlisting>
- <para> We'll also need to add some more script to make our button actually do something when it's clicked: </para>
+ <para> We will also need to add some more script to make our button actually do something when it's clicked: </para>
<programlisting role="XHTML"><![CDATA[<script type="text/javascript">
//<![CDATA[
@@ -114,12 +114,12 @@
// ]]>]]><![CDATA[
</script>]]></programlisting>
- <para> We're done! Deploy your application and browse to your page. Click the button, and enter a name when
+ <para> All done. Deploy your application and browse to your page. Click the button, and enter a name when
prompted. A message box will display the hello message confirming that the call was successful. If you want to
save some time, you'll find the full source code for this Hello World example in Seam's
<literal>/examples/remoting/helloworld</literal> directory. </para>
- <para> So what does the code of our script actually do? Let's break it down into smaller pieces. To start with,
+ <para> So what does the code of our script actually do? Let us break it down into smaller pieces. To start with,
you can see from the Javascript code listing that we have implemented two methods - the first method is
responsible for prompting the user for their name and then making a remote request. Take a look at the following
line: </para>
@@ -127,13 +127,13 @@
<programlisting role="XHTML">Seam.Component.getInstance("helloAction").sayHello(name, sayHelloCallback);</programlisting>
<para> The first section of this line, <literal>Seam.Component.getInstance("helloAction")</literal> returns a
- proxy, or "stub" for our <literal>helloAction</literal> component. We can invoke the methods of our component
+ proxy, or <emphasis>stub</emphasis> for our <literal>helloAction</literal> component. We can invoke the methods of our component
against this stub, which is exactly what happens with the remainder of the line: <literal>sayHello(name,
sayHelloCallback);</literal>. </para>
<para> What this line of code in its completeness does, is invoke the <literal>sayHello</literal> method of our
component, passing in <literal>name</literal> as a parameter. The second parameter,
- <literal>sayHelloCallback</literal> isn't a parameter of our component's <literal>sayHello</literal> method,
+ <literal>sayHelloCallback</literal> is not a parameter of our component's <literal>sayHello</literal> method,
instead it tells the Seam Remoting framework that once it receives the response to our request, it should pass
it to the <literal>sayHelloCallback</literal> Javascript method. This callback parameter is entirely optional,
so feel free to leave it out if you're calling a method with a <literal>void</literal> return type or if you
@@ -237,7 +237,7 @@
<title>Seam.Remoting</title>
<para> Most of the client side functionality for Seam Remoting is contained within the
- <literal>Seam.Remoting</literal> object. While you shouldn't need to directly call most of its methods, there
+ <literal>Seam.Remoting</literal> object. While you should not need to directly call most of its methods, there
are a couple of important ones worth mentioning. </para>
<section>
@@ -295,7 +295,7 @@
<section>
<title>Client Interfaces</title>
- <para> In the configuration section above, the interface, or "stub" for our component is imported into our page
+ <para> In the configuration section above, the interface, or <emphasis>stub</emphasis> for our component is imported into our page
either via <literal>seam/resource/remoting/interface.js</literal>: or using the <literal>s:remote</literal>
tag:
</para>
@@ -309,7 +309,7 @@
or types that are required to execute the methods of our component are generated and made available for the
remoting framework to use. </para>
- <para> There are two types of client stub that can be generated, "executable" stubs and "type" stubs. Executable
+ <para> There are two types of client stub that can be generated, <emphasis>executable</emphasis> stubs and <emphasis>type</emphasis> stubs. Executable
stubs are behavioral, and are used to execute methods against your session bean components, while type stubs
contain state and represent the types that can be passed in as parameters or returned as a result. </para>
@@ -318,7 +318,7 @@
will be generated. There is one exception to this rule; if your component is a JavaBean (ie it is not a session
bean nor an entity bean) and any of its methods are annotated with @WebRemote, then an executable stub will be
generated for it instead of a type stub. This allows you to use remoting to call methods of your JavaBean
- components in a non-EJB environment where you don't have access to session beans. </para>
+ components in a non-EJB environment where you do not have access to session beans. </para>
</section>
@@ -337,11 +337,11 @@
call <literal>Seam.Remoting.getContext().getConversationId()</literal>. To set the conversation ID before making a
request, call <literal>Seam.Remoting.getContext().setConversationId()</literal>. </para>
- <para> If the conversation ID hasn't been explicitly set with
+ <para> If the conversation ID has not been explicitly set with
<literal>Seam.Remoting.getContext().setConversationId()</literal>, then it will be automatically assigned the
first valid conversation ID that is returned by any remoting call. If you are working with multiple conversations
within your page, then you may need to explicitly set the conversation ID before each call. If you are working
- with just a single conversation, then you don't need to do anything special. </para>
+ with just a single conversation, then you do not need to do anything special. </para>
</section>
<section>
<title>Remote calls within the current conversation scope</title>
@@ -368,7 +368,7 @@
have been executed, a single response containing all return values will be returned to the client and the
callback functions (if provided) triggered in the same order as execution. </para>
- <para> If you start a new batch via the <literal>startBatch()</literal> method but then decide you don't want to
+ <para> If you start a new batch via the <literal>startBatch()</literal> method but then decide you do not want to
send it, the <literal>Seam.Remoting.cancelBatch()</literal> method will discard any calls that were queued and
exit the batch mode. </para>
@@ -533,7 +533,7 @@
<section>
<title>Changing the message</title>
- <para> To change the message from the default "Please Wait..." to something different, set the value of
+ <para> To change the message from the default <emphasis>Please Wait...</emphasis> to something different, set the value of
<literal>Seam.Remoting.loadingMessage</literal>: </para>
<programlisting role="XHTML">Seam.Remoting.loadingMessage = "Loading..."; </programlisting>
@@ -572,10 +572,10 @@
<title>Controlling what data is returned</title>
<para> When a remote method is executed, the result is serialized into an XML response that is returned to the
- client. This response is then unmarshaled by the client into a Javascript object. For complex types (i.e.
+ client. This response is then unmarshaled by the client into a Javascript object. For complex types (for instance,
Javabeans) that include references to other objects, all of these referenced objects are also serialized as part
of the response. These objects may reference other objects, which may reference other objects, and so forth. If
- left unchecked, this object "graph" could potentially be enormous, depending on what relationships exist between
+ left unchecked, this object <emphasis>graph</emphasis> could potentially be enormous, depending on what relationships exist between
your objects. And as a side issue (besides the potential verbosity of the response), you might also wish to
prevent sensitive information from being exposed to the client. </para>
@@ -736,7 +736,7 @@
out. If many such requests are being served simultaneously, it could mean a large number of threads become tied
up because of this reason. </para>
- <para> It is recommended that you set these options via components.xml, however they can be overridden via
+ <para> It is recommended that you set these options via <filename>components.xml</filename>, however they can be overridden via
Javascript if desired. The following example demonstrates how to configure the polling to occur much more
aggressively. You should set these parameters to suitable values for your application: </para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Revision_History.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Revision_History.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Revision_History.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -5,7 +5,21 @@
<title>Revision History</title>
<simpara>
<revhistory>
-
+ <revision>
+ <revnumber>5.1.0</revnumber>
+ <date>Feb 16 2009</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Roooskov</surname>
+ <email>irooskov at redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>content editing</member>
+
+ </simplelist>
+ </revdescription>
+ </revision>
<revision>
<revnumber>5.0.0</revnumber>
<date>Feb 07 2008</date>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Spring.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Spring.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Spring.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -11,8 +11,10 @@
<para>Spring integration in Seam is marked as technology preview, so standard support is not guaranteed.</para>
</note>
- <para>Note! The Spring integration code is included in the jboss-seam-ioc library. This dependency is required for
+ <note>
+ <para>The Spring integration code is included in the <filename>jboss-seam-ioc</filename> library. This dependency is required for
all seam-spring integration techniques covered in this chapter.</para>
+</note>
<para>Seam's support for Spring provides the ability to: </para>
@@ -74,7 +76,7 @@
</property>
</bean>]]></programlisting>
- <para> Seam component instances may even be made available for injection into Spring beans by a Spring bean id. </para>
+ <para> Seam component instances may even be made available for injection into Spring beans by a Spring bean ID. </para>
<programlisting role="XML"><![CDATA[<seam:instance name="someComponent" id="someSeamComponentInstance"/>
@@ -83,14 +85,14 @@
</bean>
]]></programlisting>
- <para>Now for the caveat!</para>
+ <!-- <para>Now for the caveat.</para> -->
- <para> Seam was designed from the ground up to support a stateful component model with multiple contexts. Spring
- was not. Unlike Seam bijection, Spring injection does not occur at method invocation time. Instead,
+ <para><!--Seam was designed from the ground up to support a stateful component model with multiple contexts. Spring
+ was not. -->Unlike Seam bijection, Spring injection does not occur at method invocation time. Instead,
injection happens only when the Spring bean is instantiated. So the instance available when the bean is
instantiated will be the same instance that the bean uses for the entire life of the bean. For example, if a
Seam <literal>CONVERSATION</literal>-scoped component instance is directly injected into a singleton Spring
- bean, that singleton will hold a reference to the same instance long after the conversation is over! We call
+ bean, that singleton will hold a reference to the same instance long after the conversation is over. We call
this problem <emphasis>scope impedance</emphasis>. Seam bijection ensures that scope impedance is maintained
naturally as an invocation flows through the system. In Spring, we need to inject a proxy of the Seam
component, and resolve the reference when the proxy is invoked.</para>
@@ -124,12 +126,12 @@
</listitem>
</itemizedlist>
- <para> We'll discuss the second option in the next section. The easiest approach is to access the Spring beans
+ <para> We will discuss the second option in the next section. The easiest approach is to access the Spring beans
via EL. </para>
<para> The Spring <literal>DelegatingVariableResolver</literal> is an integration point Spring provides for
integrating Spring with JSF. This <literal>VariableResolver</literal> makes all Spring beans available in EL
- by their bean id. You'll need to add the <literal>DelegatingVariableResolver</literal> to
+ by their bean ID. You will need to add the <literal>DelegatingVariableResolver</literal> to
<literal>faces-config.xml</literal>: </para>
<programlisting role="XML"><![CDATA[<application>
@@ -251,7 +253,7 @@
an persistence context beyond the scope of a single web request
(<literal>OpenEntityManagerInViewFilter</literal>). So, it would be nice if Spring developers
could have access to a Seam managed persistence context using all of the same tools Spring provides
- for integration with JPA(e.g. <literal>PersistenceAnnotationBeanPostProcessor</literal>,
+ for integration with JPA(for example, <literal>PersistenceAnnotationBeanPostProcessor</literal>,
<literal>JpaTemplate</literal>, etc.)</para>
<para>Seam provides a way for Spring to access a Seam managed persistence context with
@@ -266,7 +268,7 @@
</listitem>
<listitem>
<para>access to Seam conversation scoped persistence contexts in a non web request
- (e.g. asynchronous quartz job)</para>
+ (for example, asynchronous quartz job)</para>
</listitem>
<listitem>
<para>allows for using Seam managed persistence contexts with Spring managed transactions (will need to
@@ -282,9 +284,9 @@
<property name="persistenceContextName" value="entityManager"/>
</bean>]]></programlisting>
- <para>Where 'persistenceContextName' is the name of the Seam managed persistence context component. By default
- this EntityManagerFactory has a unitName equal to the Seam component name or in this case 'entityManager'.
- If you wish to provide a different unitName you can do so by providing a persistenceUnitName like so:
+ <para>Where <classname>persistenceContextName</classname> is the name of the Seam managed persistence context component. By default
+ this <classname>EntityManagerFactory</classname> has a <varname>unitName</varname> equal to the Seam component name or in this case <classname>entityManager</classname>.
+ If you wish to provide a different <varname>unitName</varname> you can do so by providing a <methodname>persistenceUnitName</methodname> like so:
</para>
<programlisting role="XML"><![CDATA[<bean id="seamEntityManagerFactory" class="org.jboss.seam.ioc.spring.SeamManagedEntityManagerFactoryBean">
@@ -292,13 +294,13 @@
<property name="persistenceUnitName" value="bookingDatabase:extended"/>
</bean>]]></programlisting>
- <para>This EntityManagerFactory can then be used in any Spring provided tools. For example,
+ <para>This <classname>EntityManagerFactory</classname> can then be used in any Spring provided tools. For example,
using Spring's <literal>PersistenceAnnotationBeanPostProcessor</literal> is the exact same as before.</para>
<programlisting role="XML"><![CDATA[<bean class="org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor"/>]]></programlisting>
- <para>If you define your real EntityManagerFactory in Spring but wish to use a Seam managed persistence context
- you can tell the <literal>PersistenceAnnotationBeanPostProcessor</literal> which persistenctUnitName you wish
+ <para>If you define your real <classname>EntityManagerFactory</classname> in Spring but wish to use a Seam managed persistence context
+ you can tell the <literal>PersistenceAnnotationBeanPostProcessor</literal> which <methodname>persistenctUnitName</methodname> you wish
to use by default by specifying the <literal>defaultPersistenceUnitName</literal> property.
</para>
@@ -332,8 +334,8 @@
<para>The Seam Spring integration also provides support for complete access to a Seam managed Hibernate session
using spring's tools. This integration is very similar to the <xref linkend="spring-persistence"/>JPA integration.</para>
- <para>Like Spring's JPA integration spring's propagation model allows only one open EntityManager per
- EntityManagerFactory per transaction??? to be available to spring tools. So, the Seam Session integration works
+ <para>Like Spring's JPA integration, Spring's propagation model allows only one open EntityManager per
+ EntityManagerFactory per transaction to be available to spring tools. So, the Seam Session integration works
by wrapping a proxy SessionFactory around a Seam managed Hibernate session
context.</para>
@@ -341,7 +343,7 @@
<property name="sessionName" value="hibernateSession"/>
</bean>]]></programlisting>
- <para>Where 'sessionName' is the name of the <literal>persistence:managed-hibernate-session</literal> component.
+ <para>Where <methodname>sessionName</methodname> is the name of the <literal>persistence:managed-hibernate-session</literal> component.
This SessionFactory can then be used in any Spring provided tools. The integration
also provides support for calls to <literal>SessionFactory.getCurrentInstance()</literal> as long as you call
getCurrentInstance() on the <literal>SeamManagedSessionFactory</literal>.</para>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Testing.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Testing.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Testing.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -16,7 +16,7 @@
<para>
All Seam components are POJOs. This is a great place to start if you
want easy unit testing. And since Seam emphasizes the use of bijection
- for inter-component interactions and access to contextual objects, it's
+ for inter-component interactions and access to contextual objects, it is
very easy to test a Seam component outside of its normal runtime
environment.
</para>
@@ -76,11 +76,11 @@
]]></programlisting>
<para>
- You'll notice we aren't testing retrieving data from or persisting
+ You will notice we are not testing the retrieving of data from or persisting of
data to the database; nor are we testing any functionality
provided by Seam. We are just testing the logic of our POJOs. Seam
components don't usually depend directly upon container infrastructure,
- so most unit testing as as easy as that!
+ so most unit testing as as easy as that.
</para>
<para>
However, if you want to test the entire application, read on.
@@ -92,9 +92,9 @@
<title>Integration testing Seam components</title>
<para>
- Integration testing is slightly more difficult. In this case, we can't eliminate
- the container infrastructure; indeed, that is part of what is being tested! At
- the same time, we don't want to be forced to deploy our application to an
+ Integration testing is slightly more difficult. In this case, we cannot eliminate
+ the container infrastructure; indeed, that is part of what is being tested. At
+ the same time, we do not want to be forced to deploy our application to an
application server to run the automated tests. We need to be able to reproduce
just enough of the container infrastructure inside our testing environment to be
able to exercise the whole application, without hurting performance too much.
@@ -197,7 +197,7 @@
</para>
<para>
- Let's consider a JSP view for the component we unit tested above:
+ Let us consider a JSP view for the component we unit tested above:
</para>
<programlisting role="XHTML"><![CDATA[<html>
@@ -230,7 +230,7 @@
<para>
We want to test the registration functionality of our application (the stuff
- that happens when the user clicks the Register button). We'll reproduce the JSF
+ that happens when the user clicks the Register button). We will reproduce the JSF
request lifecycle in an automated TestNG test:
</para>
@@ -283,18 +283,18 @@
}]]></programlisting>
<para>
- Notice that we've extended <literal>SeamTest</literal>, which provides a
+ Notice that we have extended <literal>SeamTest</literal>, which provides a
Seam environment for our components, and written our test script as an
anonymous class that extends <literal>SeamTest.FacesRequest</literal>,
which provides an emulated JSF request lifecycle. (There is also a
<literal>SeamTest.NonFacesRequest</literal> for testing GET requests.)
- We've written our code in methods which are named for the various JSF
- phases, to emulate the calls that JSF would make to our components. Then
- we've thrown in various assertions.
+ We have written our code in methods which are named for the various JSF
+ phases, to emulate the calls that JSF would make to our components; then
+ we have thrown in various assertions.
</para>
<para>
- You'll find plenty of integration tests for the Seam example applications
+ You will find plenty of integration tests for the Seam example applications
which demonstrate more complex cases. There are instructions for running
these tests using Ant, or using the TestNG plugin for eclipse:
</para>
@@ -313,8 +313,8 @@
<para>
If you used seam-gen to create your project you are ready to start
- writing tests. Otherwise you'll need to setup the testing
- environment in your favorite build tool (e.g. ant, maven,
+ writing tests. Otherwise you will need to setup the testing
+ environment in your favorite build tool (for example, ant, maven,
eclipse).
</para>
@@ -432,11 +432,11 @@
</table>
<para>
- It's very important you don't put the compile time JBoss AS
- dependencies from <literal>lib/</literal> (e.g.
+ It is very important that you do not put the compile time JBoss AS
+ dependencies from <literal>lib/</literal> (for example,
<literal>jboss-system.jar</literal>) on the classpath, these
will cause Embedded JBoss to not boot. So, just add the
- dependencies (e.g. Drools, jBPM)you need as you go.
+ dependencies (for example, Drools, jBPM) you need as you go.
</para>
<para>
@@ -447,7 +447,7 @@
<para>
And, of course you need to put your built project and tests onto
- the classpath. Don't forget to put all the correct configuration
+ the classpath. Do not forget to put all the correct configuration
files for JPA and Seam onto the classpath as well.Seam asks
Embedded JBoss to deploy any resource (jar or directory)
which has <literal>seam.properties</literal> in it's root.
@@ -475,7 +475,7 @@
</para>
<para>
- You'll need to provide an implementation of
+ You will need to provide an implementation of
<literal>AbstractSeamTest</literal> which does the following:
</para>
@@ -592,13 +592,13 @@
<section id="testing.mail">
<title>Integration Testing Seam Mail</title>
-
+ <warning>
<para>
- Warning! This feature is still under development.
+ This feature is still under development.
</para>
-
+ </warning>
<para>
- It's very easy to integration test your Seam Mail:
+ It is very easy to integration test your Seam Mail:
</para>
<programlisting role="JAVA"><![CDATA[public class MailTest extends SeamTest {
@@ -638,7 +638,7 @@
<para>
There is no support for rendering standard JSF components so you
- can't test the content body of the mail message easily.
+ cannot test the content body of the mail message easily.
</para>
</section>
Modified: projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Webservices.xml
===================================================================
--- projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Webservices.xml 2009-02-16 02:28:38 UTC (rev 84227)
+++ projects/docs/enterprise/4.3.4.1/Seam/Seam_Reference_Guide/en-US/Webservices.xml 2009-02-16 03:34:09 UTC (rev 84228)
@@ -47,7 +47,7 @@
<para>
So how are conversations propagated between web service requests? Seam uses a SOAP header element present
in both the SOAP request and response messages to carry the conversation ID from the consumer to the service,
- and back again. Here's an example of a web service request that contains a conversation ID:
+ and back again. Here is an example of a web service request that contains a conversation ID:
</para>
<programlisting role="XML"><![CDATA[<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
@@ -120,9 +120,9 @@
<title>An example web service</title>
<para>
- Let's walk through an example web service. The code in this section all comes from the seamBay example
+ Let us walk through an example web service. The code in this section all comes from the seamBay example
application in Seam's <literal>/examples</literal> directory, and follows the recommended strategy as
- described in the previous section. Let's first take a look at the web service class and one of its web
+ described in the previous section. Let us first take a look at the web service class and one of its web
service methods:
</para>
@@ -166,7 +166,7 @@
</para>
<para>
- Let's look at another example. This web service method begins a new conversation by delegating to the
+ Let us look at another example. This web service method begins a new conversation by delegating to the
<literal>AuctionAction.createAuction()</literal> method:
</para>
@@ -179,7 +179,7 @@
}]]></programlisting>
<para>
- And here's the code from <literal>AuctionAction</literal>:
+ And here is the code from <literal>AuctionAction</literal>:
</para>
<programlisting role="JAVA"><![CDATA[ @Begin
More information about the jboss-cvs-commits
mailing list