Spring/spring-webflow
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Migrate reference guide to well-formed docbook XML

Browse Source 
Convert all docbook XML files to well-formed docbook 5 syntax:
 - Include xsi:schemaLocation element for tools support
 - Convert all id elements to xml:id
 - Convert all ulink elements to link
 - Cleanup trailing whitespace and tabs
This commit is contained in:
Phillip Webb
2013-01-29 19:32:15 -08:00
parent 1b42c4c219
commit 70c618d410
18 changed files with 2014 additions and 2003 deletions
Download Patch File Download Diff File Expand all files Collapse all files

388
src/reference/actions.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="actions">
<chapter xml:id="actions"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Executing actions</title>
<sect1 id="actions-introduction">
<sect1 xml:id="actions-introduction">
<title>Introduction</title>
<para>
This chapter shows you how to use the <code>action-state</code> element to control the execution of an action at a point within a flow.
@@ -12,52 +16,52 @@
Finally, several examples of invoking actions from the various points possible within a flow will be discussed.
</para>
</sect1>
<sect1 id="action-state">
<sect1 xml:id="action-state">
<title>Defining action states</title>
<para>
Use the <code>action-state</code> element when you wish to invoke an action, then transition to another state based on the action's outcome:
</para>
<programlisting language="xml"><![CDATA[
<action-state id="moreAnswersNeeded">
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
</action-state>]]>
</programlisting>
</programlisting>
<para>
The full example below illustrates a interview flow that uses the action-state above to determine if more answers are needed to complete the interview:
</para>
<programlisting language="xml"><![CDATA[
<flow xmlns="http://www.springframework.org/schema/webflow"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
<on-start>
<evaluate expression="interviewFactory.createInterview()" result="flowScope.interview" />
</on-start>
<on-start>
<evaluate expression="interviewFactory.createInterview()" result="flowScope.interview" />
</on-start>
<view-state id="answerQuestions" model="questionSet">
<on-entry>
<evaluate expression="interview.getNextQuestionSet()" result="viewScope.questionSet" />
</on-entry>
<transition on="submitAnswers" to="moreAnswersNeeded">
<evaluate expression="interview.recordAnswers(questionSet)" />
</transition>
</view-state>
<action-state id="moreAnswersNeeded">
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
</action-state>
<view-state id="answerQuestions" model="questionSet">
<on-entry>
<evaluate expression="interview.getNextQuestionSet()" result="viewScope.questionSet" />
</on-entry>
<transition on="submitAnswers" to="moreAnswersNeeded">
<evaluate expression="interview.recordAnswers(questionSet)" />
</transition>
</view-state>
<action-state id="moreAnswersNeeded">
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
</action-state>
<end-state id="finish" />
<end-state id="finish" />
</flow>]]>
</programlisting>
</programlisting>
</sect1>
<sect1 id="decision-state">
<sect1 xml:id="decision-state">
<title>Defining decision states</title>
<para>
Use the <code>decision-state</code> element as an alternative to the action-state to make a routing decision using a convenient if/else syntax.
@@ -65,11 +69,11 @@
</para>
<programlisting language="xml"><![CDATA[
<decision-state id="moreAnswersNeeded">
<if test="interview.moreAnswersNeeded()" then="answerQuestions" else="finish" />
<if test="interview.moreAnswersNeeded()" then="answerQuestions" else="finish" />
</decision-state>]]>
</programlisting>
</sect1>
<sect1 id="action-outcome-events">
<sect1 xml:id="action-outcome-events">
<title>Action outcome event mappings</title>
<para>
Actions often invoke methods on plain Java objects.
@@ -77,7 +81,7 @@
Since transitions are triggered by events, a method return value must first be mapped to an Event object.
The following table describes how common return value types are mapped to Event objects:
</para>
<table id="event-mapping-table">
<table xml:id="event-mapping-table">
<title>Action method return value to event id mappings</title>
<tgroup cols="2">
<colspec colname="Method return type" colwidth="*"/>
@@ -105,7 +109,7 @@
<entry>any other type</entry>
<entry>success</entry>
</row>
</tbody>
</tbody>
</tgroup>
</table>
<para>
@@ -113,13 +117,13 @@
</para>
<programlisting language="xml"><![CDATA[
<action-state id="moreAnswersNeeded">
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
<evaluate expression="interview.moreAnswersNeeded()" />
<transition on="yes" to="answerQuestions" />
<transition on="no" to="finish" />
</action-state>]]>
</programlisting>
</programlisting>
</sect1>
<sect1 id="action-implementations">
<sect1 xml:id="action-implementations">
<title>Action implementations</title>
<para>
While writing action code as POJO logic is the most common, there are several other action implementation options.
@@ -132,26 +136,26 @@
<sect2>
<title>Invoking a POJO action</title>
<programlisting language="xml"><![CDATA[
<evaluate expression="pojoAction.method(flowRequestContext)" />]]>
</programlisting>
<evaluate expression="pojoAction.method(flowRequestContext)" />]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class PojoAction {
public String method(RequestContext context) {
...
}
public String method(RequestContext context) {
...
}
}]]>
</programlisting>
</sect2>
<sect2>
<title>Invoking a custom Action implementation</title>
<programlisting language="xml"><![CDATA[
<evaluate expression="customAction" />]]>
</programlisting>
<evaluate expression="customAction" />]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class CustomAction implements Action {
public Event execute(RequestContext context) {
...
}
public Event execute(RequestContext context) {
...
}
}]]>
</programlisting>
</sect2>
@@ -159,24 +163,24 @@ public class CustomAction implements Action {
<title>Invoking a MultiAction implementation</title>
<programlisting language="xml"><![CDATA[
<evaluate expression="multiAction.actionMethod1" />
]]>
</programlisting>
]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class CustomMultiAction extends MultiAction {
public Event actionMethod1(RequestContext context) {
...
}
public Event actionMethod1(RequestContext context) {
...
}
public Event actionMethod2(RequestContext context) {
...
}
public Event actionMethod2(RequestContext context) {
...
}
...
...
}]]>
</programlisting>
</sect2>
</sect1>
<sect1 id="action-exceptions">
<sect1 xml:id="action-exceptions">
<title>Action exceptions</title>
<para>
Actions often invoke services that encapsulate complex business logic.
@@ -189,21 +193,21 @@ public class CustomMultiAction extends MultiAction {
The result is treated as a flow event which the calling flow can then respond to.
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="bookingAction.makeBooking(booking, flowRequestContext)" />]]>
</programlisting>
<evaluate expression="bookingAction.makeBooking(booking, flowRequestContext)" />]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class BookingAction {
public String makeBooking(Booking booking, RequestContext context) {
try {
BookingConfirmation confirmation = bookingService.make(booking);
context.getFlowScope().put("confirmation", confirmation);
return "success";
} catch (RoomNotAvailableException e) {
context.addMessage(new MessageBuilder().error().
.defaultText("No room is available at this hotel").build());
return "error";
}
}
public String makeBooking(Booking booking, RequestContext context) {
try {
BookingConfirmation confirmation = bookingService.make(booking);
context.getFlowScope().put("confirmation", confirmation);
return "success";
} catch (RoomNotAvailableException e) {
context.addMessage(new MessageBuilder().error().
.defaultText("No room is available at this hotel").build());
return "error";
}
}
}]]>
</programlisting>
</sect2>
@@ -214,144 +218,144 @@ public class BookingAction {
The MultiAction requires its action methods to be of the signature <code>Event ${methodName}(RequestContext)</code>, providing stronger type safety, while a POJO action allows for more freedom.
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="bookingAction.makeBooking" />]]>
</programlisting>
<evaluate expression="bookingAction.makeBooking" />]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class BookingAction extends MultiAction {
public Event makeBooking(RequestContext context) {
try {
Booking booking = (Booking) context.getFlowScope().get("booking");
BookingConfirmation confirmation = bookingService.make(booking);
context.getFlowScope().put("confirmation", confirmation);
return success();
} catch (RoomNotAvailableException e) {
context.getMessageContext().addMessage(new MessageBuilder().error().
.defaultText("No room is available at this hotel").build());
return error();
}
}
public Event makeBooking(RequestContext context) {
try {
Booking booking = (Booking) context.getFlowScope().get("booking");
BookingConfirmation confirmation = bookingService.make(booking);
context.getFlowScope().put("confirmation", confirmation);
return success();
} catch (RoomNotAvailableException e) {
context.getMessageContext().addMessage(new MessageBuilder().error().
.defaultText("No room is available at this hotel").build());
return error();
}
}
}]]>
</programlisting>
</sect2>
</sect2>
</sect1>
<sect1 id="action-examples">
<sect1 xml:id="action-examples">
<title>Other Action execution examples</title>
<sect2 id="action-on-start">
<sect2 xml:id="action-on-start">
<title>on-start</title>
<para>
The following example shows an action that creates a new Booking object by invoking a method on a service:
</para>
<programlisting language="xml"><![CDATA[
<flow xmlns="http://www.springframework.org/schema/webflow"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
<input name="hotelId" />
<input name="hotelId" />
<on-start>
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />
</on-start>
<on-start>
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />
</on-start>
</flow>]]>
</programlisting>
</sect2>
<sect2 id="action-on-state-entry">
<sect2 xml:id="action-on-state-entry">
<title>on-entry</title>
<para>
The following example shows a state entry action that sets the special <code>fragments</code> variable that causes the view-state to render a partial fragment of its view:
</para>
<programlisting language="xml"><![CDATA[
<view-state id="changeSearchCriteria" view="enterSearchCriteria.xhtml" popup="true">
<on-entry>
<render fragments="hotelSearchForm" />
</on-entry>
<on-entry>
<render fragments="hotelSearchForm" />
</on-entry>
</view-state>]]>
</programlisting>
</sect2>
<sect2 id="action-on-state-exit">
<sect2 xml:id="action-on-state-exit">
<title>on-exit</title>
<para>
The following example shows a state exit action that releases a lock on a record being edited:
</para>
<programlisting language="xml"><![CDATA[
<view-state id="editOrder">
<on-entry>
<evaluate expression="orderService.selectForUpdate(orderId, currentUser)"
result="viewScope.order" />
</on-entry>
<transition on="save" to="finish">
<evaluate expression="orderService.update(order, currentUser)" />
</transition>
<on-exit>
<evaluate expression="orderService.releaseLock(order, currentUser)" />
</on-exit>
<on-entry>
<evaluate expression="orderService.selectForUpdate(orderId, currentUser)"
result="viewScope.order" />
</on-entry>
<transition on="save" to="finish">
<evaluate expression="orderService.update(order, currentUser)" />
</transition>
<on-exit>
<evaluate expression="orderService.releaseLock(order, currentUser)" />
</on-exit>
</view-state>]]>
</programlisting>
</sect2>
<sect2 id="on-end">
<sect2 xml:id="on-end">
<title>on-end</title>
<para>
The following example shows the equivalent object locking behavior using flow start and end actions:
</para>
<programlisting language="xml"><![CDATA[
<flow xmlns="http://www.springframework.org/schema/webflow"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/webflow
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
<input name="orderId" />
<input name="orderId" />
<on-start>
<evaluate expression="orderService.selectForUpdate(orderId, currentUser)"
result="flowScope.order" />
</on-start>
<on-start>
<evaluate expression="orderService.selectForUpdate(orderId, currentUser)"
result="flowScope.order" />
</on-start>
<view-state id="editOrder">
<transition on="save" to="finish">
<evaluate expression="orderService.update(order, currentUser)" />
</transition>
</view-state>
<view-state id="editOrder">
<transition on="save" to="finish">
<evaluate expression="orderService.update(order, currentUser)" />
</transition>
</view-state>
<on-end>
<evaluate expression="orderService.releaseLock(order, currentUser)" />
</on-end>
<on-end>
<evaluate expression="orderService.releaseLock(order, currentUser)" />
</on-end>
</flow>]]>
</programlisting>
</sect2>
<sect2 id="action-on-render">
<sect2 xml:id="action-on-render">
<title>on-render</title>
<para>
The following example shows a render action that loads a list of hotels to display before the view is rendered:
</para>
<programlisting language="xml"><![CDATA[
<view-state id="reviewHotels">
<on-render>
<evaluate expression="bookingService.findHotels(searchCriteria)"
result="viewScope.hotels" result-type="dataModel" />
</on-render>
<transition on="select" to="reviewHotel">
<set name="flowScope.hotel" value="hotels.selectedRow" />
</transition>
<on-render>
<evaluate expression="bookingService.findHotels(searchCriteria)"
result="viewScope.hotels" result-type="dataModel" />
</on-render>
<transition on="select" to="reviewHotel">
<set name="flowScope.hotel" value="hotels.selectedRow" />
</transition>
</view-state>]]>
</programlisting>
</sect2>
<sect2 id="action-on-transition">
<sect2 xml:id="action-on-transition">
<title>on-transition</title>
<para>
The following example shows a transition action adds a subflow outcome event attribute to a collection:
</para>
<programlisting language="xml"><![CDATA[
<subflow-state id="addGuest" subflow="createGuest">
<transition on="guestCreated" to="reviewBooking">
<evaluate expression="booking.guestList.add(currentEvent.attributes.newGuest)" />
</transition>
<transition on="guestCreated" to="reviewBooking">
<evaluate expression="booking.guestList.add(currentEvent.attributes.newGuest)" />
</transition>
</subfow-state>]]>
</programlisting>
</sect2>
<sect2 id="named-actions">
</sect2>
<sect2 xml:id="named-actions">
<title>Named actions</title>
<para>
The following example shows how to execute a chain of actions in an action-state.
@@ -359,13 +363,13 @@ public class BookingAction extends MultiAction {
</para>
<programlisting language="xml"><![CDATA[
<action-state id="doTwoThings">
<evaluate expression="service.thingOne()">
<attribute name="name" value="thingOne" />
</evaluate>
<evaluate expression="service.thingTwo()">
<attribute name="name" value="thingTwo" />
</evaluate>
<transition on="thingTwo.success" to="showResults" />
<evaluate expression="service.thingOne()">
<attribute name="name" value="thingOne" />
</evaluate>
<evaluate expression="service.thingTwo()">
<attribute name="name" value="thingTwo" />
</evaluate>
<transition on="thingTwo.success" to="showResults" />
</action-state>]]>
</programlisting>
<para>
@@ -373,7 +377,7 @@ public class BookingAction extends MultiAction {
completes successfully.
</para>
</sect2>
<sect2 id="streaming-actions">
<sect2 xml:id="streaming-actions">
<title>Streaming actions</title>
<para>
Sometimes an Action needs to stream a custom response back to the client.
@@ -383,45 +387,45 @@ public class BookingAction extends MultiAction {
</para>
<programlisting language="xml"><![CDATA[
<view-state id="reviewItinerary">
<transition on="print">
<evaluate expression="printBoardingPassAction" />
</transition>
<transition on="print">
<evaluate expression="printBoardingPassAction" />
</transition>
</view-state>]]>
</programlisting>
<programlisting language="java"><![CDATA[
public class PrintBoardingPassAction extends AbstractAction {
public Event doExecute(RequestContext context) {
// stream PDF content here...
// - Access HttpServletResponse by calling context.getExternalContext().getNativeResponse();
// - Mark response complete by calling context.getExternalContext().recordResponseComplete();
return success();
}
public Event doExecute(RequestContext context) {
// stream PDF content here...
// - Access HttpServletResponse by calling context.getExternalContext().getNativeResponse();
// - Mark response complete by calling context.getExternalContext().recordResponseComplete();
return success();
}
}]]>
</programlisting>
</programlisting>
<para>
In this example, when the print event is raised the flow will call the printBoardingPassAction.
The action will render the PDF then mark the response as complete.
</para>
</sect2>
<sect2 id="file-upload">
<sect2 xml:id="file-upload">
<title>Handling File Uploads</title>
<para>
Another common task is to use Web Flow to handle multipart file uploads in combination with Spring MVC's
<code>MultipartResolver</code>. Once the resolver is set up correctly <ulink url="http://static.springsource.org/spring/docs/2.5.x/reference/mvc.html#mvc-multipart">as described here</ulink> and the submitting
HTML form is configured with <code>enctype="multipart/form-data"</code>, you can easily handle the file upload in a
transition action.
Another common task is to use Web Flow to handle multipart file uploads in combination with Spring MVC's
<code>MultipartResolver</code>. Once the resolver is set up correctly <link xl:href="http://static.springsource.org/spring/docs/2.5.x/reference/mvc.html#mvc-multipart">as described here</link> and the submitting
HTML form is configured with <code>enctype="multipart/form-data"</code>, you can easily handle the file upload in a
transition action.
</para>
<para>
Note that the File Upload example below below is not relevant when using Web Flow with JSF.
Check the documentation of your JSF component library to see what file upload components it provides.
Check the documentation of your JSF component library to see what file upload components it provides.
</para>
<para>
Given a form such as:
Given a form such as:
</para>
<programlisting language="xml"><![CDATA[
<form:form modelAttribute="fileUploadHandler" enctype="multipart/form-data">
Select file: <input type="file" name="file"/>
<input type="submit" name="_eventId_upload" value="Upload" />
Select file: <input type="file" name="file"/>
<input type="submit" name="_eventId_upload" value="Upload" />
</form:form>]]>
</programlisting>
<para>
@@ -433,16 +437,16 @@ package org.springframework.webflow.samples.booking;
import org.springframework.web.multipart.MultipartFile;
public class FileUploadHandler {
private transient MultipartFile file;
public void processFile() {
//Do something with the MultipartFile here
}
public void setFile(MultipartFile file) {
this.file = file;
}
private transient MultipartFile file;
public void processFile() {
//Do something with the MultipartFile here
}
public void setFile(MultipartFile file) {
this.file = file;
}
}]]>
</programlisting>
<para>
@@ -450,18 +454,18 @@ public class FileUploadHandler {
</para>
<programlisting language="xml"><![CDATA[
<view-state id="uploadFile" model="uploadFileHandler">
<var name="fileUploadHandler" class="org.springframework.webflow.samples.booking.FileUploadHandler" />
<transition on="upload" to="finish" >
<evaluate expression="fileUploadHandler.processFile()"/>
</transition>
<transition on="cancel" to="finish" bind="false"/>
<var name="fileUploadHandler" class="org.springframework.webflow.samples.booking.FileUploadHandler" />
<transition on="upload" to="finish" >
<evaluate expression="fileUploadHandler.processFile()"/>
</transition>
<transition on="cancel" to="finish" bind="false"/>
</view-state>]]>
</programlisting>
<para>
The <code>MultipartFile</code> will be bound to the <code>FileUploadHandler</code> bean as
part of the normal form binding process so that it will be available to process during the
The <code>MultipartFile</code> will be bound to the <code>FileUploadHandler</code> bean as
part of the normal form binding process so that it will be available to process during the
execution of the transition action.
</para>
</sect2>
</sect2>
</sect1>
</chapter>

148
src/reference/defining-flows.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="defining-flows">
<chapter xml:id="defining-flows"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Defining Flows</title>
<sect1 id="defining-flows-introduction">
<sect1 xml:id="defining-flows-introduction">
<title>Introduction</title>
<para>
This chapter begins the Users Section.
@@ -12,11 +16,11 @@
By the end of this chapter you should have a good understanding of language constructs, and be capable of authoring a flow definition.
</para>
</sect1>
<sect1 id="flow-overview">
<sect1 xml:id="flow-overview">
<title>What is a flow?</title>
<para>
A flow encapsulates a reusable sequence of steps that can execute in different contexts.
Below is a <ulink url="http://www.jjg.net/ia/visvocab/">Garrett Information Architecture</ulink> diagram illustrating a reference to a flow that encapsulates the steps of a hotel booking process:
Below is a <link xl:href="http://www.jjg.net/ia/visvocab/">Garrett Information Architecture</link> diagram illustrating a reference to a flow that encapsulates the steps of a hotel booking process:
</para>
<mediaobject>
<imageobject role="fo">
@@ -30,7 +34,7 @@
</caption>
</mediaobject>
</sect1>
<sect1 id="flow-makeup">
<sect1 xml:id="flow-makeup">
<title>What is the makeup of a typical flow?</title>
<para>
In Spring Web Flow, a flow consists of a series of steps called "states".
@@ -51,18 +55,18 @@
<caption>
<para>Flow diagram</para>
</caption>
</mediaobject>
</mediaobject>
</sect1>
<sect1 id="flow-authoring">
<sect1 xml:id="flow-authoring">
<title>How are flows authored?</title>
<para>
Flows are authored by web application developers using a simple XML-based flow definition language.
The next steps of this guide will walk you through the elements of this language.
</para>
</sect1>
<sect1 id="essential-flow-elements">
<sect1 xml:id="essential-flow-elements">
<title>Essential language elements</title>
<sect2 id="flow-element">
<sect2 xml:id="flow-element">
<title>flow</title>
<para>
Every flow begins with the following root element:
@@ -81,7 +85,7 @@
The first state defined becomes the flow's starting point.
</para>
</sect2>
<sect2 id="view-state-element">
<sect2 xml:id="view-state-element">
<title>view-state</title>
<para>
Use the <code>view-state</code> element to define a step of the flow that renders a view:
@@ -91,11 +95,11 @@
</programlisting>
<para>
By convention, a view-state maps its id to a view template in the directory where the flow is located.
For example, the state above might render <filename>/WEB-INF/hotels/booking/enterBookingDetails.xhtml</filename>
For example, the state above might render <filename>/WEB-INF/hotels/booking/enterBookingDetails.xhtml</filename>
if the flow itself was located in the <filename>/WEB-INF/hotels/booking</filename> directory.
</para>
</sect2>
<sect2 id="transition-element">
<sect2 xml:id="transition-element">
<title>transition</title>
<para>
Use the <code>transition</code> element to handle events that occur within a state:
@@ -109,7 +113,7 @@
These transitions drive view navigations.
</para>
</sect2>
<sect2 id="end-state-element">
<sect2 xml:id="end-state-element">
<title>end-state</title>
<para>
Use the <code>end-state</code> element to define a flow outcome:
@@ -121,9 +125,9 @@
When a flow transitions to a end-state it terminates and the outcome is returned.
</para>
</sect2>
<sect2 id="checkpoint-essential-language-elements">
<sect2 xml:id="checkpoint-essential-language-elements">
<title>Checkpoint: Essential language elements</title>
<para>
<para>
With the three elements <code>view-state</code>, <code>transition</code>, and <code>end-state</code>, you can quickly express your view navigation logic.
Teams often do this before adding flow behaviors so they can focus on developing the user interface of the application with end users first.
Below is a sample flow that implements its view navigation logic using these elements:
@@ -137,22 +141,22 @@
<view-state id="enterBookingDetails">
<transition on="submit" to="reviewBooking" />
</view-state>
<view-state id="reviewBooking">
<transition on="confirm" to="bookingConfirmed" />
<transition on="revise" to="enterBookingDetails" />
<transition on="cancel" to="bookingCancelled" />
</view-state>
<end-state id="bookingConfirmed" />
<end-state id="bookingCancelled" />
</flow>]]>
</flow>]]>
</programlisting>
</sect2>
</sect1>
<sect1 id="flow-actions">
<sect1 xml:id="flow-actions">
<title>Actions</title>
<para>
Most flows need to express more than just view navigation logic.
@@ -167,13 +171,13 @@
<listitem><para>On transition execution</para></listitem>
<listitem><para>On state exit</para></listitem>
<listitem><para>On flow end</para></listitem>
</itemizedlist>
</itemizedlist>
</para>
<para>
Actions are defined using a concise expression language. Spring Web Flow uses the Unified EL by default.
The next few sections will cover the essential language elements for defining actions.
</para>
<sect2 id="evaluate-element">
<sect2 xml:id="evaluate-element">
<title>evaluate</title>
<para>
The action element you will use most often is the <code>evaluate</code> element.
@@ -182,9 +186,9 @@
For example:
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="entityManager.persist(booking)" />]]>
<evaluate expression="entityManager.persist(booking)" />]]>
</programlisting>
<sect3 id="evaluate-element-result">
<sect3 xml:id="evaluate-element-result">
<title>Assigning an evaluate result</title>
<para>
If the expression returns a value, that value can be saved in the flow's data model called <code>flowScope</code>:
@@ -193,7 +197,7 @@
<evaluate expression="bookingService.findHotels(searchCriteria)" result="flowScope.hotels" />]]>
</programlisting>
</sect3>
<sect3 id="evaluate-element-result-type">
<sect3 xml:id="evaluate-element-result-type">
<title>Converting an evaluate result</title>
<para>
If the expression returns a value that may need to be converted, specify the desired type using the <code>result-type</code> attribute:
@@ -204,9 +208,9 @@
</programlisting>
</sect3>
</sect2>
<sect2 id="checkpoint-actions">
<sect2 xml:id="checkpoint-actions">
<title>Checkpoint: flow actions</title>
<para>
<para>
Now review the sample booking flow with actions added:
</para>
<programlisting language="xml"><![CDATA[
@@ -218,25 +222,25 @@
<input name="hotelId" />
<on-start>
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />
</on-start>
<view-state id="enterBookingDetails">
<transition on="submit" to="reviewBooking" />
</view-state>
<view-state id="reviewBooking">
<transition on="confirm" to="bookingConfirmed" />
<transition on="revise" to="enterBookingDetails" />
<transition on="cancel" to="bookingCancelled" />
</view-state>
<end-state id="bookingConfirmed" />
<end-state id="bookingCancelled" />
</flow>]]>
</flow>]]>
</programlisting>
<para>
This flow now creates a Booking object in flow scope when it starts.
@@ -244,7 +248,7 @@
</para>
</sect2>
</sect1>
<sect1 id="flow-inputoutput">
<sect1 xml:id="flow-inputoutput">
<title>Input/Output Mapping</title>
<para>
Each flow has a well-defined input/output contract.
@@ -259,11 +263,11 @@ FlowOutcome flowId(Map<String, Object> inputAttributes);]]>
</para>
<programlisting language="java"><![CDATA[
public interface FlowOutcome {
public String getName();
public String getName();
public Map<String, Object> getOutputAttributes();
}]]>
</programlisting>
<sect2 id="input-element">
<sect2 xml:id="input-element">
<title>input</title>
<para>
Use the <code>input</code> element to declare a flow input attribute:
@@ -275,7 +279,7 @@ public interface FlowOutcome {
Input values are saved in flow scope under the name of the attribute.
For example, the input above would be saved under the name <code>hotelId</code>.
</para>
<sect3 id="input-element-type">
<sect3 xml:id="input-element-type">
<title>Declaring an input type</title>
<para>
Use the <code>type</code> attribute to declare the input attribute's type:
@@ -287,7 +291,7 @@ public interface FlowOutcome {
If an input value does not match the declared type, a type conversion will be attempted.
</para>
</sect3>
<sect3 id="input-element-value">
<sect3 xml:id="input-element-value">
<title>Assigning an input value</title>
<para>
Use the <code>value</code> attribute to specify an expression to assign the input value to:
@@ -299,7 +303,7 @@ public interface FlowOutcome {
If the expression's value type can be determined, that metadata will be used for type coersion if no <code>type</code> attribute is specified.
</para>
</sect3>
<sect3 id="input-element-required">
<sect3 xml:id="input-element-required">
<title>Marking an input as required</title>
<para>
Use the <code>required</code> attribute to enforce the input is not null or empty:
@@ -309,7 +313,7 @@ public interface FlowOutcome {
</programlisting>
</sect3>
</sect2>
<sect2 id="output-element">
<sect2 xml:id="output-element">
<title>output</title>
<para>
Use the <code>output</code> element to declare a flow output attribute.
@@ -317,26 +321,26 @@ public interface FlowOutcome {
</para>
<programlisting language="xml"><![CDATA[
<end-state id="bookingConfirmed">
<output name="bookingId" />
<output name="bookingId" />
</end-state>]]>
</programlisting>
<para>
Output values are obtained from flow scope under the name of the attribute.
For example, the output above would be assigned the value of the <code>bookingId</code> variable.
</para>
<sect3 id="output-element-value">
<sect3 xml:id="output-element-value">
<title>Specifying the source of an output value</title>
<para>
Use the <code>value</code> attribute to denote a specific output value expression:
</para>
<programlisting language="xml"><![CDATA[
<output name="confirmationNumber" value="booking.confirmationNumber" />]]>
<output name="confirmationNumber" value="booking.confirmationNumber" />]]>
</programlisting>
</sect3>
</sect2>
<sect2 id="checkpoint-input-output">
<sect2 xml:id="checkpoint-input-output">
<title>Checkpoint: input/output mapping</title>
<para>
<para>
Now review the sample booking flow with input/output mapping:
</para>
<programlisting language="xml"><![CDATA[
@@ -348,42 +352,42 @@ public interface FlowOutcome {
<input name="hotelId" />
<on-start>
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />
</on-start>
<view-state id="enterBookingDetails">
<transition on="submit" to="reviewBooking" />
</view-state>
<view-state id="reviewBooking">
<transition on="confirm" to="bookingConfirmed" />
<transition on="revise" to="enterBookingDetails" />
<transition on="cancel" to="bookingCancelled" />
</view-state>
<end-state id="bookingConfirmed" >
<output name="bookingId" value="booking.id"/>
</end-state>
<end-state id="bookingCancelled" />
</flow>]]>
</programlisting>
</flow>]]>
</programlisting>
<para>
The flow now accepts a <code>hotelId</code> input attribute and returns a <code>bookingId</code> output attribute
when a new booking is confirmed.
</para>
</para>
</sect2>
</sect1>
<sect1 id="flow-variables">
<sect1 xml:id="flow-variables">
<title>Variables</title>
<para>
A flow may declare one or more instance variables.
These variables are allocated when the flow starts.
Any <code>@Autowired</code> transient references the variable holds are also rewired when the flow resumes.
</para>
<sect2 id="var-element">
<sect2 xml:id="var-element">
<title>var</title>
<para>
Use the <code>var</code> element to declare a flow variable:
@@ -396,12 +400,12 @@ public interface FlowOutcome {
</para>
</sect2>
</sect1>
<sect1 id="calling-subflows">
<sect1 xml:id="calling-subflows">
<title>Calling subflows</title>
<para>
A flow may call another flow as a subflow. The flow will wait until the subflow returns, then respond to the subflow outcome.
</para>
<sect2 id="subflow-state-element">
<sect2 xml:id="subflow-state-element">
<title>subflow-state</title>
<para>
Use the <code>subflow-state</code> element to call another flow as a subflow:
@@ -409,7 +413,7 @@ public interface FlowOutcome {
<programlisting language="xml"><![CDATA[
<subflow-state id="addGuest" subflow="createGuest">
<transition on="guestCreated" to="reviewBooking">
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
</transition>
<transition on="creationCancelled" to="reviewBooking" />
</subflow-state>]]>
@@ -418,7 +422,7 @@ public interface FlowOutcome {
The above example calls the <code>createGuest</code> flow, then waits for it to return.
When the flow returns with a <code>guestCreated</code> outcome, the new guest is added to the booking's guest list.
</para>
<sect3 id="subflow-state-element-input">
<sect3 xml:id="subflow-state-element-input">
<title>Passing a subflow input</title>
<para>
Use the <code>input</code> element to pass input to the subflow:
@@ -430,24 +434,24 @@ public interface FlowOutcome {
</subflow-state>]]>
</programlisting>
</sect3>
<sect3 id="subflow-state-element-output">
<sect3 xml:id="subflow-state-element-output">
<title>Mapping subflow output</title>
<para>
Simply refer to a subflow output attribute by its name within a outcome transition:
</para>
<programlisting language="xml"><![CDATA[
<transition on="guestCreated" to="reviewBooking">
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
</transition>]]>
</programlisting>
<para>
In the above example, <code>guest</code> is the name of an output attribute returned by the <code>guestCreated</code> outcome.
</para>
</sect3>
</sect3>
</sect2>
<sect2 id="checkpoint-subflow">
<sect2 xml:id="checkpoint-subflow">
<title>Checkpoint: calling subflows</title>
<para>
<para>
Now review the sample booking flow calling a subflow:
</para>
<programlisting language="xml"><![CDATA[
@@ -459,7 +463,7 @@ public interface FlowOutcome {
<input name="hotelId" />
<on-start>
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />
</on-start>
@@ -476,22 +480,22 @@ public interface FlowOutcome {
<subflow-state id="addGuest" subflow="createGuest">
<transition on="guestCreated" to="reviewBooking">
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />
</transition>
<transition on="creationCancelled" to="reviewBooking" />
</subflow-state>
<end-state id="bookingConfirmed" >
<output name="bookingId" value="booking.id" />
</end-state>
<end-state id="bookingCancelled" />
</flow>]]>
</flow>]]>
</programlisting>
<para>
The flow now calls a <code>createGuest</code> subflow to add a new guest to the guest list.
</para>
</sect2>
</para>
</sect2>
</sect1>
</chapter>

110
src/reference/el.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="el">
<chapter xml:id="el"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Expression Language (EL)</title>
<sect1 id="el-introduction">
<sect1 xml:id="el-introduction">
<title>Introduction</title>
<para>
Web Flow uses EL to access its data model and to invoke actions.
@@ -23,12 +27,12 @@
EL is also used to bind form parameters to model objects and reversely to render formatted form fields from the properties of a model object.
That however does not apply when using Web Flow with JSF in which case the standard JSF component lifecyle applies.
</para>
<sect2 id="el-types">
<sect2 xml:id="el-types">
<title>Expression types</title>
<para>
An important concept to understand is there are two types of expressions in Web Flow: standard expressions and template expressions.
</para>
<sect3 id="el-types-eval">
<sect3 xml:id="el-types-eval">
<title>Standard Expressions</title>
<para>
The first and most common type of expression is the <emphasis>standard expression</emphasis>.
@@ -43,10 +47,10 @@
If you attempt to enclose this expression in a special delimiter like <code>#{}</code> you will get an <code>IllegalArgumentException</code>.
In this context the delimiter is seen as redundant.
The only acceptable value for the <code>expression</code> attribute is an single expression string.
</para>
</para>
</sect3>
<sect3 id="el-types-template">
<title>Template expressions</title>
<sect3 xml:id="el-types-template">
<title>Template expressions</title>
<para>
The second type of expression is a <emphasis>template expression</emphasis>.
A template expression allows mixing of literal text with one or more standard expressions.
@@ -70,25 +74,25 @@
</sect3>
</sect2>
</sect1>
<sect1 id="el-language-choices">
<sect1 xml:id="el-language-choices">
<title>EL Implementations</title>
<sect2 id="el-spring-el">
<sect2 xml:id="el-spring-el">
<title>Spring EL</title>
<para>
Starting with version 2.1 Web Flow uses the <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/expressions.html">Spring Expression Language</ulink> (Spring EL).
Starting with version 2.1 Web Flow uses the <link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/expressions.html">Spring Expression Language</link> (Spring EL).
Spring EL was created to provide is a single, well-supported expression language for use across all the products in the Spring portfolio.
It is distributed as a separate jar <code>org.springframework.expression</code> in the Spring Framework.
Existing applications will need to remove dependencies on <code>org.jboss.el</code> or <code>org.ognl</code> and use <code>org.springframework.expression</code> instead.
See the section below on EL Portability for other notes on upgrading.
</para>
</sect2>
<sect2 id="el-unified-el">
<sect2 xml:id="el-unified-el">
<title>Unified EL</title>
<para>
In Web Flow 2.0 <ulink url="http://en.wikipedia.org/wiki/Unified_Expression_Language">Unified EL</ulink> was the default expression language with <code>jboss-el</code> as the implementation.
Use of Unified EL also implies a dependency on <code>el-api</code> although that is typically <emphasis>provided</emphasis> by your web container.
In Web Flow 2.0 <link xl:href="http://en.wikipedia.org/wiki/Unified_Expression_Language">Unified EL</link> was the default expression language with <code>jboss-el</code> as the implementation.
Use of Unified EL also implies a dependency on <code>el-api</code> although that is typically <emphasis>provided</emphasis> by your web container.
Tomcat 6 includes it, for example.
Spring EL is the default and recommended expression language to use.
Spring EL is the default and recommended expression language to use.
However it is possible to replace it with Unified EL if you wish to do so.
You need the following Spring configuration to plug in the <code>WebFlowELExpressionParser</code> to the <code>flow-builder-services</code>:
<programlisting language="xml"><![CDATA[
@@ -115,13 +119,13 @@
</programlisting>
</para>
</sect2>
<sect2 id="el-ognl">
<sect2 xml:id="el-ognl">
<title>OGNL</title>
<para>
<ulink url="http://www.ognl.org">OGNL</ulink> is the third supported expression language.
<link xl:href="http://www.ognl.org">OGNL</link> is the third supported expression language.
OGNL is the EL most familiar to Web Flow version 1.0 users.
Please refer to the <ulink url="http://www.ognl.org/2.6.9/Documentation/html/LanguageGuide/index.html">OGNL language guide</ulink> for specifics on its EL syntax.
If you wish to use OGNL this is the Spring configuration necessary to plug it in:
Please refer to the <link xl:href="http://www.ognl.org/2.6.9/Documentation/html/LanguageGuide/index.html">OGNL language guide</link> for specifics on its EL syntax.
If you wish to use OGNL this is the Spring configuration necessary to plug it in:
<programlisting language="xml"><![CDATA[
<webflow:flow-builder-services expression-parser="expressionParser"/>
@@ -140,7 +144,7 @@
</para>
</sect2>
</sect1>
<sect1 id="el-portability">
<sect1 xml:id="el-portability">
<title>EL portability</title>
<para>
In general, you will find Spring EL, Unified EL and OGNL to have a very similar syntax.
@@ -162,10 +166,10 @@
</para>
</listitem>
</orderedlist>
For more information on Spring EL syntax please refer to the <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/expressions.html#expressions-language-ref">Language Reference</ulink> section in the Spring Documentation.
For more information on Spring EL syntax please refer to the <link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/expressions.html#expressions-language-ref">Language Reference</link> section in the Spring Documentation.
</para>
</sect1>
<sect1 id="el-variables">
<sect1 xml:id="el-variables">
<title>Special EL variables</title>
<para>
There are several implicit variables you may reference from within a flow.
@@ -176,7 +180,7 @@
Variables referring to data scopes (flowScope, viewScope, requestScope, etc.) should only be used when assigning a new variable to one of the scopes.
</para>
<para>
For example when assigning the result of the call to <code>bookingService.findHotels(searchCriteria)</code> to a new variable called "hotels" you must prefix it with a scope variable in order to let Web Flow know where you want it stored:
For example when assigning the result of the call to <code>bookingService.findHotels(searchCriteria)</code> to a new variable called "hotels" you must prefix it with a scope variable in order to let Web Flow know where you want it stored:
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<flow xmlns="http://www.springframework.org/schema/webflow" ... >
@@ -188,7 +192,7 @@
<evaluate expression="bookingService.findHotels(searchCriteria)" result="viewScope.hotels" />
</on-render>
</view-state>
</flow>]]>
</programlisting>
However when setting an existing variable such as "searchCriteria" in the example below, you reference the variable directly without prefixing it with any scope variables:
@@ -210,23 +214,23 @@
<para>
The following is the list of implicit variables you can reference within a flow definition:
</para>
<sect2 id="el-variable-flowScope">
<sect2 xml:id="el-variable-flowScope">
<title>flowScope</title>
<para>
Use <code>flowScope</code> to assign a flow variable.
Flow scope gets allocated when a flow starts and destroyed when the flow ends. With the default
Flow scope gets allocated when a flow starts and destroyed when the flow ends. With the default
implementation, any objects stored in flow scope need to be Serializable.
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="searchService.findHotel(hotelId)" result="flowScope.hotel" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-viewScope">
<sect2 xml:id="el-variable-viewScope">
<title>viewScope</title>
<para>
Use <code>viewScope</code> to assign a view variable.
View scope gets allocated when a <code>view-state</code> enters and destroyed when the state exits.
View scope is <emphasis>only</emphasis> referenceable from within a <code>view-state</code>. With the
View scope is <emphasis>only</emphasis> referenceable from within a <code>view-state</code>. With the
default implementation, any objects stored in view scope need to be Serializable.
</para>
<programlisting language="xml"><![CDATA[
@@ -235,8 +239,8 @@
result-type="dataModel" />
</on-render>]]>
</programlisting>
</sect2>
<sect2 id="el-variable-requestScope">
</sect2>
<sect2 xml:id="el-variable-requestScope">
<title>requestScope</title>
<para>
Use <code>requestScope</code> to assign a request variable.
@@ -246,31 +250,31 @@
<set name="requestScope.hotelId" value="requestParameters.id" type="long" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-flashScope">
<sect2 xml:id="el-variable-flashScope">
<title>flashScope</title>
<para>
Use <code>flashScope</code> to assign a flash variable.
Flash scope gets allocated when a flow starts, cleared after every view render, and destroyed when the
Flash scope gets allocated when a flow starts, cleared after every view render, and destroyed when the
flow ends. With the default implementation, any objects stored in flash scope need to be Serializable.
</para>
<programlisting language="xml"><![CDATA[
<set name="flashScope.statusMessage" value="'Booking confirmed'" />]]>
<set name="flashScope.statusMessage" value="'Booking confirmed'" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-conversationScope">
<sect2 xml:id="el-variable-conversationScope">
<title>conversationScope</title>
<para>
Use <code>conversationScope</code> to assign a conversation variable.
Conversation scope gets allocated when a top-level flow starts and destroyed when the top-level flow ends.
Conversation scope is shared by a top-level flow and all of its subflows. With the default
implementation, conversation scoped objects are stored in the HTTP session and should generally be
Conversation scope is shared by a top-level flow and all of its subflows. With the default
implementation, conversation scoped objects are stored in the HTTP session and should generally be
Serializable to account for typical session replication.
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="searchService.findHotel(hotelId)" result="conversationScope.hotel" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-requestParameters">
<sect2 xml:id="el-variable-requestParameters">
<title>requestParameters</title>
<para>
Use <code>requestParameters</code> to access a client request parameter:
@@ -279,7 +283,7 @@
<set name="requestScope.hotelId" value="requestParameters.id" type="long" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-currentEvent">
<sect2 xml:id="el-variable-currentEvent">
<title>currentEvent</title>
<para>
Use <code>currentEvent</code> to access attributes of the current <code>Event</code>:
@@ -288,17 +292,17 @@
<evaluate expression="booking.guests.add(currentEvent.attributes.guest)" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-currentUser">
<sect2 xml:id="el-variable-currentUser">
<title>currentUser</title>
<para>
Use <code>currentUser</code> to access the authenticated <code>Principal</code>:
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
<evaluate expression="bookingService.createBooking(hotelId, currentUser.name)"
result="flowScope.booking" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-messageContext">
<sect2 xml:id="el-variable-messageContext">
<title>messageContext</title>
<para>
Use <code>messageContext</code> to access a context for retrieving and creating flow execution messages, including error and success messages.
@@ -308,7 +312,7 @@
<evaluate expression="bookingValidator.validate(booking, messageContext)" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-resourceBundle">
<sect2 xml:id="el-variable-resourceBundle">
<title>resourceBundle</title>
<para>
Use <code>resourceBundle</code> to access a message resource.
@@ -317,39 +321,39 @@
<set name="flashScope.successMessage" value="resourceBundle.successMessage" />]]>
</programlisting>
</sect2>
<sect2 id="el-variable-requestContext">
<sect2 xml:id="el-variable-requestContext">
<title>flowRequestContext</title>
<para>
Use <code>flowRequestContext</code> to access the <code>RequestContext</code> API, which is a representation of the current flow request.
See the API Javadocs for more information.
</para>
</sect2>
<sect2 id="el-variable-flowExecutionContext">
</sect2>
<sect2 xml:id="el-variable-flowExecutionContext">
<title>flowExecutionContext</title>
<para>
Use <code>flowExecutionContext</code> to access the <code>FlowExecutionContext</code> API, which is a representation of the current flow state.
See the API Javadocs for more information.
</para>
</sect2>
<sect2 id="el-variable-flowExecutionUrl">
</sect2>
<sect2 xml:id="el-variable-flowExecutionUrl">
<title>flowExecutionUrl</title>
<para>
Use <code>flowExecutionUrl</code> to access the context-relative URI for the current flow execution view-state.
</para>
</sect2>
<sect2 id="el-variable-externalContext">
</sect2>
<sect2 xml:id="el-variable-externalContext">
<title>externalContext</title>
<para>
Use <code>externalContext</code> to access the client environment, including user session attributes.
See the <code>ExternalContext</code> API JavaDocs for more information.
</para>
<programlisting language="xml"><![CDATA[
<evaluate expression="searchService.suggestHotels(externalContext.sessionMap.userProfile)"
<evaluate expression="searchService.suggestHotels(externalContext.sessionMap.userProfile)"
result="viewScope.hotels" />]]>
</programlisting>
</sect2>
</sect1>
<sect1 id="el-scope-searching">
<sect1 xml:id="el-scope-searching">
<title>Scope searching algorithm</title>
<para>
As mentioned earlier in this section when assigning a variable in one of the flow scopes, referencing that scope is required.

92
src/reference/flow-definition-field-mappings.xml
View File

@@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="field-mappings">
<appendix xml:id="field-mappings"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Flow Definition Language 1.0 to 2.0 Mappings</title>
<para>
The flow definition language has changed since the 1.0 release.
This is a listing of the language elements in the 1.0 release, and how they map to elements in the 2.0 release.
While most of the changes are semantic, there are a few structural changes.
Please see the upgrade guide for more details about changes between Web Flow 1.0 and 2.0.
Please see the upgrade guide for more details about changes between Web Flow 1.0 and 2.0.
</para>
<table id="field-mappings-table">
<table xml:id="field-mappings-table">
<title>Mappings</title>
<tgroup cols="5">
<colspec colname="1.0-element" colwidth="*"/>
@@ -69,8 +73,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>action-state</emphasis>
@@ -95,8 +97,6 @@
parent
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>argument</emphasis>
@@ -118,8 +118,6 @@
parameter-type
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>attribute</emphasis>
@@ -152,8 +150,6 @@
value
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>attribute-mapper</emphasis>
@@ -176,8 +172,6 @@
now subflow-attribute-mapper attribute on subflow-state
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>bean-action</emphasis>
@@ -213,8 +207,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>decision-state</emphasis>
@@ -239,8 +231,6 @@
parent
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>end-actions</emphasis>
@@ -249,8 +239,6 @@
<emphasis>on-end</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>end-state</emphasis>
@@ -291,8 +279,6 @@
commit
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>entry-actions</emphasis>
@@ -301,8 +287,6 @@
<emphasis>on-entry</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>evaluate-action</emphasis>
@@ -346,8 +330,6 @@
result-type
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>evaluation-result</emphasis>
@@ -356,7 +338,7 @@
<emphasis>*</emphasis>
</entry>
<entry colname="comments">
use &lt;evaluate result="..." /&gt;
use &lt;evaluate result="..." /&gt;
</entry>
</row>
<row>
@@ -375,8 +357,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>exception-handler</emphasis>
@@ -393,8 +373,6 @@
bean
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>exit-actions</emphasis>
@@ -403,8 +381,6 @@
<emphasis>on-exit</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>flow</emphasis>
@@ -437,8 +413,6 @@
abstract
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>global-transitions</emphasis>
@@ -447,8 +421,6 @@
<emphasis>global-transitions</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>if</emphasis>
@@ -481,8 +453,6 @@
else
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>import</emphasis>
@@ -499,8 +469,6 @@
resource
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>inline-flow</emphasis>
@@ -520,8 +488,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>input-attribute</emphasis>
@@ -573,8 +539,6 @@
value
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>input-mapper</emphasis>
@@ -586,8 +550,6 @@
inputs can be in flows and subflows directly
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>mapping</emphasis>
@@ -656,8 +618,6 @@
required
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>method-argument</emphasis>
@@ -669,8 +629,6 @@
use &lt;evaluate expression="func(arg1, arg2, ...)"/&gt;
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>method-result</emphasis>
@@ -698,8 +656,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>output-attribute</emphasis>
@@ -751,8 +707,6 @@
value
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>output-mapper</emphasis>
@@ -764,8 +718,6 @@
output can be in flows and subflows directly
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>render-actions</emphasis>
@@ -774,8 +726,6 @@
<emphasis>on-render</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>set</emphasis>
@@ -830,8 +780,6 @@
type
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>start-actions</emphasis>
@@ -840,8 +788,6 @@
<emphasis>on-start</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>start-state</emphasis>
@@ -861,8 +807,6 @@
*
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>subflow-state</emphasis>
@@ -903,8 +847,6 @@
subflow-attribute-mapper
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>transition</emphasis>
@@ -961,8 +903,6 @@
history
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>value</emphasis>
@@ -971,8 +911,6 @@
<emphasis>value</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>var</emphasis>
@@ -1019,8 +957,6 @@
all Spring beans can be resolved with EL
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>view-state</emphasis>
@@ -1085,8 +1021,6 @@
history
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>*</emphasis>
@@ -1095,8 +1029,6 @@
<emphasis>persistence-context</emphasis>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>*</emphasis>
@@ -1113,8 +1045,6 @@
fragments
</entry>
</row>
</tbody>
<tbody>
<row>
<entry spanname="1.0-element">
<emphasis>*</emphasis>

34
src/reference/flow-inheritance.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="flow-inheritance">
<chapter xml:id="flow-inheritance"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Flow Inheritance</title>
<sect1 id="flow-inheritance-introduction">
<sect1 xml:id="flow-inheritance-introduction">
<title>Introduction</title>
<para>
Flow inheritance allows one flow to inherit the configuration of another flow.
@@ -15,7 +19,7 @@
In order for a parent flow to be found, it must be added to the <code>flow-registry</code> just like any other flow.
</para>
</sect1>
<sect1 id="flow-inheritance-java-comparison">
<sect1 xml:id="flow-inheritance-java-comparison">
<title>Is flow inheritance like Java inheritance?</title>
<para>
Flow inheritance is similar to Java inheritance in that elements defined in a parent are exposed via the child, however, there are key differences.
@@ -30,9 +34,9 @@
Java inheritance is limited to a single class.
</para>
</sect1>
<sect1 id="flow-inheritance-levels">
<sect1 xml:id="flow-inheritance-levels">
<title>Types of Flow Inheritance</title>
<sect2 id="flow-inheritance-level-flow">
<sect2 xml:id="flow-inheritance-level-flow">
<title>Flow level inheritance</title>
<para>
Flow level inheritance is defined by the <code>parent</code> attribute on the <code>flow</code> element.
@@ -44,7 +48,7 @@
<flow parent="common-transitions, common-states">]]>
</programlisting>
</sect2>
<sect2 id="flow-inheritance-level-state">
<sect2 xml:id="flow-inheritance-level-state">
<title>State level inheritance</title>
<para>
State level inheritance is similar to flow level inheritance, except only one state inherits from the parent, instead of the entire flow.
@@ -52,7 +56,7 @@
<para>
Unlike flow inheritance, only a single parent is allowed.
Additionally, the identifier of the flow state to inherit from must also be defined.
The identifiers for the flow and the state within that flow are separated by a #.
The identifiers for the flow and the state within that flow are separated by a #.
</para>
<para>
The parent and child states must be of the same type.
@@ -63,7 +67,7 @@
</programlisting>
</sect2>
</sect1>
<sect1 id="flow-inheritance-abstract">
<sect1 xml:id="flow-inheritance-abstract">
<title>Abstract flows</title>
<para>
Often parent flows are not designed to be executed directly.
@@ -74,7 +78,7 @@
<flow abstract="true">]]>
</programlisting>
</sect1>
<sect1 id="flow-inheritance-algorithm">
<sect1 xml:id="flow-inheritance-algorithm">
<title>Inheritance Algorithm</title>
<para>
When a child flow inherits from it's parent, essentially what happens is that the parent and child are merged together to create a new flow.
@@ -93,12 +97,12 @@
Once merged, all relative paths in the parent flow will become relative to the child flow.
</para>
</note>
<sect2 id="flow-inheritance-algorithm-mergeable">
<sect2 xml:id="flow-inheritance-algorithm-mergeable">
<title>Mergeable Elements</title>
<para>
If the elements are of the same type and their keyed attribute are identical, the content of the parent element will be merged with the child element.
The merge algorithm will continue to merge each sub-element of the merging parent and child.
Otherwise the parent element is added as a new element to the child.
Otherwise the parent element is added as a new element to the child.
</para>
<para>
In most cases, elements from a parent flow that are added will be added after elements in the child flow.
@@ -162,7 +166,7 @@
</itemizedlist>
</para>
</sect2>
<sect2 id="flow-inheritance-nonmergeable">
<sect2 xml:id="flow-inheritance-nonmergeable">
<title>Non-mergeable Elements</title>
<para>
Non-mergeable elements are:

32
src/reference/flow-managed-persistence.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="flow-managed-persistence">
<chapter xml:id="flow-managed-persistence"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Flow Managed Persistence</title>
<sect1 id="flow-managed-persistence-introduction">
<sect1 xml:id="flow-managed-persistence-introduction">
<title>Introduction</title>
<para>
Most applications access data in some way.
@@ -19,7 +23,7 @@
This chapter will focus on the flow-managed persistence, exploring how and when to use this feature.
</para>
</sect1>
<sect1 id="flowScopedPersistenceContext">
<sect1 xml:id="flowScopedPersistenceContext">
<title>FlowScoped PersistenceContext</title>
<para>
This pattern creates a <code>PersistenceContext</code> in <code>flowScope</code> on flow startup,
@@ -41,12 +45,12 @@
http://www.springframework.org/schema/webflow/spring-webflow-2.0.xsd">
<persistence-context />
</flow>
]]></programlisting>
<para>
Then configure the correct <code>FlowExecutionListener</code> to apply this pattern to your flow.
If using Hibernate, register the <code>HibernateFlowExecutionListener</code>. If using JPA, register the <code>JpaFlowExecutionListener</code>.
If using Hibernate, register the <code>HibernateFlowExecutionListener</code>. If using JPA, register the <code>JpaFlowExecutionListener</code>.
</para>
<programlisting language="xml"><![CDATA[
<webflow:flow-executor id="flowExecutor" flow-registry="flowRegistry">
@@ -54,8 +58,8 @@
<webflow:listener ref="jpaFlowExecutionListener" />
</webflow:flow-execution-listeners>
</webflow:flow-executor>
<bean id="jpaFlowExecutionListener"
<bean id="jpaFlowExecutionListener"
class="org.springframework.webflow.persistence.JpaFlowExecutionListener">
<constructor-arg ref="entityManagerFactory" />
<constructor-arg ref="transactionManager" />
@@ -67,7 +71,7 @@
<para>
<programlisting language="xml"><![CDATA[
<end-state id="bookingConfirmed" commit="true" />
]]></programlisting>
]]></programlisting>
</para>
<para>
That is it. When your flow starts, the listener will handle allocating a new <code>EntityManager</code> in <code>flowScope</code>.
@@ -76,13 +80,13 @@
Such data access operations should always execute non transactionally or in read-only transactions to maintain isolation of intermediate edits.
</para>
</sect1>
<sect1 id="flow-managed-persistence-propagation">
<sect1 xml:id="flow-managed-persistence-propagation">
<title>Flow Managed Persistence And Sub-Flows</title>
<para>
A flow managed <code>PersistenceContext</code> is automatically extended
(propagated) to subflows assuming the subflow also has the <code>&lt;perstistence-context/&gt;</code>
variable. When a subflow re-uses the <code>PersistenceContext</code> started by its parent it ignores
commit flags when an end state is reached thereby deferring the final decision (to commit or not) to
variable. When a subflow re-uses the <code>PersistenceContext</code> started by its parent it ignores
commit flags when an end state is reached thereby deferring the final decision (to commit or not) to
its parent.
</para>
</sect1>

54
src/reference/flow-security.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="flow-security">
<chapter xml:id="flow-security"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Securing Flows</title>
<sect1 id="flow-security-introduction">
<sect1 xml:id="flow-security-introduction">
<title>Introduction</title>
<para>
Security is an important concept for any application.
@@ -14,7 +18,7 @@
This section will focus on securing flow execution.
</para>
</sect1>
<sect1 id="flow-security-how-to">
<sect1 xml:id="flow-security-how-to">
<title>How do I secure a flow?</title>
<para>
Securing flow execution is a three step process:
@@ -28,7 +32,7 @@
Each of these steps must be completed or else flow security rules will not be applied.
</para>
</sect1>
<sect1 id="flow-security-secured-element">
<sect1 xml:id="flow-security-secured-element">
<title>The secured element</title>
<para>
The secured element designates that its containing element should apply the authorization check before fully entering.
@@ -39,14 +43,14 @@
In each case the syntax for the secured element is identical.
The secured element is located inside the element it is securing.
For example, to secure a state the secured element occurs directly inside that state:
</para>
</para>
<programlisting language="xml"><![CDATA[
<view-state id="secured-view">
<secured attributes="ROLE_USER" />
...
</view-state>]]>
</programlisting>
<sect2 id="flow-security-secured-element-attributes">
<sect2 xml:id="flow-security-secured-element-attributes">
<title>Security attributes</title>
<para>
The <code>attributes</code> attribute is a comma separated list of Spring Security authorization attributes.
@@ -61,7 +65,7 @@
This will need to be overridden if your application is not using authorization roles.
</para>
</sect2>
<sect2 id="flow-security-secured-element-match">
<sect2 xml:id="flow-security-secured-element-match">
<title>Matching type</title>
<para>
There are two types of matching available: <code>any</code> and <code>all</code>.
@@ -80,7 +84,7 @@
</para>
</sect2>
</sect1>
<sect1 id="flow-security-listener">
<sect1 xml:id="flow-security-listener">
<title>The SecurityFlowExecutionListener</title>
<para>
Defining security rules in the flow by themselves will not protect the flow execution.
@@ -93,7 +97,7 @@
</webflow:flow-execution-listeners>
</webflow:flow-executor>
<bean id="securityFlowExecutionListener"
<bean id="securityFlowExecutionListener"
class="org.springframework.webflow.security.SecurityFlowExecutionListener" />
]]></programlisting>
<para>
@@ -101,12 +105,12 @@
This exception will later be caught by Spring Security and used to prompt the user to authenticate.
It is important that this exception be allowed to travel up the execution stack uninhibited, otherwise the end user may not be prompted to authenticate.
</para>
<sect2 id="flow-security-listener-adm">
<sect2 xml:id="flow-security-listener-adm">
<title>Custom Access Decision Managers</title>
<para>
If your application is using authorities that are not role based, you will need to configure a custom <code>AccessDecisionManager</code>.
You can override the default decision manager by setting the <code>accessDecisionManager</code> property on the security listener.
Please consult the <ulink url="http://static.springframework.org/spring-security/site/reference.html">Spring Security reference documentation</ulink> to learn more about decision managers.
Please consult the <link xl:href="http://static.springframework.org/spring-security/site/reference.html">Spring Security reference documentation</link> to learn more about decision managers.
</para>
<programlisting language="xml"><![CDATA[
<bean id="securityFlowExecutionListener"
@@ -116,17 +120,17 @@
]]></programlisting>
</sect2>
</sect1>
<sect1 id="flow-security-configuration">
<sect1 xml:id="flow-security-configuration">
<title>Configuring Spring Security</title>
<para>
Spring Security has robust configuration options available.
As every application and environment has its own security requirements, the <ulink url="http://static.springframework.org/spring-security/site/reference.html">Spring Security reference documentation</ulink> is the best place to learn the available options.
As every application and environment has its own security requirements, the <link xl:href="http://static.springframework.org/spring-security/site/reference.html">Spring Security reference documentation</link> is the best place to learn the available options.
</para>
<para>
Both the <code>booking-faces</code> and <code>booking-mvc</code> sample applications are configured to use Spring Security.
Configuration is needed at both the Spring and web.xml levels.
</para>
<sect2 id="flow-security-configuration-spring">
<sect2 xml:id="flow-security-configuration-spring">
<title>Spring configuration</title>
<para>
The Spring configuration defines <code>http</code> specifics (such as protected URLs and login/logout mechanics) and the <code>authentication-provider</code>.
@@ -134,29 +138,29 @@
</para>
<programlisting language="xml"><![CDATA[
<security:http auto-config="true">
<security:form-login login-page="/spring/login"
<security:form-login login-page="/spring/login"
login-processing-url="/spring/loginProcess"
default-target-url="/spring/main"
authentication-failure-url="/spring/login?login_error=1" />
default-target-url="/spring/main"
authentication-failure-url="/spring/login?login_error=1" />
<security:logout logout-url="/spring/logout" logout-success-url="/spring/logout-success" />
</security:http>
<security:authentication-provider>
<security:password-encoder hash="md5" />
<security:user-service>
<security:user name="keith" password="417c7382b16c395bc25b5da1398cf076"
<security:user name="keith" password="417c7382b16c395bc25b5da1398cf076"
authorities="ROLE_USER,ROLE_SUPERVISOR" />
<security:user name="erwin" password="12430911a8af075c6f41c6976af22b09"
<security:user name="erwin" password="12430911a8af075c6f41c6976af22b09"
authorities="ROLE_USER,ROLE_SUPERVISOR" />
<security:user name="jeremy" password="57c6cbff0d421449be820763f03139eb"
<security:user name="jeremy" password="57c6cbff0d421449be820763f03139eb"
authorities="ROLE_USER" />
<security:user name="scott" password="942f2339bf50796de535a384f0d1af3e"
<security:user name="scott" password="942f2339bf50796de535a384f0d1af3e"
authorities="ROLE_USER" />
</security:user-service>
</security:authentication-provider>]]>
</programlisting>
</sect2>
<sect2 id="flow-security-configuration-web">
<sect2 xml:id="flow-security-configuration-web">
<title>web.xml Configuration</title>
<para>
In the <code>web.xml</code> file, a <code>filter</code> is defined to intercept all requests.

63
src/reference/index.xml
View File

@@ -1,9 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:id="spring-webflow-reference"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<bookinfo>
<book xml:id="spring-framework-reference"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<info>
<title>Spring Web Flow Reference Guide</title>
<titleabbrev>Spring Web Flow</titleabbrev>
<productname>Spring Web Flow</productname>
@@ -11,28 +16,40 @@
<pubdate></pubdate>
<authorgroup>
<author>
<firstname>Keith</firstname>
<surname>Donald</surname>
<personname>
<firstname>Keith</firstname>
<surname>Donald</surname>
</personname>
</author>
<author>
<firstname>Erwin</firstname>
<surname>Vervaet</surname>
<personname>
<firstname>Erwin</firstname>
<surname>Vervaet</surname>
</personname>
</author>
<author>
<firstname>Jeremy</firstname>
<surname>Grelle</surname>
<personname>
<firstname>Jeremy</firstname>
<surname>Grelle</surname>
</personname>
</author>
<author>
<firstname>Scott</firstname>
<surname>Andrews</surname>
<personname>
<firstname>Scott</firstname>
<surname>Andrews</surname>
</personname>
</author>
<author>
<firstname>Rossen</firstname>
<surname>Stoyanchev</surname>
<personname>
<firstname>Rossen</firstname>
<surname>Stoyanchev</surname>
</personname>
</author>
<author>
<firstname>Phillip</firstname>
<surname>Webb</surname>
<personname>
<firstname>Phillip</firstname>
<surname>Webb</surname>
</personname>
</author>
</authorgroup>
<legalnotice>
@@ -44,11 +61,11 @@
or electronically.
</para>
</legalnotice>
</bookinfo>
</info>
<toc />
<preface id="preface">
<preface xml:id="preface">
<title>Preface</title>
<para>
Many web applications require the same sequence of steps to execute in different contexts.
@@ -65,7 +82,7 @@
This reference guide shows you how to use and extend Spring Web Flow.
</para>
</preface>
<xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="whatsnew.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="defining-flows.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -83,5 +100,5 @@
<xi:include href="testing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="upgrade-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="flow-definition-field-mappings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

50
src/reference/overview.xml
View File

@@ -1,10 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="introduction">
<chapter xml:id="introduction"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Introduction</title>
<sect1 id="manual-overview">
<sect1 xml:id="manual-overview">
<title>What this guide covers</title>
<para>
This guide covers all aspects of Spring Web Flow.
@@ -12,7 +16,7 @@
It also covers extending the framework and the overall architectural model.
</para>
</sect1>
<sect1 id="system-requirements">
<sect1 xml:id="system-requirements">
<title>What Web Flow requires to run</title>
<para>
Java 1.5 or higher
@@ -21,34 +25,34 @@
Spring 3.1 or higher
</para>
</sect1>
<sect1 id="support">
<sect1 xml:id="support">
<title>Where to get support</title>
<para>
Professional from-the-source support on Spring Web Flow is available from
<ulink url="http://www.springsource.com">SpringSource</ulink>, the company behind Spring, and
<ulink url="http://www.ervacon.com">Ervacon</ulink>, operated by Web Flow project co-founder Erwin Vervaet
<link xl:href="http://www.springsource.com">SpringSource</link>, the company behind Spring, and
<link xl:href="http://www.ervacon.com">Ervacon</link>, operated by Web Flow project co-founder Erwin Vervaet
</para>
</sect1>
<sect1 id="development">
<sect1 xml:id="development">
<title>Where to follow development</title>
<para>
You can help make Web Flow best serve the needs of the Spring community by interacting with developers
at the <ulink url="http://forum.springframework.org">Spring Community Forums</ulink>.
You can help make Web Flow best serve the needs of the Spring community by interacting with developers
at the <link xl:href="http://forum.springframework.org">Spring Community Forums</link>.
</para>
<para>
Report bugs and influence the Web Flow project roadmap using the <ulink url="http://jira.springframework.org">Spring Issue Tracker</ulink>.
Report bugs and influence the Web Flow project roadmap using the <link xl:href="http://jira.springframework.org">Spring Issue Tracker</link>.
</para>
<para>
Subscribe to the <ulink url="http://www.springframework.org">Spring Community Portal</ulink> for the latest Spring news and announcements.
Subscribe to the <link xl:href="http://www.springframework.org">Spring Community Portal</link> for the latest Spring news and announcements.
</para>
<para>
Visit the <ulink url="http://www.springframework.org/webflow">Web Flow Project Home</ulink> for more resources on the project.
Visit the <link xl:href="http://www.springframework.org/webflow">Web Flow Project Home</link> for more resources on the project.
</para>
</sect1>
<sect1 id="jars-mvn-central">
<sect1 xml:id="jars-mvn-central">
<title>How to access Web Flow artifacts from Maven Central</title>
<para>
Each jar in the Web Flow distribution is available in the <ulink url="http://search.maven.org">Maven Central Repository</ulink>.
Each jar in the Web Flow distribution is available in the <link xl:href="http://search.maven.org">Maven Central Repository</link>.
This allows you to easily integrate Web Flow into your application if you are already using Maven as the build system for your web development project.
</para>
<para>
@@ -70,11 +74,11 @@
<groupId>org.springframework.webflow</groupId>
<artifactId>spring-faces</artifactId>
<version>x.y.z.RELEASE</version>
</dependency>
</dependency>
]]>
</programlisting>
</sect1>
<sect1 id="jars-ivy">
<sect1 xml:id="jars-ivy">
<title>How to access Web Flow artifacts with Ivy</title>
<para>
To access Spring Web Flow jars with Ivy, add the following repositories to your Ivy config:
@@ -133,7 +137,7 @@
<para>
For milestones and snapshots you'll need to use the SpringSource repository.
Add the following repository to your Maven pom.xml:
</para>
</para>
<programlisting language="xml"><![CDATA[
<repository>
<id>springsource-repository</id>
@@ -142,20 +146,20 @@
</repository>]]>
</programlisting>
<para>
Then declare the following dependencies:
Then declare the following dependencies:
</para>
<programlisting language="xml"><![CDATA[
<dependency>
<groupId>org.springframework.webflow</groupId>
<artifactId>spring-binding</artifactId>
<version>x.y.z.BUILD-SNAPSHOT</version>
</dependency>
</dependency>
<dependency>
<groupId>org.springframework.webflow</groupId>
<artifactId>spring-js</artifactId>
<version>x.y.z.BUILD-SNAPSHOT</version>
</dependency>
</dependency>
<dependency>
<groupId>org.springframework.webflow</groupId>

80
src/reference/portlet.xml
View File

@@ -1,23 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="portlet">
<chapter xml:id="portlet"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Portlet Integration</title>
<sect1 id="portlet-introduction">
<sect1 xml:id="portlet-introduction">
<title>Introduction</title>
<para>
This chapter shows how to use Web Flow in a Portlet environment.
Spring Web Flow requires Portlet API 2.0 to run with.
Spring Web Flow requires Portlet API 2.0 to run with.
The <code>booking-portlet-mvc</code> sample application is a good reference for using Web Flow within a portlet.
This application is a simplified travel site that allows users to search for and book hotel rooms.
</para>
</sect1>
<sect1 id="portlet-config-core">
<sect1 xml:id="portlet-config-core">
<title>Configuring web.xml and portlet.xml</title>
<para>
The configuration for a portlet depends on the portlet container used.
The sample applications, included with Web Flow, are both configured to use <ulink url="http://portals.apache.org/pluto/">Apache Pluto</ulink>.
The sample applications, included with Web Flow, are both configured to use <link xl:href="http://portals.apache.org/pluto/">Apache Pluto</link>.
</para>
<para>
In general, the configuration requires adding a servlet mapping in the <code>web.xml</code> file to dispatch request to the portlet container.
@@ -41,7 +45,7 @@
<para>
The <code>portlet.xml</code> configuration is a standard portlet configuration.
The <code>portlet-class</code> needs to be set along with a pair of <code>init-param</code>s.
Setting the <code>expiration-cache</code> to <code>0</code> is recommended to force Web Flow to always render a fresh view.
Setting the <code>expiration-cache</code> to <code>0</code> is recommended to force Web Flow to always render a fresh view.
</para>
<programlisting language="xml"><![CDATA[
<portlet>
@@ -60,9 +64,9 @@
</portlet>
]]></programlisting>
</sect1>
<sect1 id="portlet-config-spring">
<sect1 xml:id="portlet-config-spring">
<title>Configuring Spring</title>
<sect2 id="portlet-config-spring-handler">
<sect2 xml:id="portlet-config-spring-handler">
<title>Flow Handlers</title>
<para>
The only supported mechanism for bridging a portlet request to Web Flow is a <code>FlowHandler</code>.
@@ -99,19 +103,19 @@ public class ViewFlowHandler extends AbstractFlowHandler {
}
]]></programlisting>
</sect2>
<sect2 id="portlet-config-spring-mappings">
<sect2 xml:id="portlet-config-spring-mappings">
<title>Handler Mappings</title>
<para>
Spring Portlet MVC provides a rich set of methods to map portlet requests.
Complete documentation is available in the <ulink url="http://static.springframework.org/spring/docs/current/reference/portlet.html#portlet-handlermapping">Spring Reference Documentation</ulink>.
Complete documentation is available in the <link xl:href="http://static.springframework.org/spring/docs/current/reference/portlet.html#portlet-handlermapping">Spring Reference Documentation</link>.
</para>
<para>
The <code>booking-portlet-mvc</code> sample application uses a <code>PortletModeHandlerMapping</code> to map portlet requests.
The sample application only supports <code>view</code> mode, but support for other portlet modes is available.
Other modes can be added and point to the same flow as <code>view</code> mode, or any other flow.
Other modes can be added and point to the same flow as <code>view</code> mode, or any other flow.
</para>
<programlisting language="xml"><![CDATA[
<bean id="portletModeHandlerMapping"
<bean id="portletModeHandlerMapping"
class="org.springframework.web.portlet.handler.PortletModeHandlerMapping">
<property name="portletModeMap">
<map>
@@ -123,21 +127,21 @@ public class ViewFlowHandler extends AbstractFlowHandler {
</bean>
]]></programlisting>
</sect2>
<sect2 id="portlet-config-spring-handler-adapter">
<sect2 xml:id="portlet-config-spring-handler-adapter">
<title>Flow Handler Adapter</title>
<para>
A <code>FlowHandlerAdapter</code> converts the handler mappings to the flow handlers.
The flow executor is required as a constructor argument.
</para>
<programlisting language="xml"><![CDATA[
<bean id="flowHandlerAdapter"
<bean id="flowHandlerAdapter"
class="org.springframework.webflow.mvc.portlet.FlowHandlerAdapter">
<property name="flowExecutor" ref="flowExecutor" />
</bean>
]]></programlisting>
</sect2>
</sect1>
<sect1 id="portlet-views">
<sect1 xml:id="portlet-views">
<title>Portlet Views</title>
<para>
In order to facilitate view rendering, a <code>ViewRendererServlet</code> must be added to the <code>web.xml</code> file.
@@ -155,9 +159,9 @@ public class ViewFlowHandler extends AbstractFlowHandler {
</servlet-mapping>
]]></programlisting>
</sect1>
<sect1 id="portlet-modes">
<sect1 xml:id="portlet-modes">
<title>Portlet Modes and Window States</title>
<sect2 id="portlet-modes-state">
<sect2 xml:id="portlet-modes-state">
<title>Window State</title>
<para>
The Portlet API defined three window states: normal, minimized and maximized.
@@ -171,7 +175,7 @@ requestContext.getExternalContext().getRequestMap().get("portletWindowState");
externalContext.requestMap.portletWindowState
]]></programlisting>
</sect2>
<sect2 id="portlet-modes-mode">
<sect2 xml:id="portlet-modes-mode">
<title>Portlet Mode</title>
<para>
The Portlet API defined three portlet modes: view, edit and help.
@@ -186,40 +190,40 @@ externalContext.requestMap.portletMode
]]></programlisting>
</sect2>
</sect1>
<sect1 id="portlet-jsf">
<sect1 xml:id="portlet-jsf">
<title>Using Portlets with JSF</title>
<sect2 id="portlet-jsf-using-portlet-jsf">
<sect2 xml:id="portlet-jsf-using-portlet-jsf">
<para>
Prior to version 2.1 of Spring Web Flow, support for JSF Portlets was considered
experimental and relied on a Portlet Bridge for JSF implementation.
Furthermore JSR-329 (the latest specification in this area), which targets
Prior to version 2.1 of Spring Web Flow, support for JSF Portlets was considered
experimental and relied on a Portlet Bridge for JSF implementation.
Furthermore JSR-329 (the latest specification in this area), which targets
Portlet API 2.0 and JSF 1.2 environments at the time of writing is not yet
final causing portlet bridge implementations to also remain incomplete.
</para>
<para>
A closer comparison of Spring Web Flow and a Portlet Bridge for JSF shows
the two have significant overlap. They both drive the
the two have significant overlap. They both drive the
JSF lifecycle and they both shield JSF from knowledge about Portlet action
and render requests.
and render requests.
</para>
<para>
Considering all of the above, starting with version 2.2, Spring Web Flow
Considering all of the above, starting with version 2.2, Spring Web Flow
provides support for JSF Portlets using its own internal Portlet integration rather
than a Portlet Bridge for JSF. We believe this will provide value for Web Flow users
by reducing the number of dependencies in what is already a fairly complex
combination of technologies with specifications lagging behind.
</para>
<para>
What this practically means is the configuration required for JSF Portlets is
What this practically means is the configuration required for JSF Portlets is
very similar to what is alread documented in the rest of this chapter
with the exception of <xref linkend="portlet-views"/>, which is not necessary
with the exception of <xref linkend="portlet-views"/>, which is not necessary
with JSF.
</para>
<para>
Review the <code>swf-booking-portlet-faces</code> sample in the Web Flow distribution
for a working JSF Portlets example with complete configuration details. The main
things to ensure are that the <code>&lt;faces:resources&gt;</code> elements is
included as part of your Spring configuration and that your
included as part of your Spring configuration and that your
<code>faces-config.xml</code> configuration includes a <code>PortletViewHandler</code>:
</para>
@@ -232,27 +236,27 @@ externalContext.requestMap.portletMode
<application>
<view-handler>
org.springframework.faces.webflow.context.portlet.PortletViewHandler
</view-handler>
</view-handler>
</application>
</faces-config>
]]></programlisting>
<para>
The JSF Portlet support provided with Spring Web Flow requires JSF v2.0 or above. If
you are upgrading from a previous release you should ensure that your <code>faces-config.xml</code>
you are upgrading from a previous release you should ensure that your <code>faces-config.xml</code>
references <code>org.springframework.faces.webflow.context.portlet.PortletViewHandler</code> instead
of <code>org.springframework.faces.webflow.application.portlet.PortletFaceletViewHandler</code>. You
should also ensure that you have added <code>&lt;faces:resources&gt;</code> to you Spring configuration.
</para>
<para>
Although JSF v2.0 is a minimum requirement, this has been primarily driven to provide better support in
a Servlet environment. Many of the more advanced JSF 2.0 features (for example 'Partial State Saving')
a Servlet environment. Many of the more advanced JSF 2.0 features (for example 'Partial State Saving')
are not supported by Spring Web Flow in a Portlet environment.
</para>
</sect2>
</sect1>
<sect1 id="portlet-issues">
<sect1 xml:id="portlet-issues">
<title>Issues in a Portlet Environment</title>
<sect2 id="portlet-issues-redirects">
<sect2 xml:id="portlet-issues-redirects">
<title>Redirects</title>
<para>
The Portlet API only allows redirects to be requested from an action request.
@@ -267,7 +271,7 @@ externalContext.requestMap.portletMode
This callback provides the <code>ActionResponse</code> object which supports redirects.
</para>
</sect2>
<sect2 id="portlet-issues-modes">
<sect2 xml:id="portlet-issues-modes">
<title>Switching Portlet Modes</title>
<para>
The portlet container passes the execution key from the previous flow when switching to a new mode.

1162
src/reference/spring-faces.xml
View File

File diff suppressed because it is too large Load Diff

454
src/reference/spring-js.xml
View File

@@ -1,50 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="spring-js">
<title>Spring JavaScript Quick Reference</title>
<sect1 id="spring-js-introduction">
<title>Introduction</title>
<para>
Spring Javascript (spring-js) is a lightweight abstraction over common JavaScript toolkits such as Dojo.
It aims to provide a common client-side programming model for progressively enhancing a web page with rich widget behavior and Ajax remoting.
</para>
<para>
Use of the Spring JS API is demonstrated in the the Spring MVC + Web Flow version of the Spring Travel reference application.
</para>
</sect1>
<sect1 id="spring-js-resource-servlet">
<chapter xml:id="spring-js"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Spring JavaScript Quick Reference</title>
<sect1 xml:id="spring-js-introduction">
<title>Introduction</title>
<para>
Spring Javascript (spring-js) is a lightweight abstraction over common JavaScript toolkits such as Dojo.
It aims to provide a common client-side programming model for progressively enhancing a web page with rich widget behavior and Ajax remoting.
</para>
<para>
Use of the Spring JS API is demonstrated in the the Spring MVC + Web Flow version of the Spring Travel reference application.
</para>
</sect1>
<sect1 xml:id="spring-js-resource-servlet">
<title>Serving Javascript Resources</title>
<para>
Spring JS provides a generic <code>ResourceServlet</code> to serve web resources such as JavaScript and CSS files from jar files,
as well as the webapp root directory.
This servlet provides a convenient way to serve Spring.js files to your pages.
To deploy this servlet, declare the following in <code>web.xml</code>:
</para>
<programlisting language="xml"><![CDATA[
Spring JS provides a generic <code>ResourceServlet</code> to serve web resources such as JavaScript and CSS files from jar files,
as well as the webapp root directory.
This servlet provides a convenient way to serve Spring.js files to your pages.
To deploy this servlet, declare the following in <code>web.xml</code>:
</para>
<programlisting language="xml"><![CDATA[
<!-- Serves static resource content from .jar files such as spring-js.jar -->
<servlet>
<servlet-name>Resource Servlet</servlet-name>
<servlet-class>org.springframework.js.resource.ResourceServlet</servlet-class>
<servlet-name>Resource Servlet</servlet-name>
<servlet-class>org.springframework.js.resource.ResourceServlet</servlet-class>
</servlet>
<!-- Map all /resources requests to the Resource Servlet for handling -->
<servlet-mapping>
<servlet-name>Resource Servlet</servlet-name>
<url-pattern>/resources/*</url-pattern>
<servlet-name>Resource Servlet</servlet-name>
<url-pattern>/resources/*</url-pattern>
</servlet-mapping>]]>
</programlisting>
<para>
</programlisting>
<para>
Note that starting with version 3.0.4, the Spring Framework includes
a replacement for the <code>ResourceServlet</code> (see the
<ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html#mvc-static-resources">Spring Framework documentation</ulink>).
With the new &lt;mvc:resources&gt; element resource requests (.js, .css) are handled by the
<code>DispatcherSevlet</code> without the need for a separate <code>ResourceServlet</code>.
Here is the relevant portion of the Spring MVC configuration in
the mvc-booking sample:
</para>
<programlisting language="xml"><![CDATA[
a replacement for the <code>ResourceServlet</code> (see the
<link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html#mvc-static-resources">Spring Framework documentation</link>).
With the new &lt;mvc:resources&gt; element resource requests (.js, .css) are handled by the
<code>DispatcherSevlet</code> without the need for a separate <code>ResourceServlet</code>.
Here is the relevant portion of the Spring MVC configuration in
the mvc-booking sample:
</para>
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -57,21 +61,21 @@
<mvc:resources mapping="/resources/**" location="/, classpath:/META-INF/web-resources/" />
...
</beans>
</beans>
]]>
</programlisting>
<para>
This incoming maps requests for <code>/resources</code> to resources found under
<code>/META-INF/web-resources</code> on the classpath. That's where Spring JavaScript resources
are bundled. However, you can modify the location attribute in the above configuration in order
to serve resources from any classpath or web application relative location.
</para>
<para>
Note that the full resource URL depends on how your DispatcherServlet is mapped.
In the mvc-booking sample we've chosen to map it with the default servlet mapping '/':
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
This incoming maps requests for <code>/resources</code> to resources found under
<code>/META-INF/web-resources</code> on the classpath. That's where Spring JavaScript resources
are bundled. However, you can modify the location attribute in the above configuration in order
to serve resources from any classpath or web application relative location.
</para>
<para>
Note that the full resource URL depends on how your DispatcherServlet is mapped.
In the mvc-booking sample we've chosen to map it with the default servlet mapping '/':
</para>
<programlisting language="xml"><![CDATA[
<servlet>
<servlet-name>Spring MVC Dispatcher Servlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
@@ -82,18 +86,18 @@
<url-pattern>/</url-pattern>
</servlet-mapping>
]]>
</programlisting>
</programlisting>
<para>
That means the full URL to load <code>Spring.js</code> is <code>/myapp/resources/spring/Spring.js</code>.
If your <code>DispatcherServlet</code> was instead mapped to <code>/main/*</code> then the full
URL would be <code>/myapp/main/resources/spring/Spring.js</code>.
</para>
<para>
When using of the default servlet mapping it is also recommended to add this to your Spring MVC
configuration, which ensures that any resource requests not handled by your Spring MVC mappings
will be delegated back to the Servlet container.
</para>
<programlisting language="xml"><![CDATA[
</para>
<para>
When using of the default servlet mapping it is also recommended to add this to your Spring MVC
configuration, which ensures that any resource requests not handled by your Spring MVC mappings
will be delegated back to the Servlet container.
</para>
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -104,201 +108,201 @@
...
<mvc:default-servlet-handler />
</beans>
</beans>
]]>
</programlisting>
</sect1>
<sect1 id="spring-js-includes">
<title>Including Spring Javascript in a Page</title>
<para>
Spring JS is designed such that an implementation of its API can be built for any of the popular Javascript toolkits.
The initial implementation of Spring.js builds on the Dojo toolkit.
</para>
<para>
Using Spring Javascript in a page requires including the underlying toolkit as normal,
the <code>Spring.js</code> base interface file, and the <code>Spring-(library implementation).js</code> file for the underlying toolkit.
As an example, the following includes obtain the Dojo implementation of Spring.js using the <code>ResourceServlet</code>:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
</sect1>
<sect1 xml:id="spring-js-includes">
<title>Including Spring Javascript in a Page</title>
<para>
Spring JS is designed such that an implementation of its API can be built for any of the popular Javascript toolkits.
The initial implementation of Spring.js builds on the Dojo toolkit.
</para>
<para>
Using Spring Javascript in a page requires including the underlying toolkit as normal,
the <code>Spring.js</code> base interface file, and the <code>Spring-(library implementation).js</code> file for the underlying toolkit.
As an example, the following includes obtain the Dojo implementation of Spring.js using the <code>ResourceServlet</code>:
</para>
<programlisting language="xml"><![CDATA[
<script type="text/javascript" src="<c:url value="/resources/dojo/dojo.js" />"> </script>
<script type="text/javascript" src="<c:url value="/resources/spring/Spring.js" />"> </script>
<script type="text/javascript" src="<c:url value="/resources/spring/Spring-Dojo.js" />"> </script>]]>
</programlisting>
<para>
When using the widget system of an underlying library, typically you must also include some CSS resources to obtain the desired look and feel.
For the booking-mvc reference application, Dojo's <code>tundra.css</code> is included:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
When using the widget system of an underlying library, typically you must also include some CSS resources to obtain the desired look and feel.
For the booking-mvc reference application, Dojo's <code>tundra.css</code> is included:
</para>
<programlisting language="xml"><![CDATA[
<link type="text/css" rel="stylesheet" href="<c:url value="/resources/dijit/themes/tundra/tundra.css" />" />]]>
</programlisting>
</sect1>
<sect1 id="spring-js-decorations">
<title>Spring Javascript Decorations</title>
<para>
A central concept in Spring Javascript is the notion of applying decorations to existing DOM nodes.
This technique is used to progressively enhance a web page such that the page will still be functional in a less capable browser.
The <code>addDecoration</code> method is used to apply decorations.
</para>
<para>
The following example illustrates enhancing a Spring MVC <code>&lt;form:input&gt;</code> tag with rich suggestion behavior:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
</sect1>
<sect1 xml:id="spring-js-decorations">
<title>Spring Javascript Decorations</title>
<para>
A central concept in Spring Javascript is the notion of applying decorations to existing DOM nodes.
This technique is used to progressively enhance a web page such that the page will still be functional in a less capable browser.
The <code>addDecoration</code> method is used to apply decorations.
</para>
<para>
The following example illustrates enhancing a Spring MVC <code>&lt;form:input&gt;</code> tag with rich suggestion behavior:
</para>
<programlisting language="xml"><![CDATA[
<form:input id="searchString" path="searchString"/>
<script type="text/javascript">
Spring.addDecoration(new Spring.ElementDecoration({
elementId: "searchString",
widgetType: "dijit.form.ValidationTextBox",
widgetAttrs: { promptMessage : "Search hotels by name, address, city, or zip." }}));
Spring.addDecoration(new Spring.ElementDecoration({
elementId: "searchString",
widgetType: "dijit.form.ValidationTextBox",
widgetAttrs: { promptMessage : "Search hotels by name, address, city, or zip." }}));
</script>]]>
</programlisting>
<para>
The <code>ElementDecoration</code> is used to apply rich widget behavior to an existing DOM node.
This decoration type does not aim to completely hide the underlying toolkit, so the toolkit's native widget type and attributes are used directly.
This approach allows you to use a common decoration model to integrate any widget from the underlying toolkit in a consistent manner.
See the <code>booking-mvc</code> reference application for more examples of applying decorations to do things from suggestions to client-side validation.
</para>
<para>
When using the <code>ElementDecoration</code> to apply widgets that have rich validation behavior, a common need is to prevent the form from being submitted to the server until validation passes.
This can be done with the <code>ValidateAllDecoration</code>:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
The <code>ElementDecoration</code> is used to apply rich widget behavior to an existing DOM node.
This decoration type does not aim to completely hide the underlying toolkit, so the toolkit's native widget type and attributes are used directly.
This approach allows you to use a common decoration model to integrate any widget from the underlying toolkit in a consistent manner.
See the <code>booking-mvc</code> reference application for more examples of applying decorations to do things from suggestions to client-side validation.
</para>
<para>
When using the <code>ElementDecoration</code> to apply widgets that have rich validation behavior, a common need is to prevent the form from being submitted to the server until validation passes.
This can be done with the <code>ValidateAllDecoration</code>:
</para>
<programlisting language="xml"><![CDATA[
<input type="submit" id="proceed" name="_eventId_proceed" value="Proceed" />
<script type="text/javascript">
Spring.addDecoration(new Spring.ValidateAllDecoration({ elementId:'proceed', event:'onclick' }));
Spring.addDecoration(new Spring.ValidateAllDecoration({ elementId:'proceed', event:'onclick' }));
</script>]]>
</programlisting>
<para>
This decorates the "Proceed" button with a special onclick event handler that fires the client side validators and does not allow the form to submit until they pass successfully.
</para>
<para>
An <code>AjaxEventDecoration</code> applies a client-side event listener that fires a remote Ajax request to the server. It also auto-registers a callback function to link in the response:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
This decorates the "Proceed" button with a special onclick event handler that fires the client side validators and does not allow the form to submit until they pass successfully.
</para>
<para>
An <code>AjaxEventDecoration</code> applies a client-side event listener that fires a remote Ajax request to the server. It also auto-registers a callback function to link in the response:
</para>
<programlisting language="xml"><![CDATA[
<a id="prevLink" href="search?searchString=${criteria.searchString}&page=${criteria.page - 1}">Previous</a>
<script type="text/javascript">
Spring.addDecoration(new Spring.AjaxEventDecoration({
elementId: "prevLink",
event: "onclick",
params: { fragments: "body" }
}));
Spring.addDecoration(new Spring.AjaxEventDecoration({
elementId: "prevLink",
event: "onclick",
params: { fragments: "body" }
}));
</script>]]>
</programlisting>
<para>
This decorates the onclick event of the "Previous Results" link with an Ajax call, passing along a special parameter that specifies the fragment to be re-rendered in the response.
Note that this link would still be fully functional if Javascript was unavailable in the client.
(See <xref linkend="spring-js-ajax"/> for details on how this request is handled on the server.)
</para>
<para>
It is also possible to apply more than one decoration to an element.
The following example shows a button being decorated with Ajax and validate-all submit suppression:
</para>
<programlisting language="xml"><![CDATA[
<input type="submit" id="proceed" name="_eventId_proceed" value="Proceed" />
</programlisting>
<para>
This decorates the onclick event of the "Previous Results" link with an Ajax call, passing along a special parameter that specifies the fragment to be re-rendered in the response.
Note that this link would still be fully functional if Javascript was unavailable in the client.
(See <xref linkend="spring-js-ajax"/> for details on how this request is handled on the server.)
</para>
<para>
It is also possible to apply more than one decoration to an element.
The following example shows a button being decorated with Ajax and validate-all submit suppression:
</para>
<programlisting language="xml"><![CDATA[
<input type="submit" id="proceed" name="_eventId_proceed" value="Proceed" />
<script type="text/javascript">
Spring.addDecoration(new Spring.ValidateAllDecoration({elementId:'proceed', event:'onclick'}));
Spring.addDecoration(new Spring.AjaxEventDecoration({elementId:'proceed', event:'onclick',formId:'booking', params:{fragments:'messages'}}));
Spring.addDecoration(new Spring.ValidateAllDecoration({elementId:'proceed', event:'onclick'}));
Spring.addDecoration(new Spring.AjaxEventDecoration({elementId:'proceed', event:'onclick',formId:'booking', params:{fragments:'messages'}}));
</script>]]>
</programlisting>
<para>
It is also possible to apply a decoration to multiple elements in a single statement using Dojo's query API.
The following example decorates a set of checkbox elements as Dojo Checkbox widgets:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
It is also possible to apply a decoration to multiple elements in a single statement using Dojo's query API.
The following example decorates a set of checkbox elements as Dojo Checkbox widgets:
</para>
<programlisting language="xml"><![CDATA[
<div id="amenities">
<form:checkbox path="amenities" value="OCEAN_VIEW" label="Ocean View" /></li>
<form:checkbox path="amenities" value="LATE_CHECKOUT" label="Late Checkout" /></li>
<form:checkbox path="amenities" value="MINIBAR" label="Minibar" /></li>
<script type="text/javascript">
dojo.query("#amenities input[type='checkbox']").forEach(function(element) {
Spring.addDecoration(new Spring.ElementDecoration({
elementId: element.id,
widgetType : "dijit.form.CheckBox",
widgetAttrs : { checked : element.checked }
}));
});
dojo.query("#amenities input[type='checkbox']").forEach(function(element) {
Spring.addDecoration(new Spring.ElementDecoration({
elementId: element.id,
widgetType : "dijit.form.CheckBox",
widgetAttrs : { checked : element.checked }
}));
});
</script>
</div>]]>
</programlisting>
</sect1>
<sect1 id="spring-js-ajax">
<title>Handling Ajax Requests</title>
<para>
Spring Javascript's client-side Ajax response handling is built upon the notion of receiving "fragments" back from the server.
These fragments are just standard HTML that is meant to replace portions of the existing page.
The key piece needed on the server is a way to determine which pieces of a full response need to be pulled out for partial rendering.
</para>
<para>
In order to be able to render partial fragments of a full response, the full response must be built using a
templating technology that allows the use of composition for constructing the response, and for the member
parts of the composition to be referenced and rendered individually.
Spring Javascript provides some simple Spring MVC extensions that make use of Tiles to achieve this.
The same technique could theoretically be used with any templating system supporting composition.
</para>
<para>
Spring Javascript's Ajax remoting functionality is built upon the notion that the core handling code for an
Ajax request should not differ from a standard browser request, thus no special knowledge of an Ajax request
is needed directly in the code and the same hanlder can be used for both styles of request.
</para>
<sect2 id="custom-ajax-handler">
<title>Providing a Library-Specific AjaxHandler</title>
<para>
The key interface for integrating various Ajax libraries with the Ajax-aware behavior of Web Flow (such as not redirecting for a
partial page update) is <code>org.springframework.js.AjaxHandler</code>. A <code>SpringJavascriptAjaxHandler</code> is configured by default that is able to
detect an Ajax request submitted via the Spring JS client-side API and can respond appropriately in the case where a redirect is required. In
order to integrate a different Ajax library (be it a pure JavaScript library, or a higher-level abstraction such as an Ajax-capable JSF
component library), a custom <code>AjaxHandler</code> can be injected into the <code>FlowHandlerAdapter</code> or <code>FlowController</code>.
</para>
</sect2>
<sect2 id="spring-js-ajax-mvc">
<title>Handling Ajax Requests with Spring MVC Controllers</title>
<para>
In order to handle Ajax requests with Spring MVC controllers, all that is needed is the configuration of
the provided Spring MVC extensions in your Spring application context for rendering the partial response
(note that these extensions require the use of Tiles for templating):
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
</sect1>
<sect1 xml:id="spring-js-ajax">
<title>Handling Ajax Requests</title>
<para>
Spring Javascript's client-side Ajax response handling is built upon the notion of receiving "fragments" back from the server.
These fragments are just standard HTML that is meant to replace portions of the existing page.
The key piece needed on the server is a way to determine which pieces of a full response need to be pulled out for partial rendering.
</para>
<para>
In order to be able to render partial fragments of a full response, the full response must be built using a
templating technology that allows the use of composition for constructing the response, and for the member
parts of the composition to be referenced and rendered individually.
Spring Javascript provides some simple Spring MVC extensions that make use of Tiles to achieve this.
The same technique could theoretically be used with any templating system supporting composition.
</para>
<para>
Spring Javascript's Ajax remoting functionality is built upon the notion that the core handling code for an
Ajax request should not differ from a standard browser request, thus no special knowledge of an Ajax request
is needed directly in the code and the same hanlder can be used for both styles of request.
</para>
<sect2 xml:id="custom-ajax-handler">
<title>Providing a Library-Specific AjaxHandler</title>
<para>
The key interface for integrating various Ajax libraries with the Ajax-aware behavior of Web Flow (such as not redirecting for a
partial page update) is <code>org.springframework.js.AjaxHandler</code>. A <code>SpringJavascriptAjaxHandler</code> is configured by default that is able to
detect an Ajax request submitted via the Spring JS client-side API and can respond appropriately in the case where a redirect is required. In
order to integrate a different Ajax library (be it a pure JavaScript library, or a higher-level abstraction such as an Ajax-capable JSF
component library), a custom <code>AjaxHandler</code> can be injected into the <code>FlowHandlerAdapter</code> or <code>FlowController</code>.
</para>
</sect2>
<sect2 xml:id="spring-js-ajax-mvc">
<title>Handling Ajax Requests with Spring MVC Controllers</title>
<para>
In order to handle Ajax requests with Spring MVC controllers, all that is needed is the configuration of
the provided Spring MVC extensions in your Spring application context for rendering the partial response
(note that these extensions require the use of Tiles for templating):
</para>
<programlisting language="xml"><![CDATA[
<bean id="tilesViewResolver" class="org.springframework.js.ajax.AjaxUrlBasedViewResolver">
<property name="viewClass" value="org.springframework.webflow.mvc.view.FlowAjaxTilesView"/>
<property name="viewClass" value="org.springframework.webflow.mvc.view.FlowAjaxTilesView"/>
</bean>]]>
</programlisting>
<para>
This configures the <code>AjaxUrlBasedViewResolver</code> which in turn interprets Ajax requests and creates <code>FlowAjaxTilesView</code> objects to handle rendering of the appropriate fragments.
Note that <code>FlowAjaxTilesView</code> is capable of handling the rendering for both Web Flow and pure Spring MVC requests.
The fragments correspond to individual attributes of a Tiles view definition. For example, take the following Tiles view definition:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
This configures the <code>AjaxUrlBasedViewResolver</code> which in turn interprets Ajax requests and creates <code>FlowAjaxTilesView</code> objects to handle rendering of the appropriate fragments.
Note that <code>FlowAjaxTilesView</code> is capable of handling the rendering for both Web Flow and pure Spring MVC requests.
The fragments correspond to individual attributes of a Tiles view definition. For example, take the following Tiles view definition:
</para>
<programlisting language="xml"><![CDATA[
<definition name="hotels/index" extends="standardLayout">
<put-attribute name="body" value="index.body" />
<put-attribute name="body" value="index.body" />
</definition>
<definition name="index.body" template="/WEB-INF/hotels/index.jsp">
<put-attribute name="hotelSearchForm" value="/WEB-INF/hotels/hotelSearchForm.jsp" />
<put-attribute name="bookingsTable" value="/WEB-INF/hotels/bookingsTable.jsp" />
<put-attribute name="hotelSearchForm" value="/WEB-INF/hotels/hotelSearchForm.jsp" />
<put-attribute name="bookingsTable" value="/WEB-INF/hotels/bookingsTable.jsp" />
</definition>]]>
</programlisting>
<para>
An Ajax request could specify the "body", "hotelSearchForm" or "bookingsTable" to be rendered as fragments in the request.
</para>
</sect2>
<sect2 id="spring-js-ajax-mvc-webflow">
<title>Handling Ajax Requests with Spring MVC + Spring Web Flow</title>
<para>
Spring Web Flow handles the optional rendering of fragments directly in the flow definition language through use of the <code>render</code> element.
The benefit of this approach is that the selection of fragments is completely decoupled from client-side code, such that no special parameters need to be passed with the request the way they
currently must be with the pure Spring MVC controller approach.
For example, if you wanted to render the "hotelSearchForm" fragment from the previous example Tiles view into a rich Javascript popup:
</para>
<programlisting language="xml"><![CDATA[
</programlisting>
<para>
An Ajax request could specify the "body", "hotelSearchForm" or "bookingsTable" to be rendered as fragments in the request.
</para>
</sect2>
<sect2 xml:id="spring-js-ajax-mvc-webflow">
<title>Handling Ajax Requests with Spring MVC + Spring Web Flow</title>
<para>
Spring Web Flow handles the optional rendering of fragments directly in the flow definition language through use of the <code>render</code> element.
The benefit of this approach is that the selection of fragments is completely decoupled from client-side code, such that no special parameters need to be passed with the request the way they
currently must be with the pure Spring MVC controller approach.
For example, if you wanted to render the "hotelSearchForm" fragment from the previous example Tiles view into a rich Javascript popup:
</para>
<programlisting language="xml"><![CDATA[
<view-state id="changeSearchCriteria" view="enterSearchCriteria.xhtml" popup="true">
<on-entry>
<render fragments="hotelSearchForm" />
</on-entry>
<transition on="search" to="reviewHotels">
<evaluate expression="searchCriteria.resetPage()"/>
</transition>
</view-state>]]>
</programlisting>
</sect2>
</sect1>
<on-entry>
<render fragments="hotelSearchForm" />
</on-entry>
<transition on="search" to="reviewHotels">
<evaluate expression="searchCriteria.resetPage()"/>
</transition>
</view-state>]]>
</programlisting>
</sect2>
</sect1>
</chapter>

722
src/reference/spring-mvc.xml
View File

@@ -1,499 +1,503 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="spring-mvc">
<title>Spring MVC Integration</title>
<chapter xml:id="spring-mvc"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Spring MVC Integration</title>
<sect1 id="spring-mvc-introduction">
<title>Introduction</title>
<sect1 xml:id="spring-mvc-introduction">
<title>Introduction</title>
<para>This chapter shows how to integrate Web Flow into a Spring MVC web
application. The <code>booking-mvc</code> sample application is a good
reference for Spring MVC with Web Flow. This application is a simplified
travel site that allows users to search for and book hotel rooms.</para>
</sect1>
<para>This chapter shows how to integrate Web Flow into a Spring MVC web
application. The <code>booking-mvc</code> sample application is a good
reference for Spring MVC with Web Flow. This application is a simplified
travel site that allows users to search for and book hotel rooms.</para>
</sect1>
<sect1 id="spring-mvc-config-web.xml">
<title>Configuring web.xml</title>
<sect1 xml:id="spring-mvc-config-web.xml">
<title>Configuring web.xml</title>
<para>The first step to using Spring MVC is to configure the
<code>DispatcherServlet</code> in <code>web.xml</code>. You typically do
this once per web application.</para>
<para>The first step to using Spring MVC is to configure the
<code>DispatcherServlet</code> in <code>web.xml</code>. You typically do
this once per web application.</para>
<para>The example below maps all requests that begin with
<code>/spring/</code> to the DispatcherServlet. An <code>init-param</code>
is used to provide the <code>contextConfigLocation</code>. This is the
configuration file for the web application.</para>
<para>The example below maps all requests that begin with
<code>/spring/</code> to the DispatcherServlet. An <code>init-param</code>
is used to provide the <code>contextConfigLocation</code>. This is the
configuration file for the web application.</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;servlet&gt;
&lt;servlet-name&gt;Spring MVC Dispatcher Servlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;org.springframework.web.servlet.DispatcherServlet&lt;/servlet-class&gt;
&lt;init-param&gt;
&lt;param-name&gt;contextConfigLocation&lt;/param-name&gt;
&lt;param-value&gt;/WEB-INF/web-application-config.xml&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;servlet-name&gt;Spring MVC Dispatcher Servlet&lt;/servlet-name&gt;
&lt;servlet-class&gt;org.springframework.web.servlet.DispatcherServlet&lt;/servlet-class&gt;
&lt;init-param&gt;
&lt;param-name&gt;contextConfigLocation&lt;/param-name&gt;
&lt;param-value&gt;/WEB-INF/web-application-config.xml&lt;/param-value&gt;
&lt;/init-param&gt;
&lt;/servlet&gt;
&lt;servlet-mapping&gt;
&lt;servlet-name&gt;Spring MVC Dispatcher Servlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/spring/*&lt;/url-pattern&gt;
&lt;servlet-name&gt;Spring MVC Dispatcher Servlet&lt;/servlet-name&gt;
&lt;url-pattern&gt;/spring/*&lt;/url-pattern&gt;
&lt;/servlet-mapping&gt;</programlisting>
</sect1>
</sect1>
<sect1 id="spring-mvc-config-spring-url-mapping">
<title>Dispatching to flows</title>
<sect1 xml:id="spring-mvc-config-spring-url-mapping">
<title>Dispatching to flows</title>
<para>The <code>DispatcherServlet</code> maps requests for application
resources to handlers. A flow is one type of handler.</para>
<para>The <code>DispatcherServlet</code> maps requests for application
resources to handlers. A flow is one type of handler.</para>
<sect2>
<title>Registering the FlowHandlerAdapter</title>
<sect2>
<title>Registering the FlowHandlerAdapter</title>
<para>The first step to dispatching requests to flows is to enable flow
handling within Spring MVC. To this, install the
<code>FlowHandlerAdapter</code>:</para>
<para>The first step to dispatching requests to flows is to enable flow
handling within Spring MVC. To this, install the
<code>FlowHandlerAdapter</code>:</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;!-- Enables FlowHandler URL mapping --&gt;
&lt;bean class="org.springframework.webflow.mvc.servlet.FlowHandlerAdapter"&gt;
&lt;property name="flowExecutor" ref="flowExecutor" /&gt;
&lt;property name="flowExecutor" ref="flowExecutor" /&gt;
&lt;/bean&gt;
</programlisting>
</sect2>
</sect2>
<sect2>
<title>Defining flow mappings</title>
<sect2>
<title>Defining flow mappings</title>
<para>Once flow handling is enabled, the next step is to map specific
application resources to your flows. The simplest way to do this is to
define a <code>FlowHandlerMapping</code>:</para>
<para>Once flow handling is enabled, the next step is to map specific
application resources to your flows. The simplest way to do this is to
define a <code>FlowHandlerMapping</code>:</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;!-- Maps request paths to flows in the flowRegistry;
e.g. a path of /hotels/booking looks for a flow with id "hotels/booking" --&gt;
e.g. a path of /hotels/booking looks for a flow with id "hotels/booking" --&gt;
&lt;bean class="org.springframework.webflow.mvc.servlet.FlowHandlerMapping"&gt;
&lt;property name="flowRegistry" ref="flowRegistry"/&gt;
&lt;property name="order" value="0"/&gt;
&lt;property name="flowRegistry" ref="flowRegistry"/&gt;
&lt;property name="order" value="0"/&gt;
&lt;/bean&gt;
</programlisting>
<para>Configuring this mapping allows the Dispatcher to map application
resource paths to flows in a flow registry. For example, accessing the
resource path <code>/hotels/booking</code> would result in a registry
query for the flow with id <code>hotels/booking</code>. If a flow is
found with that id, that flow will handle the request. If no flow is
found, the next handler mapping in the Dispatcher's ordered chain will
be queried or a "noHandlerFound" response will be returned.</para>
</sect2>
<para>Configuring this mapping allows the Dispatcher to map application
resource paths to flows in a flow registry. For example, accessing the
resource path <code>/hotels/booking</code> would result in a registry
query for the flow with id <code>hotels/booking</code>. If a flow is
found with that id, that flow will handle the request. If no flow is
found, the next handler mapping in the Dispatcher's ordered chain will
be queried or a "noHandlerFound" response will be returned.</para>
</sect2>
<sect2>
<title>Flow handling workflow</title>
<sect2>
<title>Flow handling workflow</title>
<para>When a valid flow mapping is found, the
<code>FlowHandlerAdapter</code> figures out whether to start a new
execution of that flow or resume an existing execution based on
information present the HTTP request. There are a number of defaults
related to starting and resuming flow executions the adapter
employs:</para>
<para>When a valid flow mapping is found, the
<code>FlowHandlerAdapter</code> figures out whether to start a new
execution of that flow or resume an existing execution based on
information present the HTTP request. There are a number of defaults
related to starting and resuming flow executions the adapter
employs:</para>
<itemizedlist>
<listitem>
<para>HTTP request parameters are made available in the input map of
all starting flow executions.</para>
</listitem>
<itemizedlist>
<listitem>
<para>HTTP request parameters are made available in the input map of
all starting flow executions.</para>
</listitem>
<listitem>
<para>When a flow execution ends without sending a final response,
the default handler will attempt to start a new execution in the
same request.</para>
</listitem>
<listitem>
<para>When a flow execution ends without sending a final response,
the default handler will attempt to start a new execution in the
same request.</para>
</listitem>
<listitem>
<para>Unhandled exceptions are propagated to the Dispatcher unless
the exception is a NoSuchFlowExecutionException. The default handler
will attempt to recover from a NoSuchFlowExecutionException by
starting over a new execution.</para>
</listitem>
</itemizedlist>
<listitem>
<para>Unhandled exceptions are propagated to the Dispatcher unless
the exception is a NoSuchFlowExecutionException. The default handler
will attempt to recover from a NoSuchFlowExecutionException by
starting over a new execution.</para>
</listitem>
</itemizedlist>
<para>Consult the API documentation for <code>FlowHandlerAdapter</code>
for more information. You may override these defaults by subclassing or
by implementing your own FlowHandler, discussed in the next
section.</para>
</sect2>
</sect1>
<para>Consult the API documentation for <code>FlowHandlerAdapter</code>
for more information. You may override these defaults by subclassing or
by implementing your own FlowHandler, discussed in the next
section.</para>
</sect2>
</sect1>
<sect1 id="spring-mvc-config-flow-handlers">
<title>Implementing custom FlowHandlers</title>
<sect1 xml:id="spring-mvc-config-flow-handlers">
<title>Implementing custom FlowHandlers</title>
<para><code>FlowHandler</code> is the extension point that can be used to
customize how flows are executed in a HTTP servlet environment. A
<code>FlowHandler</code> is used by the <code>FlowHandlerAdapter</code>
and is responsible for:</para>
<para><code>FlowHandler</code> is the extension point that can be used to
customize how flows are executed in a HTTP servlet environment. A
<code>FlowHandler</code> is used by the <code>FlowHandlerAdapter</code>
and is responsible for:</para>
<itemizedlist>
<listitem>
<para>Returning the <code>id</code> of a flow definition to
execute</para>
</listitem>
<itemizedlist>
<listitem>
<para>Returning the <code>id</code> of a flow definition to
execute</para>
</listitem>
<listitem>
<para>Creating the input to pass new executions of that flow as they
are started</para>
</listitem>
<listitem>
<para>Creating the input to pass new executions of that flow as they
are started</para>
</listitem>
<listitem>
<para>Handling outcomes returned by executions of that flow as they
end</para>
</listitem>
<listitem>
<para>Handling outcomes returned by executions of that flow as they
end</para>
</listitem>
<listitem>
<para>Handling any exceptions thrown by executions of that flow as
they occur</para>
</listitem>
</itemizedlist>
<listitem>
<para>Handling any exceptions thrown by executions of that flow as
they occur</para>
</listitem>
</itemizedlist>
<para>These responsibilities are illustrated in the definition of the
<code>org.springframework.mvc.servlet.FlowHandler</code> interface:</para>
<para>These responsibilities are illustrated in the definition of the
<code>org.springframework.mvc.servlet.FlowHandler</code> interface:</para>
<programlisting language="java">
<programlisting language="java">
public interface FlowHandler {
public String getFlowId();
public String getFlowId();
public MutableAttributeMap createExecutionInputMap(HttpServletRequest request);
public MutableAttributeMap createExecutionInputMap(HttpServletRequest request);
public String handleExecutionOutcome(FlowExecutionOutcome outcome,
HttpServletRequest request, HttpServletResponse response);
public String handleExecutionOutcome(FlowExecutionOutcome outcome,
HttpServletRequest request, HttpServletResponse response);
public String handleException(FlowException e,
HttpServletRequest request, HttpServletResponse response);
}
public String handleException(FlowException e,
HttpServletRequest request, HttpServletResponse response);
}
</programlisting>
<para>To implement a FlowHandler, subclass
<code>AbstractFlowHandler</code>. All these operations are optional, and
if not implemented the defaults will apply. You only need to override the
methods that you need. Specifically:</para>
<para>To implement a FlowHandler, subclass
<code>AbstractFlowHandler</code>. All these operations are optional, and
if not implemented the defaults will apply. You only need to override the
methods that you need. Specifically:</para>
<itemizedlist>
<listitem>
<para>Override <code>getFlowId(HttpServletRequest)</code> when the id
of your flow cannot be directly derived from the HTTP request. By
default, the id of the flow to execute is derived from the pathInfo
portion of the request URI. For example,
<code>http://localhost/app/hotels/booking?hotelId=1</code> results in
a flow id of <code>hotels/booking</code> by default.</para>
</listitem>
<itemizedlist>
<listitem>
<para>Override <code>getFlowId(HttpServletRequest)</code> when the id
of your flow cannot be directly derived from the HTTP request. By
default, the id of the flow to execute is derived from the pathInfo
portion of the request URI. For example,
<code>http://localhost/app/hotels/booking?hotelId=1</code> results in
a flow id of <code>hotels/booking</code> by default.</para>
</listitem>
<listitem>
<para>Override
<code>createExecutionInputMap(HttpServletRequest)</code> when you need
fine-grained control over extracting flow input parameters from the
HttpServletRequest. By default, all request parameters are treated as
flow input parameters.</para>
</listitem>
<listitem>
<para>Override
<code>createExecutionInputMap(HttpServletRequest)</code> when you need
fine-grained control over extracting flow input parameters from the
HttpServletRequest. By default, all request parameters are treated as
flow input parameters.</para>
</listitem>
<listitem>
<para>Override <code>handleExecutionOutcome</code> when you need to
handle specific flow execution outcomes in a custom manner. The
default behavior sends a redirect to the ended flow's URL to restart a
new execution of the flow.</para>
</listitem>
<listitem>
<para>Override <code>handleExecutionOutcome</code> when you need to
handle specific flow execution outcomes in a custom manner. The
default behavior sends a redirect to the ended flow's URL to restart a
new execution of the flow.</para>
</listitem>
<listitem>
<para>Override <code>handleException</code> when you need fine-grained
control over unhandled flow exceptions. The default behavior attempts
to restart the flow when a client attempts to access an ended or
expired flow execution. Any other exception is rethrown to the Spring
MVC ExceptionResolver infrastructure by default.</para>
</listitem>
</itemizedlist>
<listitem>
<para>Override <code>handleException</code> when you need fine-grained
control over unhandled flow exceptions. The default behavior attempts
to restart the flow when a client attempts to access an ended or
expired flow execution. Any other exception is rethrown to the Spring
MVC ExceptionResolver infrastructure by default.</para>
</listitem>
</itemizedlist>
<sect2 id="spring-mvc-flow-handler-example">
<title>Example FlowHandler</title>
<sect2 xml:id="spring-mvc-flow-handler-example">
<title>Example FlowHandler</title>
<para>A common interaction pattern between Spring MVC And Web Flow is
for a Flow to redirect to a @Controller when it ends. FlowHandlers allow
this to be done without coupling the flow definition itself with a
specific controller URL. An example FlowHandler that redirects to a
Spring MVC Controller is shown below:</para>
<para>A common interaction pattern between Spring MVC And Web Flow is
for a Flow to redirect to a @Controller when it ends. FlowHandlers allow
this to be done without coupling the flow definition itself with a
specific controller URL. An example FlowHandler that redirects to a
Spring MVC Controller is shown below:</para>
<programlisting language="java">
<programlisting language="java">
public class BookingFlowHandler extends AbstractFlowHandler {
public String handleExecutionOutcome(FlowExecutionOutcome outcome,
HttpServletRequest request, HttpServletResponse response) {
if (outcome.getId().equals("bookingConfirmed")) {
return "/booking/show?bookingId=" + outcome.getOutput().get("bookingId");
} else {
return "/hotels/index";
}
}
public String handleExecutionOutcome(FlowExecutionOutcome outcome,
HttpServletRequest request, HttpServletResponse response) {
if (outcome.getId().equals("bookingConfirmed")) {
return "/booking/show?bookingId=" + outcome.getOutput().get("bookingId");
} else {
return "/hotels/index";
}
}
}
</programlisting>
<para>Since this handler only needs to handle flow execution outcomes in
a custom manner, nothing else is overridden. The
<code>bookingConfirmed</code> outcome will result in a redirect to show
the new booking. Any other outcome will redirect back to the hotels
index page.</para>
</sect2>
<para>Since this handler only needs to handle flow execution outcomes in
a custom manner, nothing else is overridden. The
<code>bookingConfirmed</code> outcome will result in a redirect to show
the new booking. Any other outcome will redirect back to the hotels
index page.</para>
</sect2>
<sect2>
<title>Deploying a custom FlowHandler</title>
<sect2>
<title>Deploying a custom FlowHandler</title>
<para>To install a custom FlowHandler, simply deploy it as a bean. The
bean name must match the id of the flow the handler should apply
to.</para>
<para>To install a custom FlowHandler, simply deploy it as a bean. The
bean name must match the id of the flow the handler should apply
to.</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;bean name="hotels/booking" class="org.springframework.webflow.samples.booking.BookingFlowHandler" /&gt;
</programlisting>
<para>With this configuration, accessing the resource
<code>/hotels/booking</code> will launch the <code>hotels/booking</code>
flow using the custom BookingFlowHandler. When the booking flow ends,
the FlowHandler will process the flow execution outcome and redirect to
the appropriate controller.</para>
</sect2>
<para>With this configuration, accessing the resource
<code>/hotels/booking</code> will launch the <code>hotels/booking</code>
flow using the custom BookingFlowHandler. When the booking flow ends,
the FlowHandler will process the flow execution outcome and redirect to
the appropriate controller.</para>
</sect2>
<sect2 id="spring-mvc-flow-handler-redirects">
<title>FlowHandler Redirects</title>
<sect2 xml:id="spring-mvc-flow-handler-redirects">
<title>FlowHandler Redirects</title>
<para>A FlowHandler handling a FlowExecutionOutcome or FlowException
returns a <code>String</code> to indicate the resource to redirect to
after handling. In the previous example, the
<code>BookingFlowHandler</code> redirects to the
<code>booking/show</code> resource URI for <code>bookingConfirmed</code>
outcomes, and the <code>hotels/index</code> resource URI for all other
outcomes.</para>
<para>A FlowHandler handling a FlowExecutionOutcome or FlowException
returns a <code>String</code> to indicate the resource to redirect to
after handling. In the previous example, the
<code>BookingFlowHandler</code> redirects to the
<code>booking/show</code> resource URI for <code>bookingConfirmed</code>
outcomes, and the <code>hotels/index</code> resource URI for all other
outcomes.</para>
<para>By default, returned resource locations are relative to the
current servlet mapping. This allows for a flow handler to redirect to
other Controllers in the application using relative paths. In addition,
explicit redirect prefixes are supported for cases where more control is
needed.</para>
<para>By default, returned resource locations are relative to the
current servlet mapping. This allows for a flow handler to redirect to
other Controllers in the application using relative paths. In addition,
explicit redirect prefixes are supported for cases where more control is
needed.</para>
<para>The explicit redirect prefixes supported are:</para>
<para>The explicit redirect prefixes supported are:</para>
<itemizedlist>
<listitem>
<para><code>servletRelative:</code> - redirect to a resource
relative to the current servlet</para>
</listitem>
<itemizedlist>
<listitem>
<para><code>servletRelative:</code> - redirect to a resource
relative to the current servlet</para>
</listitem>
<listitem>
<para><code>contextRelative:</code> - redirect to a resource
relative to the current web application context path</para>
</listitem>
<listitem>
<para><code>contextRelative:</code> - redirect to a resource
relative to the current web application context path</para>
</listitem>
<listitem>
<para><code>serverRelative:</code> - redirect to a resource relative
to the server root</para>
</listitem>
<listitem>
<para><code>serverRelative:</code> - redirect to a resource relative
to the server root</para>
</listitem>
<listitem>
<para><code>http://</code> or <code>https://</code> - redirect to a
fully-qualified resource URI</para>
</listitem>
</itemizedlist>
<listitem>
<para><code>http://</code> or <code>https://</code> - redirect to a
fully-qualified resource URI</para>
</listitem>
</itemizedlist>
<para>These same redirect prefixes are also supported within a flow
definition when using the <code>externalRedirect:</code> directive in
conjunction with a view-state or end-state; for example,
<code>view="externalRedirect:http://springframework.org"</code></para>
</sect2>
</sect1>
<para>These same redirect prefixes are also supported within a flow
definition when using the <code>externalRedirect:</code> directive in
conjunction with a view-state or end-state; for example,
<code>view="externalRedirect:http://springframework.org"</code></para>
</sect2>
</sect1>
<sect1 id="spring-mvc-config-spring-view-resolution">
<title>View Resolution</title>
<sect1 xml:id="spring-mvc-config-spring-view-resolution">
<title>View Resolution</title>
<para>Web Flow 2 maps selected view identifiers to files located within
the flow's working directory unless otherwise specified. For existing
Spring MVC + Web Flow applications, an external <code>ViewResolver</code>
is likely already handling this mapping for you. Therefore, to continue
using that resolver and to avoid having to change how your existing flow
views are packaged, configure Web Flow as follows:</para>
<para>Web Flow 2 maps selected view identifiers to files located within
the flow's working directory unless otherwise specified. For existing
Spring MVC + Web Flow applications, an external <code>ViewResolver</code>
is likely already handling this mapping for you. Therefore, to continue
using that resolver and to avoid having to change how your existing flow
views are packaged, configure Web Flow as follows:</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;webflow:flow-registry id="flowRegistry" flow-builder-services="flowBuilderServices"&gt;
&lt;webflow:location path="/WEB-INF/hotels/booking/booking.xml" /&gt;
&lt;webflow:location path="/WEB-INF/hotels/booking/booking.xml" /&gt;
&lt;/webflow:flow-registry&gt;
&lt;webflow:flow-builder-services id="flowBuilderServices" view-factory-creator="mvcViewFactoryCreator"/&gt;
&lt;bean id="mvcViewFactoryCreator" class="org.springframework.webflow.mvc.builder.MvcViewFactoryCreator"&gt;
&lt;property name="viewResolvers" ref="myExistingViewResolverToUseForFlows"/&gt;
&lt;property name="viewResolvers" ref="myExistingViewResolverToUseForFlows"/&gt;
&lt;/bean&gt;
</programlisting>
<para>The MvcViewFactoryCreator is the factory that allows you to
configure how the Spring MVC view system is used inside Spring Web Flow.
Use it to configure existing ViewResolvers, as well as other services such
as a custom MessageCodesResolver. You may also enable data binding use
Spring MVC's native BeanWrapper by setting the
<code>useSpringBinding</code> flag to true. This is an alternative to
using OGNL or the Unified EL for view-to-model data binding. See the
JavaDoc API of this class for more information.</para>
</sect1>
<para>The MvcViewFactoryCreator is the factory that allows you to
configure how the Spring MVC view system is used inside Spring Web Flow.
Use it to configure existing ViewResolvers, as well as other services such
as a custom MessageCodesResolver. You may also enable data binding use
Spring MVC's native BeanWrapper by setting the
<code>useSpringBinding</code> flag to true. This is an alternative to
using OGNL or the Unified EL for view-to-model data binding. See the
JavaDoc API of this class for more information.</para>
</sect1>
<sect1 id="spring-mvc-resuming-on-event">
<title>Signaling an event from a View</title>
<sect1 xml:id="spring-mvc-resuming-on-event">
<title>Signaling an event from a View</title>
<para>When a flow enters a view-state it pauses, redirects the user to its
execution URL, and waits for a user event to resume. Events are generally
signaled by activating buttons, links, or other user interface commands.
How events are decoded server-side is specific to the view technology in
use. This section shows how to trigger events from HTML-based views
generated by templating engines such as JSP, Velocity, or
Freemarker.</para>
<para>When a flow enters a view-state it pauses, redirects the user to its
execution URL, and waits for a user event to resume. Events are generally
signaled by activating buttons, links, or other user interface commands.
How events are decoded server-side is specific to the view technology in
use. This section shows how to trigger events from HTML-based views
generated by templating engines such as JSP, Velocity, or
Freemarker.</para>
<sect2 id="webflow-event-named-html-button">
<title>Using a named HTML button to signal an event</title>
<sect2 xml:id="webflow-event-named-html-button">
<title>Using a named HTML button to signal an event</title>
<para>The example below shows two buttons on the same form that signal
<code>proceed</code> and <code>cancel</code> events when clicked,
respectively.</para>
<para>The example below shows two buttons on the same form that signal
<code>proceed</code> and <code>cancel</code> events when clicked,
respectively.</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;input type="submit" name="_eventId_proceed" value="Proceed" /&gt;
&lt;input type="submit" name="_eventId_cancel" value="Cancel" /&gt;
&lt;input type="submit" name="_eventId_cancel" value="Cancel" /&gt;
</programlisting>
<para>When a button is pressed Web Flow finds a request parameter name
beginning with <code>_eventId_</code> and treats the remaining substring
as the event id. So in this example, submitting
<code>_eventId_proceed</code> becomes <code>proceed</code>. This style
should be considered when there are several different events that can be
signaled from the same form.</para>
</sect2>
<para>When a button is pressed Web Flow finds a request parameter name
beginning with <code>_eventId_</code> and treats the remaining substring
as the event id. So in this example, submitting
<code>_eventId_proceed</code> becomes <code>proceed</code>. This style
should be considered when there are several different events that can be
signaled from the same form.</para>
</sect2>
<sect2 id="webflow-event-hidden-parameter">
<title>Using a hidden HTML form parameter to signal an event</title>
<sect2 xml:id="webflow-event-hidden-parameter">
<title>Using a hidden HTML form parameter to signal an event</title>
<para>The example below shows a form that signals the
<code>proceed</code> event when submitted:</para>
<para>The example below shows a form that signals the
<code>proceed</code> event when submitted:</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;input type="submit" value="Proceed" /&gt;
&lt;input type="hidden" name="_eventId" value="proceed" /&gt;
&lt;input type="hidden" name="_eventId" value="proceed" /&gt;
</programlisting>
<para>Here, Web Flow simply detects the special <code>_eventId</code>
parameter and uses its value as the event id. This style should only be
considered when there is one event that can be signaled on the
form.</para>
</sect2>
<para>Here, Web Flow simply detects the special <code>_eventId</code>
parameter and uses its value as the event id. This style should only be
considered when there is one event that can be signaled on the
form.</para>
</sect2>
<sect2 id="webflow-event-link">
<title>Using a HTML link to signal an event</title>
<sect2 xml:id="webflow-event-link">
<title>Using a HTML link to signal an event</title>
<para>The example below shows a link that signals the
<code>cancel</code> event when activated:</para>
<para>The example below shows a link that signals the
<code>cancel</code> event when activated:</para>
<programlisting language="xml">
&lt;a href="${flowExecutionUrl}&amp;_eventId=cancel"&gt;Cancel&lt;/a&gt;
<programlisting language="xml">
&lt;a href="${flowExecutionUrl}&amp;_eventId=cancel"&gt;Cancel&lt;/a&gt;
</programlisting>
<para>Firing an event results in a HTTP request being sent back to the
server. On the server-side, the flow handles decoding the event from
within its current view-state. How this decoding process works is
specific to the view implementation. Recall a Spring MVC view
implementation simply looks for a request parameter named
<code>_eventId</code>. If no <code>_eventId</code> parameter is found,
the view will look for a parameter that starts with
<code>_eventId_</code> and will use the remaining substring as the event
id. If neither cases exist, no flow event is triggered.</para>
</sect2>
</sect1>
<para>Firing an event results in a HTTP request being sent back to the
server. On the server-side, the flow handles decoding the event from
within its current view-state. How this decoding process works is
specific to the view implementation. Recall a Spring MVC view
implementation simply looks for a request parameter named
<code>_eventId</code>. If no <code>_eventId</code> parameter is found,
the view will look for a parameter that starts with
<code>_eventId_</code> and will use the remaining substring as the event
id. If neither cases exist, no flow event is triggered.</para>
</sect2>
</sect1>
<sect1 id="spring-mvc-embedded-flow">
<title>Embedding A Flow On A Page</title>
<sect1 xml:id="spring-mvc-embedded-flow">
<title>Embedding A Flow On A Page</title>
<para>By default when a flow enters a view state, it executes a
client-side redirect before rendering the view. This approach is known as
POST-REDIRECT-GET. It has the advantage of separating the form processing
for one view from the rendering of the next view. As a result the browser
Back and Refresh buttons work seamlessly without causing any browser
warnings.</para>
<para>By default when a flow enters a view state, it executes a
client-side redirect before rendering the view. This approach is known as
POST-REDIRECT-GET. It has the advantage of separating the form processing
for one view from the rendering of the next view. As a result the browser
Back and Refresh buttons work seamlessly without causing any browser
warnings.</para>
<para>Normally the client-side redirect is transparent from a user's
perspective. However, there are situations where POST-REDIRECT-GET may not
bring the same benefits. For example a flow may be embedded on a page and driven via
Ajax requests refreshing only the area of the page that belongs to the flow.
Not only is it unnecessary to use client-side redirects in this case, it
is also not the desired behavior with regards to keeping the surrounding
content of the page intact.</para>
<para>Normally the client-side redirect is transparent from a user's
perspective. However, there are situations where POST-REDIRECT-GET may not
bring the same benefits. For example a flow may be embedded on a page and driven via
Ajax requests refreshing only the area of the page that belongs to the flow.
Not only is it unnecessary to use client-side redirects in this case, it
is also not the desired behavior with regards to keeping the surrounding
content of the page intact.</para>
<para>The <xref linkend="spring-js-ajax" /> explains how to do
partial rendering during Ajax requests. The focus of this section is to
explain how to control flow execution redirect behavior during
Ajax requests. To indicate a flow should execute in "page embedded" mode all
you need to do is append an extra parameter when launching the
flow:</para>
<para>The <xref linkend="spring-js-ajax" /> explains how to do
partial rendering during Ajax requests. The focus of this section is to
explain how to control flow execution redirect behavior during
Ajax requests. To indicate a flow should execute in "page embedded" mode all
you need to do is append an extra parameter when launching the
flow:</para>
<programlisting language="xml">/hotels/booking?mode=embedded</programlisting>
<programlisting language="xml">/hotels/booking?mode=embedded</programlisting>
<para>When launched in "page embedded" mode a flow will not issue
flow execution redirects during Ajax requests. The mode=embedded parameter
only needs to be passed when launching the flow. Your only other concern is
to use Ajax requests and to render only the content required to update
the portion of the page displaying the flow.</para>
<para>When launched in "page embedded" mode a flow will not issue
flow execution redirects during Ajax requests. The mode=embedded parameter
only needs to be passed when launching the flow. Your only other concern is
to use Ajax requests and to render only the content required to update
the portion of the page displaying the flow.</para>
<sect2 id="spring-mvc-embedded-flow-alternatives">
<sect2 xml:id="spring-mvc-embedded-flow-alternatives">
<title>Embedded Mode Vs Default Redirect Behavior</title>
<para>
By default Web Flow does a client-side redirect upon entering every view state.
However if you remain in the same view state -- for example a transition without a "to" attribute -- during an Ajax request there will not be a client-side redirect.
This behavior should be quite familiar to Spring Web Flow 2 users.
It is appropriate for a top-level flow that supports the browser back button while still taking advantage of Ajax and partial rendering for use cases where you remain in the same view such as form validation, paging trough search results, and others.
However transitions to a new view state are always followed with a client-side redirect.
That makes it impossible to embed a flow on a page or within a modal dialog and execute more than one view state without causing a full-page refresh.
However transitions to a new view state are always followed with a client-side redirect.
That makes it impossible to embed a flow on a page or within a modal dialog and execute more than one view state without causing a full-page refresh.
Hence if your use case requires embedding a flow you can launch it in "embedded" mode.
</para>
</sect2>
<sect2 id="spring-mvc-embedded-flow-examples">
<sect2 xml:id="spring-mvc-embedded-flow-examples">
<title>Embedded Flow Examples</title>
<para>If you'd like to see examples of a flow embedded on a page and within
a modal dialog please refer to the webflow-showcase project. You can check out
the source code locally, build it as you would a Maven project, and import
it into Eclipse:</para>
<para><programlisting language="xml">cd some-directory
<para>If you'd like to see examples of a flow embedded on a page and within
a modal dialog please refer to the webflow-showcase project. You can check out
the source code locally, build it as you would a Maven project, and import
it into Eclipse:</para>
<para><programlisting language="xml">cd some-directory
svn co https://src.springframework.org/svn/spring-samples/webflow-showcase
cd webflow-showcase
mvn package
# import into Eclipse</programlisting>
</para>
</sect2>
</sect1>
</sect1>
<sect1 id="spring-mvc-flash-output">
<title>Saving Flow Output to MVC Flash Scope</title>
<para>Flow output can be automatically saved to MVC flash scope when an <code>end-state</code>
performs an internal redirect. This is particularly useful when displaying a summary
screen at the end of a flow. For backwards compatibility this feature is disabled by
default, to enable set <code>saveOutputToFlashScopeOnRedirect</code> on your
<code>FlowHandlerAdapter</code> to <code>true</code>.</para>
<sect1 xml:id="spring-mvc-flash-output">
<title>Saving Flow Output to MVC Flash Scope</title>
<para>Flow output can be automatically saved to MVC flash scope when an <code>end-state</code>
performs an internal redirect. This is particularly useful when displaying a summary
screen at the end of a flow. For backwards compatibility this feature is disabled by
default, to enable set <code>saveOutputToFlashScopeOnRedirect</code> on your
<code>FlowHandlerAdapter</code> to <code>true</code>.</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;!-- Enables FlowHandler URL mapping --&gt;
&lt;bean class="org.springframework.webflow.mvc.servlet.FlowHandlerAdapter"&gt;
&lt;property name="flowExecutor" ref="flowExecutor" /&gt;
&lt;property name="saveOutputToFlashScopeOnRedirect" value="true" /&gt;
&lt;property name="flowExecutor" ref="flowExecutor" /&gt;
&lt;property name="saveOutputToFlashScopeOnRedirect" value="true" /&gt;
&lt;/bean&gt;
</programlisting>
</programlisting>
<para>The following example will add <code>confirmationNumber</code> to the MVC flash scope
before redirecting to the <code>summary</code> screen.</para>
<para>The following example will add <code>confirmationNumber</code> to the MVC flash scope
before redirecting to the <code>summary</code> screen.</para>
<programlisting language="xml">
<programlisting language="xml">
&lt;end-state id="finish" view="externalRedirect:summary"&gt;
&lt;output name="confirmationNumber" value="booking.confirmationNumber" /&gt;
&lt;output name="confirmationNumber" value="booking.confirmationNumber" /&gt;
&lt;/end-state&gt;
</programlisting>
</sect1>
</programlisting>
</sect1>
</chapter>

72
src/reference/system-setup.xml
View File

@@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="system-setup">
<chapter xml:id="system-setup"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>System Setup</title>
<sect1 id="system-setup-introduction">
<sect1 xml:id="system-setup-introduction">
<title>Introduction</title>
<para>
This chapter shows you how to setup the Web Flow system for use in any web environment.
</para>
</sect1>
<sect1 id="system-config-schema">
<sect1 xml:id="system-config-schema">
<title>webflow-config.xsd</title>
<para>
Web Flow provides a Spring schema that allows you to configure the system.
@@ -24,19 +28,19 @@
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/webflow-config
http://www.springframework.org/schema/webflow-config/spring-webflow-config-2.3.xsd">
http://www.springframework.org/schema/webflow-config/spring-webflow-config-2.3.xsd">
<!-- Setup Web Flow here -->
</beans>]]>
</programlisting>
</sect1>
<sect1 id="system-config-basic">
<sect1 xml:id="system-config-basic">
<title>Basic system configuration</title>
<para>
The next section shows the minimal configuration required to set up the Web Flow system in your application.
</para>
<sect2 id="basic-setup-flow-registry">
<sect2 xml:id="basic-setup-flow-registry">
<title>FlowRegistry</title>
<para>
Register your flows in a <code>FlowRegistry</code>:
@@ -47,7 +51,7 @@
</webflow:flow-registry>]]>
</programlisting>
</sect2>
<sect2 id="basic-setup-flow-executor">
<sect2 xml:id="basic-setup-flow-executor">
<title>FlowExecutor</title>
<para>
Deploy a FlowExecutor, the central service for executing flows:
@@ -60,12 +64,12 @@
</para>
</sect2>
</sect1>
<sect1 id="flow-registry">
<sect1 xml:id="flow-registry">
<title>flow-registry options</title>
<para>
This section explores flow-registry configuration options.
</para>
<sect2 id="flow-registry-location">
<sect2 xml:id="flow-registry-location">
<title>Specifying flow locations</title>
<para>
Use the <code>location</code> element to specify paths to flow definitions to register.
@@ -74,8 +78,8 @@
<programlisting language="xml"><![CDATA[
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" />]]>
</programlisting>
</sect2>
<sect2 id="flow-registry-location-id">
</sect2>
<sect2 xml:id="flow-registry-location-id">
<title>Assigning custom flow identifiers</title>
<para>
Specify an id to assign a custom registry identifier to a flow:
@@ -84,7 +88,7 @@
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" id="bookHotel" />]]>
</programlisting>
</sect2>
<sect2 id="flow-registry-location-attributes">
<sect2 xml:id="flow-registry-location-attributes">
<title>Assigning flow meta-attributes</title>
<para>
Use the <code>flow-definition-attributes</code> element to assign custom meta-attributes to a registered flow:
@@ -97,7 +101,7 @@
</webflow:flow-location>]]>
</programlisting>
</sect2>
<sect2 id="flow-registry-patterns">
<sect2 xml:id="flow-registry-patterns">
<title>Registering flows using a location pattern</title>
<para>
Use the <code>flow-location-patterns</code> element to register flows that match a specific resource location pattern:
@@ -106,7 +110,7 @@
<webflow:flow-location-pattern value="/WEB-INF/flows/**/*-flow.xml" />]]>
</programlisting>
</sect2>
<sect2 id="flow-registry-base-path">
<sect2 xml:id="flow-registry-base-path">
<title>Flow location base path</title>
<para>
Use the <code>base-path</code> attribute to define a base location for all flows in the application.
@@ -150,7 +154,7 @@
you'd end up with flow ids of <code>user/login</code>, <code>user/registration</code>, <code>hotels/booking</code>, and <code>flights/booking</code>, respectively.
</para>
</sect2>
<sect2 id="flow-registry-parent">
<sect2 xml:id="flow-registry-parent">
<title>Configuring FlowRegistry hierarchies</title>
<para>
Use the <code>parent</code> attribute to link two flow registries together in a hierarchy.
@@ -167,8 +171,8 @@
<!-- Global flows shared by several applications -->
</webflow:flow-registry>]]>
</programlisting>
</sect2>
<sect2 id="flow-registry-builder-services">
</sect2>
<sect2 xml:id="flow-registry-builder-services">
<title>Configuring custom FlowBuilder services</title>
<para>
Use the <code>flow-builder-services</code> attribute to customize the services and settings used to build flows in a flow-registry.
@@ -196,7 +200,7 @@
<bean id="expressionParser" class="..." />
<bean id="viewFactoryCreator" class="..." />]]>
</programlisting>
<sect3 id="builder-service-conversion">
<sect3 xml:id="builder-service-conversion">
<title>conversion-service</title>
<para>
Use the <code>conversion-service</code> attribute to customize the <code>ConversionService</code> used by the Web Flow system.
@@ -206,14 +210,14 @@
Please read <xref linkend="view-type-conversion"/> for important information on how to provide custom type conversion logic.
</para>
</sect3>
<sect3 id="builder-service-expression-parser">
<sect3 xml:id="builder-service-expression-parser">
<title>expression-parser</title>
<para>
Use the <code>expression-parser</code> attribute to customize the <code>ExpressionParser</code> used by the Web Flow system.
The default ExpressionParser uses the Unified EL if available on the classpath, otherwise OGNL is used.
The default ExpressionParser uses the Unified EL if available on the classpath, otherwise OGNL is used.
</para>
</sect3>
<sect3 id="builder-service-view-factory-creator">
<sect3 xml:id="builder-service-view-factory-creator">
<title>view-factory-creator</title>
<para>
Use the <code>view-factory-creator</code> attribute to customize the <code>ViewFactoryCreator</code> used by the Web Flow system.
@@ -224,7 +228,7 @@
These settings are global configuration attributes that can be applied during the flow construction process.
</para>
</sect3>
<sect3 id="builder-development">
<sect3 xml:id="builder-development">
<title>development</title>
<para>
Set this to <code>true</code> to switch on flow <emphasis>development mode</emphasis>.
@@ -233,12 +237,12 @@
</sect3>
</sect2>
</sect1>
<sect1 id="flow-executor">
<sect1 xml:id="flow-executor">
<title>flow-executor options</title>
<para>
This section explores flow-executor configuration options.
</para>
<sect2 id="flow-executor-execution-listeners">
</para>
<sect2 xml:id="flow-executor-execution-listeners">
<title>Attaching flow execution listeners</title>
<para>
Use the <code>flow-execution-listeners</code> element to register listeners that observe the lifecycle of flow executions:
@@ -256,7 +260,7 @@
<webflow:listener ref="securityListener" criteria="securedFlow1,securedFlow2"/>]]>
</programlisting>
</sect2>
<sect2 id="tuning-flow-execution-repository">
<sect2 xml:id="tuning-flow-execution-repository">
<title>Tuning FlowExecution persistence</title>
<para>
Use the <code>flow-execution-repository</code> element to tune flow execution persistence settings:
@@ -266,23 +270,23 @@
<webflow:flow-execution-repository max-executions="5" max-execution-snapshots="30" />
</webflow:flow-executor>]]>
</programlisting>
<sect3 id="repository-max-executions">
<sect3 xml:id="repository-max-executions">
<title>max-executions</title>
<para>
Tune the <code>max-executions</code> attribute to place a cap on the number of flow executions that can be created per user session.
When the maximum number of executions is exceeded, the oldest execution is removed.
<note>
<para>
The <code>max-executions</code> attribute is per user session, i.e. it works across instances of any flow definition.
The <code>max-executions</code> attribute is per user session, i.e. it works across instances of any flow definition.
</para>
</note>
</para>
</sect3>
<sect3 id="repository-max-snapshots">
<sect3 xml:id="repository-max-snapshots">
<title>max-execution-snapshots</title>
<para>
Tune the <code>max-execution-snapshots</code> attribute to place a cap on the number of history snapshots that can be taken per flow execution.
To disable snapshotting, set this value to 0. To enable an unlimited number of snapshots, set this value to -1.
To disable snapshotting, set this value to 0. To enable an unlimited number of snapshots, set this value to -1.
<note>
<para>
History snapshots enable browser back button support.

162
src/reference/testing.xml
View File

@@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="testing">
<chapter xml:id="testing"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Testing flows</title>
<sect1 id="testing-introduction">
<sect1 xml:id="testing-introduction">
<title>Introduction</title>
<para>
This chapter shows you how to test flows.
</para>
</sect1>
<sect1 id="extending-abstractflowexecutiontest">
<sect1 xml:id="extending-abstractflowexecutiontest">
<title>Extending AbstractXmlFlowExecutionTests</title>
<para>
To test the execution of a XML-based flow definition, extend <code>AbstractXmlFlowExecutionTests</code>:
@@ -21,7 +25,7 @@ public class BookingFlowExecutionTests extends AbstractXmlFlowExecutionTests {
}]]>
</programlisting>
</sect1>
<sect1 id="override-getResource">
<sect1 xml:id="override-getResource">
<title>Specifying the path to the flow to test</title>
<para>
At a minimum, you must override <code>getResource(FlowDefinitionResourceFactory)</code> to return the path to the flow you wish to test:
@@ -29,11 +33,11 @@ public class BookingFlowExecutionTests extends AbstractXmlFlowExecutionTests {
<programlisting language="java"><![CDATA[
@Override
protected FlowDefinitionResource getResource(FlowDefinitionResourceFactory resourceFactory) {
return resourceFactory.createFileResource("src/main/webapp/WEB-INF/hotels/booking/booking.xml");
return resourceFactory.createFileResource("src/main/webapp/WEB-INF/hotels/booking/booking.xml");
}]]>
</programlisting>
</sect1>
<sect1 id="override-configureFlowBuilderContext">
<sect1 xml:id="override-configureFlowBuilderContext">
<title>Registering flow dependencies</title>
<para>
If your flow has dependencies on externally managed services,
@@ -42,107 +46,107 @@ protected FlowDefinitionResource getResource(FlowDefinitionResourceFactory resou
<programlisting language="java"><![CDATA[
@Override
protected void configureFlowBuilderContext(MockFlowBuilderContext builderContext) {
builderContext.registerBean("bookingService", new StubBookingService());
builderContext.registerBean("bookingService", new StubBookingService());
}]]>
</programlisting>
<para>
If your flow extends from another flow, or has states that extend other states,
also override <code>getModelResources(FlowDefinitionResourceFactory)</code> to return the path to the parent flows.
</para>
</programlisting>
<para>
If your flow extends from another flow, or has states that extend other states,
also override <code>getModelResources(FlowDefinitionResourceFactory)</code> to return the path to the parent flows.
</para>
<programlisting language="java"><![CDATA[
@Override
protected FlowDefinitionResource[] getModelResources(FlowDefinitionResourceFactory resourceFactory) {
return new FlowDefinitionResource[] {
resourceFactory.createFileResource("src/main/webapp/WEB-INF/common/common.xml")
};
return new FlowDefinitionResource[] {
resourceFactory.createFileResource("src/main/webapp/WEB-INF/common/common.xml")
};
}]]>
</programlisting>
</sect1>
<sect1 id="testing-flowstartup">
<sect1 xml:id="testing-flowstartup">
<title>Testing flow startup</title>
<para>
Have your first test exercise the startup of your flow:
</para>
<para>
Have your first test exercise the startup of your flow:
</para>
<programlisting language="java"><![CDATA[
public void testStartBookingFlow() {
Booking booking = createTestBooking();
Booking booking = createTestBooking();
MutableAttributeMap input = new LocalAttributeMap();
input.put("hotelId", "1");
MockExternalContext context = new MockExternalContext();
context.setCurrentUser("keith");
startFlow(input, context);
MutableAttributeMap input = new LocalAttributeMap();
input.put("hotelId", "1");
MockExternalContext context = new MockExternalContext();
context.setCurrentUser("keith");
startFlow(input, context);
assertCurrentStateEquals("enterBookingDetails");
assertTrue(getRequiredFlowAttribute("booking") instanceof Booking);
assertCurrentStateEquals("enterBookingDetails");
assertTrue(getRequiredFlowAttribute("booking") instanceof Booking);
}]]>
</programlisting>
<para>
Assertions generally verify the flow is in the correct state you expect.
</para>
</programlisting>
<para>
Assertions generally verify the flow is in the correct state you expect.
</para>
</sect1>
<sect1 id="testing-flowevents">
<title>Testing flow event handling</title>
<para>
Define additional tests to exercise flow event handling behavior.
You goal should be to exercise all paths through the flow.
You can use the convenient <code>setCurrentState(String)</code> method to jump to the flow state where you wish to begin your test.
</para>
<programlisting language="java"><![CDATA[
<sect1 xml:id="testing-flowevents">
<title>Testing flow event handling</title>
<para>
Define additional tests to exercise flow event handling behavior.
You goal should be to exercise all paths through the flow.
You can use the convenient <code>setCurrentState(String)</code> method to jump to the flow state where you wish to begin your test.
</para>
<programlisting language="java"><![CDATA[
public void testEnterBookingDetails_Proceed() {
setCurrentState("enterBookingDetails");
getFlowScope().put("booking", createTestBooking());
setCurrentState("enterBookingDetails");
MockExternalContext context = new MockExternalContext();
context.setEventId("proceed");
resumeFlow(context);
getFlowScope().put("booking", createTestBooking());
assertCurrentStateEquals("reviewBooking");
MockExternalContext context = new MockExternalContext();
context.setEventId("proceed");
resumeFlow(context);
assertCurrentStateEquals("reviewBooking");
}]]>
</programlisting>
</sect1>
<sect1 id="testing-mockingsubflows">
<title>Mocking a subflow</title>
<para>
To test calling a subflow, register a mock implementation of the subflow that asserts input was passed in correctly and
returns the correct outcome for your test scenario.
</para>
<sect1 xml:id="testing-mockingsubflows">
<title>Mocking a subflow</title>
<para>
To test calling a subflow, register a mock implementation of the subflow that asserts input was passed in correctly and
returns the correct outcome for your test scenario.
</para>
<programlisting language="java"><![CDATA[
public void testBookHotel() {
setCurrentState("reviewHotel");
Hotel hotel = new Hotel();
hotel.setId(1L);
hotel.setName("Jameson Inn");
getFlowScope().put("hotel", hotel);
setCurrentState("reviewHotel");
getFlowDefinitionRegistry().registerFlowDefinition(createMockBookingSubflow());
Hotel hotel = new Hotel();
hotel.setId(1L);
hotel.setName("Jameson Inn");
getFlowScope().put("hotel", hotel);
MockExternalContext context = new MockExternalContext();
context.setEventId("book");
resumeFlow(context);
getFlowDefinitionRegistry().registerFlowDefinition(createMockBookingSubflow());
// verify flow ends on 'bookingConfirmed'
assertFlowExecutionEnded();
assertFlowExecutionOutcomeEquals("finish");
MockExternalContext context = new MockExternalContext();
context.setEventId("book");
resumeFlow(context);
// verify flow ends on 'bookingConfirmed'
assertFlowExecutionEnded();
assertFlowExecutionOutcomeEquals("finish");
}
public Flow createMockBookingSubflow() {
Flow mockBookingFlow = new Flow("booking");
mockBookingFlow.setInputMapper(new Mapper() {
public MappingResults map(Object source, Object target) {
// assert that 1L was passed in as input
assertEquals(1L, ((AttributeMap) source).get("hotelId"));
return null;
}
});
// immediately return the bookingConfirmed outcome so the caller can respond
new EndState(mockBookingFlow, "bookingConfirmed");
return mockBookingFlow;
Flow mockBookingFlow = new Flow("booking");
mockBookingFlow.setInputMapper(new Mapper() {
public MappingResults map(Object source, Object target) {
// assert that 1L was passed in as input
assertEquals(1L, ((AttributeMap) source).get("hotelId"));
return null;
}
});
// immediately return the bookingConfirmed outcome so the caller can respond
new EndState(mockBookingFlow, "bookingConfirmed");
return mockBookingFlow;
}]]>
</programlisting>
</sect1>

72
src/reference/upgrade-guide.xml
View File

@@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="upgrade-guide">
<chapter xml:id="upgrade-guide"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Upgrading from 1.0</title>
<sect1 id="upgrade-guide-introduction">
<sect1 xml:id="upgrade-guide-introduction">
<title>Introduction</title>
<para>
This chapter shows you how to upgrade existing Web Flow 1 application to Web Flow 2.
</para>
</sect1>
<sect1 id="upgrade-guide-definition-language">
<sect1 xml:id="upgrade-guide-definition-language">
<title>Flow Definition Language</title>
<para>
The core concepts behind the flow definition language have not changed between Web Flow 1 and 2.
@@ -18,7 +22,7 @@
These changes allow for the language to be both more concise and expressive.
A complete list of <link linkend="field-mappings">mapping changes</link> is available as an appendix.
</para>
<sect2 id="upgrade-guide-definition-language-tool">
<sect2 xml:id="upgrade-guide-definition-language-tool">
<title>Flow Definition Updater Tool</title>
<para>
An automated tool is available to aid in the conversion of existing 1.x flows to the new 2.x style.
@@ -28,7 +32,7 @@
</para>
<para>
The conversion tool requires spring-webflow.jar, spring-core.jar and an XSLT 1.0 engine.
<ulink url="http://saxon.sourceforge.net/">Saxon 6.5.5</ulink> is recommended.
<link xl:href="http://saxon.sourceforge.net/">Saxon 6.5.5</link> is recommended.
</para>
<para>
The tool can be run from the command line with the following command.
@@ -39,9 +43,9 @@
<programlisting>
java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
</programlisting>
<sect3 id="upgrade-guide-definition-language-tool-warnings">
<sect3 xml:id="upgrade-guide-definition-language-tool-warnings">
<title>Flow Definition Updater Tool Warnings</title>
<sect4 id="upgrade-guide-definition-language-tool-warnings-argument-parameter-type">
<sect4 xml:id="upgrade-guide-definition-language-tool-warnings-argument-parameter-type">
<title>argument parameter-type no longer supported</title>
<para>
Bean actions have been deprecated in favor of EL based evaluate expressions.
@@ -49,7 +53,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
A side effect of this change is that method arguments must be of the correct type before invoking the action.
</para>
</sect4>
<sect4 id="upgrade-guide-definition-language-tool-warnings-inline-flow">
<sect4 xml:id="upgrade-guide-definition-language-tool-warnings-inline-flow">
<title>inline-flow is no longer supported</title>
<para>
Inline flows are no longer supported.
@@ -57,21 +61,21 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
The inline flow's content has been converted for your convenience.
</para>
</sect4>
<sect4 id="upgrade-guide-definition-language-tool-warnings-mapping-target-collection">
<sect4 xml:id="upgrade-guide-definition-language-tool-warnings-mapping-target-collection">
<title>mapping target-collection is no longer supported</title>
<para>
Output mappings can no longer add an item to a collection.
Only assignment is supported.
</para>
</sect4>
<sect4 id="upgrade-guide-definition-language-tool-warnings-var-bean">
<sect4 xml:id="upgrade-guide-definition-language-tool-warnings-var-bean">
<title>var bean is no longer supported</title>
<para>
The var bean attribute is no longer needed.
All spring beans can be resolved via EL.
All spring beans can be resolved via EL.
</para>
</sect4>
<sect4 id="upgrade-guide-definition-language-tool-warnings-var-scope">
<sect4 xml:id="upgrade-guide-definition-language-tool-warnings-var-scope">
<title>var scope is no longer supported</title>
<para>
The var element will place all variable into flow scope.
@@ -80,26 +84,26 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
</sect4>
</sect3>
</sect2>
<sect2 id="upgrade-guide-definition-language-el">
<sect2 xml:id="upgrade-guide-definition-language-el">
<title>EL Expressions</title>
<para>
EL expressions are used heavily throughout the flow definition language.
Many of the attributes that appear to be plain text are actually interpreted as EL.
The standard EL delimiters (either ${} or #{} in Web Flow 2.0 or just #{} in Web Flow 2.1) are not necessary and will often cause an exception if they are included.
The standard EL delimiters (either ${} or #{} in Web Flow 2.0 or just #{} in Web Flow 2.1) are not necessary and will often cause an exception if they are included.
</para>
<para>
EL delimiters should be removed where necessary by the updater tool.
</para>
</sect2>
</sect1>
<sect1 id="upgrade-guide-webflow-config">
<sect1 xml:id="upgrade-guide-webflow-config">
<title>Web Flow Configuration</title>
<para>
In Web Flow 1 there were two options available for configuring Web Flow, one using standard spring bean XML and the other using the <code>webflow-config-1.0</code> schema.
The schema configuration option simplifies the configuration process by keeping long internal class names hidden and enabling contextual auto-complete.
The schema configuration option is the only way to configure Web Flow 2.
</para>
<sect2 id="upgrade-guide-webflow-config-beans">
<sect2 xml:id="upgrade-guide-webflow-config-beans">
<title>Web Flow Bean Configuration</title>
<para>
The <code>FactoryBean</code> bean XML configuration method used in Web Flow 1 is no longer supported.
@@ -108,7 +112,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
Continue reading Web Flow Schema Configuration for details.
</para>
</sect2>
<sect2 id="upgrade-guide-webflow-config-schema">
<sect2 xml:id="upgrade-guide-webflow-config-schema">
<title>Web Flow Schema Configuration</title>
<para>
The <code>webflow-config</code> configuration schema has also changed slightly from version 1 to 2.
@@ -125,7 +129,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
http://www.springframework.org/schema/webflow-config
http://www.springframework.org/schema/webflow-config/spring-webflow-config-2.3.xsd">
]]></programlisting>
<sect3 id="upgrade-guide-webflow-config-schema-executor">
<sect3 xml:id="upgrade-guide-webflow-config-schema-executor">
<title>flow-executor</title>
<para>
The flow executor is the core Web Flow configuration element.
@@ -135,7 +139,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
<webflow:flow-executor id="flowExecutor" />
]]></programlisting>
</sect3>
<sect3 id="upgrade-guide-webflow-config-schema-listeners">
<sect3 xml:id="upgrade-guide-webflow-config-schema-listeners">
<title>flow-execution-listeners</title>
<para>
Flow execution listeners are also defined in the flow executor.
@@ -152,7 +156,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
class="org.springframework.webflow.security.SecurityFlowExecutionListener" />
]]></programlisting>
</sect3>
<sect3 id="upgrade-guide-webflow-config-schema-registry">
<sect3 xml:id="upgrade-guide-webflow-config-schema-registry">
<title>flow-registry</title>
<para>
The <code>flow-registry</code> contains a set of <code>flow-location</code>s.
@@ -166,7 +170,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
]]></programlisting>
</sect3>
</sect2>
<sect2 id="upgrade-guide-java-controller">
<sect2 xml:id="upgrade-guide-java-controller">
<title>Flow Controller</title>
<para>
The package name for flow controllers has changed from <code>org.springframework.webflow.executor.mvc.FlowController</code> and is now <code>org.springframework.webflow.mvc.servlet.FlowController</code> for Servlet MVC requests.
@@ -174,7 +178,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
They will need to be updated in the bean definitions.
</para>
</sect2>
<sect2 id="upgrade-guide-java-url-handler">
<sect2 xml:id="upgrade-guide-java-url-handler">
<title>Flow URL Handler</title>
<para>
The default URL handler has changed in Web Flow 2.
@@ -190,7 +194,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
</bean>
]]></programlisting>
</sect2>
<sect2 id="upgrade-guide-webflow-config-view-resolver">
<sect2 xml:id="upgrade-guide-webflow-config-view-resolver">
<title>View Resolution</title>
<para>
Web Flow 2 by default will both select and render views.
@@ -198,7 +202,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
</para>
<para>
In order for version 1 flows to work in Web Flow 2 the default view resolver must be overridden.
A common use case is to use <ulink url="http://tiles.apache.org/">Apache Tiles</ulink> for view resolution.
A common use case is to use <link xl:href="http://tiles.apache.org/">Apache Tiles</link> for view resolution.
The following configuration will replace the default view resolver with a Tiles view resolver.
The <code>tilesViewResolver</code> in this example can be replaced with any other view resolver.
</para>
@@ -208,7 +212,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
...
</webflow:flow-registry>
<webflow:flow-builder-services id="flowBuilderServices"
<webflow:flow-builder-services id="flowBuilderServices"
view-factory-creator="viewFactoryCreator"/>
<bean id="viewFactoryCreator" class="org.springframework.webflow.mvc.builder.MvcViewFactoryCreator">
@@ -225,9 +229,9 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
]]></programlisting>
</sect2>
</sect1>
<sect1 id="upgrade-guide-webflow-concepts">
<sect1 xml:id="upgrade-guide-webflow-concepts">
<title>New Web Flow Concepts</title>
<sect2 id="upgrade-guide-webflow-concepts-binding">
<sect2 xml:id="upgrade-guide-webflow-concepts-binding">
<title>Automatic Model Binding</title>
<para>
Web Flow 1 required Spring MVC based flows to manually call <code>FormAction</code> methods, notably:
@@ -236,7 +240,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
Please see the <link linkend="view-model">Binding to a Model</link> section for details.
</para>
</sect2>
<sect2 id="upgrade-guide-webflow-concepts-el-v-ognl">
<sect2 xml:id="upgrade-guide-webflow-concepts-el-v-ognl">
<title>OGNL vs Spring EL</title>
<para>
Web Flow 1 used OGNL exclusively for expressions within the flow definitions.
@@ -246,7 +250,7 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
Please see <xref linkend="el"/> for details.
</para>
</sect2>
<sect2 id="upgrade-guide-webflow-concepts-flash-scope">
<sect2 xml:id="upgrade-guide-webflow-concepts-flash-scope">
<title>Flash Scope</title>
<para>
Flash scope in Web Flow 1 lived across the current request and into the next request.
@@ -255,14 +259,14 @@ java org.springframework.webflow.upgrade.WebFlowUpgrader flow-to-upgrade.xml
This makes flashScope semantics in Web Flow consistent with other web frameworks.
</para>
</sect2>
<sect2 id="upgrade-guide-webflow-concepts-jsf">
<sect2 xml:id="upgrade-guide-webflow-concepts-jsf">
<title>JSF</title>
<para>
Web Flow 2 offers significantly improved integration with JSF.
Please see <xref linkend="spring-faces"/> for details.
</para>
</sect2>
<sect2 id="upgrade-guide-webflow-concepts-redirects">
<sect2 xml:id="upgrade-guide-webflow-concepts-redirects">
<title>External Redirects</title>
<para>
External redirects in Web Flow 1 were always considered context relative.

208
src/reference/views.xml
View File

@@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="views">
<chapter xml:id="views"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>Rendering views</title>
<sect1 id="views-introduction">
<sect1 xml:id="views-introduction">
<title>Introduction</title>
<para>
This chapter shows you how to use the <code>view-state</code> element to render views within a flow.
</para>
</sect1>
<sect1 id="view-convention">
<sect1 xml:id="view-convention">
<title>Defining view states</title>
<para>
Use the <code>view-state</code> element to define a step of the flow that renders a view and waits for a user event to resume:
@@ -38,14 +42,14 @@
<caption>
<para>Flow Packaging</para>
</caption>
</mediaobject>
</mediaobject>
</sect1>
<sect1 id="view-explicit">
<sect1 xml:id="view-explicit">
<title>Specifying view identifiers</title>
<para>
Use the <code>view</code> attribute to specify the id of the view to render explicitly.
</para>
<sect2 id="view-explicit-flowrelative">
<sect2 xml:id="view-explicit-flowrelative">
<title>Flow relative view ids</title>
<para>
The view id may be a relative path to view resource in the flow's working directory:
@@ -54,7 +58,7 @@
<view-state id="enterBookingDetails" view="bookingDetails.xhtml">]]>
</programlisting>
</sect2>
<sect2 id="view-explicit-absolute">
<sect2 xml:id="view-explicit-absolute">
<title>Absolute view ids</title>
<para>
The view id may be a absolute path to a view resource in the webapp root directory:
@@ -63,7 +67,7 @@
<view-state id="enterBookingDetails" view="/WEB-INF/hotels/booking/bookingDetails.xhtml">]]>
</programlisting>
</sect2>
<sect2 id="view-explicit-logical">
<sect2 xml:id="view-explicit-logical">
<title>Logical view ids</title>
<para>
With some view frameworks, such as Spring MVC's view framework, the view id may also be a logical identifier resolved by the framework:
@@ -76,7 +80,7 @@
</para>
</sect2>
</sect1>
<sect1 id="view-scope">
<sect1 xml:id="view-scope">
<title>View scope</title>
<para>
A view-state allocates a new <code>viewScope</code> when it enters.
@@ -84,7 +88,7 @@
This scope is useful for manipulating objects over a series of requests from the same view, often Ajax requests.
A view-state destroys its viewScope when it exits.
</para>
<sect2 id="view-scope-var">
<sect2 xml:id="view-scope-var">
<title>Allocating view variables</title>
<para>
Use the <code>var</code> tag to declare a view variable.
@@ -93,8 +97,8 @@
<programlisting language="xml"><![CDATA[
<var name="searchCriteria" class="com.mycompany.myapp.hotels.SearchCriteria" />]]>
</programlisting>
</sect2>
<sect2 id="view-scope-actions">
</sect2>
<sect2 xml:id="view-scope-actions">
<title>Assigning a viewScope variable</title>
<para>
Use the <code>on-render</code> tag to assign a variable from an action result before the view renders:
@@ -105,11 +109,11 @@
</on-render>]]>
</programlisting>
</sect2>
<sect2 id="view-scope-ajax">
<sect2 xml:id="view-scope-ajax">
<title>Manipulating objects in view scope</title>
<para>
Objects in view scope are often manipulated over a series of requests from the same view.
The following example pages through a search results list.
The following example pages through a search results list.
The list is updated in view scope before each render.
Asynchronous event handlers modify the current data page, then request re-rendering of the search results fragment.
</para>
@@ -121,17 +125,17 @@
</on-render>
<transition on="next">
<evaluate expression="searchCriteria.nextPage()" />
<render fragments="searchResultsFragment" />
<render fragments="searchResultsFragment" />
</transition>
<transition on="previous">
<evaluate expression="searchCriteria.previousPage()" />
<render fragments="searchResultsFragment" />
<render fragments="searchResultsFragment" />
</transition>
</view-state>]]>
</programlisting>
</programlisting>
</sect2>
</sect1>
<sect1 id="view-on-render">
<sect1 xml:id="view-on-render">
<title>Executing render actions</title>
<para>
Use the <code>on-render</code> element to execute one or more actions before view rendering.
@@ -143,7 +147,7 @@
</on-render>]]>
</programlisting>
</sect1>
<sect1 id="view-model">
<sect1 xml:id="view-model">
<title>Binding to a model</title>
<para>
Use the <code>model</code> attribute to declare a model object the view binds to.
@@ -156,7 +160,7 @@
<programlisting language="xml"><![CDATA[
<view-state id="enterBookingDetails" model="booking">]]>
</programlisting>
<para>
<para>
The model may be an object in any accessible scope, such as <code>flowScope</code> or <code>viewScope</code>.
Specifying a <code>model</code> triggers the following behavior when a view event occurs:
</para>
@@ -169,40 +173,40 @@
If model binding fails, the view is re-rendered to allow the user to revise their edits.
</para>
</sect1>
<sect1 id="view-type-conversion">
<sect1 xml:id="view-type-conversion">
<title>Performing type conversion</title>
<para>
When request parameters are used to populate the model (commonly referred to as data binding), type conversion is required to parse String-based request parameter values before setting target model properties.
Default type conversion is available for many common Java types such as numbers, primitives, enums, and Dates.
Users also have the ability to register their own type conversion logic for user-defined types, and to override the default Converters.
</para>
<sect2 id="converter-options">
<sect2 xml:id="converter-options">
<title>Type Conversion Options</title>
<para>
Starting with version 2.1 Spring Web Flow uses the <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/validation.html#core-convert">type conversion</ulink> and <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/validation.html#format">formatting</ulink> system introduced in Spring 3 for nearly all type conversion needs.
Previously Web Flow applications used a type conversion mechanism that was different from the one in Spring MVC, which relied on the <code>java.beans.PropertyEditor</code> abstraction.
Starting with version 2.1 Spring Web Flow uses the <link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/validation.html#core-convert">type conversion</link> and <link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/validation.html#format">formatting</link> system introduced in Spring 3 for nearly all type conversion needs.
Previously Web Flow applications used a type conversion mechanism that was different from the one in Spring MVC, which relied on the <code>java.beans.PropertyEditor</code> abstraction.
Spring 3 offers a modern type conversion alternative to PropertyEditors that was actually influenced by Web Flow's own type conversion system.
Hence Web Flow users should find it natural to work with the new Spring 3 type conversion.
Another obvious and very important benefit of this change is that a single type conversion mechanism can now be used across Spring MVC And Spring Web Flow.
Another obvious and very important benefit of this change is that a single type conversion mechanism can now be used across Spring MVC And Spring Web Flow.
</para>
</sect2>
<sect2 id="converter-upgrade-to-spring-3">
<sect2 xml:id="converter-upgrade-to-spring-3">
<title>Upgrading to Spring 3 Type Conversion And Formatting</title>
<para>
What does this practically mean for existing applications?
Existing applications are likely registering their own converters of type <code>org.springframework.binding.convert.converters.Converter</code> through a sub-class of <code>DefaultConversionService</code> available in Spring Binding.
Those converters can continue to be registered as before.
They will be adapted as Spring 3 <code>GenericConverter</code> types and registered with a Spring 3 <code>org.springframework.core.convert.ConversionService</code> instance.
They will be adapted as Spring 3 <code>GenericConverter</code> types and registered with a Spring 3 <code>org.springframework.core.convert.ConversionService</code> instance.
In other words existing converters will be invoked through Spring's type conversion service.
</para>
<para>
The only exception to this rule are named converters, which can be referenced from a <code>binding</code> element in a <code>view-state</code>:
<programlisting language="java"><![CDATA[
public class ApplicationConversionService extends DefaultConversionService {
public class ApplicationConversionService extends DefaultConversionService {
public ApplicationConversionService() {
addDefaultConverters();
addDefaultAliases();
addConverter("customConverter", new CustomConverter());
addConverter("customConverter", new CustomConverter());
}
}]]>
</programlisting>
@@ -217,7 +221,7 @@ public class ApplicationConversionService extends DefaultConversionService {
Therefore such converters will not be adapted and will continue to work as before, i.e. will not involve the Spring 3 type conversion.
However, this mechanism is deprecated and applications are encouraged to favor Spring 3 type conversion and formatting features.
</para>
<para>
<para>
Also note that the existing Spring Binding <code>DefaultConversionService</code> no longer registers any default converters.
Instead Web Flow now relies on the default type converters and formatters in Spring 3.
</para>
@@ -226,7 +230,7 @@ public class ApplicationConversionService extends DefaultConversionService {
Although existing applications will work without any changes, we encourage moving towards unifying the type conversion needs of Spring MVC and Spring Web Flow parts of applications.
</para>
</sect2>
<sect2 id="converter-configuration">
<sect2 xml:id="converter-configuration">
<title>Configuring Type Conversion and Formatting</title>
<para>
In Spring MVC an instance of a <code>FormattingConversionService</code> is created automatically through the custom MVC namespace:
@@ -236,9 +240,9 @@ public class ApplicationConversionService extends DefaultConversionService {
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<mvc:annotation-driven/>
@@ -272,8 +276,8 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
protected void installFormatters(FormatterRegistry registry) {
// ...
}
}
}
]]>
</programlisting>
Configure it for use in Spring MVC:
@@ -283,14 +287,14 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<mvc:annotation-driven conversion-service="applicationConversionService" />
<!--
<!--
Alternatively if you prefer annotations for DI:
1. Add @Component to the factory bean.
2. Add a component-scan element (from the context custom namespace) here.
@@ -298,15 +302,15 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
-->
<bean id="applicationConversionService" class="somepackage.ApplicationConversionServiceFactoryBean">
]]>
</programlisting>
Connection the Web Flow <code>DefaultConversionService</code> to the same "applicationConversionService" bean used in Spring MVC:
<programlisting language="xml"><![CDATA[
<webflow:flow-registry id="flowRegistry" flow-builder-services="flowBuilderServices" ... />
<webflow:flow-builder-services id="flowBuilderServices" conversion-service="defaultConversionService" ... />
<bean id="defaultConversionService" class="org.springframework.binding.convert.service.DefaultConversionService">
<constructor-arg ref="applicationConversionSevice"/>
</bean>]]>
@@ -316,20 +320,20 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
Register existing Spring Binding <code>Converter</code> types through the "defaultConversionService".
</para>
</sect2>
<sect2 id="converter-working-with">
<sect2 xml:id="converter-working-with">
<title>Working With Spring 3 Type Conversion And Formatting</title>
<para>
An important concept to understand is the difference between type converters and formatters.
</para>
<para>
<para>
Type converters in Spring 3, provided in <code>org.springframework.core</code>, are for general-purpose type conversion between any two object types.
In addition to the most simple <code>Converter</code> type, two other interfaces are <code>ConverterFactory</code> and <code>GenericConverter</code>.
</para>
<para>
<para>
Formatters in Spring 3, provided in <code>org.springframework.context</code>, have the more specialized purpose of representing Objects as Strings.
The <code>Formatter</code> interface extends the <code>Printer</code> and <code>Parser</code> interfaces for converting an Object to a String and turning a String into an Object.
</para>
<para>
<para>
Web developers will find the <code>Formatter</code> interface most relevant because it fits the needs of web applications for type conversion.
<note>
<para>
@@ -339,30 +343,30 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
</note>
</para>
</sect2>
<sect2 id="converter-formatting-annotations">
<sect2 xml:id="converter-formatting-annotations">
<title>Formatting Annotations</title>
<para>
One of the best features of the new type conversion is the ability to use annotations for a better control over formatting in a concise manner.
Annotations can be placed on model attributes and on arguments of @Controller methods that are mapped to requests.
Out of the box Spring provides two annotations <code>NumberFormat</code> and <code>DateTimeFormat</code> but you can create your own and have them registered along with the associated formatting logic.
You can see examples of the <code>DateTimeFormat</code> annotation in the <ulink url="https://src.springframework.org/svn/spring-samples/travel">Spring Travel</ulink> and in the <ulink url="https://src.springframework.org/svn/spring-samples/petcare">Petcare</ulink> along with other samples in the <ulink url="https://src.springframework.org/svn/spring-samples">Spring Samples</ulink> repository.
You can see examples of the <code>DateTimeFormat</code> annotation in the <link xl:href="https://src.springframework.org/svn/spring-samples/travel">Spring Travel</link> and in the <link xl:href="https://src.springframework.org/svn/spring-samples/petcare">Petcare</link> along with other samples in the <link xl:href="https://src.springframework.org/svn/spring-samples">Spring Samples</link> repository.
</para>
</sect2>
<sect2 id="converter-dates">
<sect2 xml:id="converter-dates">
<title>Working With Dates</title>
<para>
The <code>DateTimeFormat</code> annotation implies use of <ulink url="http://joda-time.sourceforge.net/">Joda Time</ulink>.
The <code>DateTimeFormat</code> annotation implies use of <link xl:href="http://joda-time.sourceforge.net/">Joda Time</link>.
If that is present on the classpath the use of this annotation is enabled automatically.
By default neither Spring MVC nor Web Flow register any other date formatters or converters.
Therefore it is important for applications to register a custom formatter to specify the default way for printing and parsing dates.
The <code>DateTimeFormat</code> annotation on the other hand provides more fine-grained control where it is necessary to deviate from the default.
</para>
<para>
For more information on working with Spring 3 type conversion and formatting please refer to the relevant sections of the <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/index.html">Spring documentation</ulink>.
<para>
For more information on working with Spring 3 type conversion and formatting please refer to the relevant sections of the <link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/index.html">Spring documentation</link>.
</para>
</sect2>
</sect1>
<sect1 id="view-bind">
<sect1 xml:id="view-bind">
<title>Suppressing binding</title>
<para>
Use the <code>bind</code> attribute to suppress model binding and validation for particular view events.
@@ -374,8 +378,8 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
<transition on="cancel" to="bookingCancelled" bind="false" />
</view-state>]]>
</programlisting>
</sect1>
<sect1 id="view-binder">
</sect1>
<sect1 xml:id="view-binder">
<title>Specifying bindings explicitly</title>
<para>
Use the <code>binder</code> element to configure the exact set of model bindings usable by the view.
@@ -400,13 +404,13 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
</para>
<para>
Each binding may also apply a converter to format the model property value for display in a custom manner.
If no converter is specified, the default converter for the model property's type will be used.
If no converter is specified, the default converter for the model property's type will be used.
</para>
<programlisting language="xml"><![CDATA[
<view-state id="enterBookingDetails" model="booking">
<binder>
<binding property="checkinDate" converter="shortDate" />
<binding property="checkoutDate" converter="shortDate" />
<binding property="checkoutDate" converter="shortDate" />
<binding property="creditCard" />
<binding property="creditCardName" />
<binding property="creditCardExpiryMonth" />
@@ -418,7 +422,7 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
]]>
</programlisting>
<para>
In the example above, the <code>shortDate</code> converter is bound to the
In the example above, the <code>shortDate</code> converter is bound to the
<code>checkinDate</code> and <code>checkoutDate</code> properties.
Custom converters may be registered with the application's ConversionService.
</para>
@@ -445,19 +449,19 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
If one or more blank input values are bound, validation errors will be generated and the view will re-render with those errors.
</para>
</sect1>
<sect1 id="view-validate">
<sect1 xml:id="view-validate">
<title>Validating a model</title>
<para>
Model validation is driven by constraints specified against a model object.
Web Flow supports enforcing such constraints programatically as well as
Web Flow supports enforcing such constraints programatically as well as
declaratively with JSR-303 Bean Validation annotations.
</para>
<sect2 id="view-validation-jsr303">
<sect2 xml:id="view-validation-jsr303">
<title>JSR-303 Bean Validation</title>
<para>
Web Flow provides built-in support for the JSR-303 Bean Validation API
building on equivalent support available in Spring MVC.
To enable JSR-303 validation configure the flow-builder-services with
Web Flow provides built-in support for the JSR-303 Bean Validation API
building on equivalent support available in Spring MVC.
To enable JSR-303 validation configure the flow-builder-services with
Spring MVC's <code>LocalValidatorFactoryBean</code>:
</para>
<programlisting language="xml">
@@ -470,17 +474,17 @@ public class ApplicationConversionServiceFactoryBean extends FormattingConversio
<para>
With the above in place, the configured validator will be applied to
all model attributes after data binding.
all model attributes after data binding.
</para>
<para>
Note that JSR-303 bean validation and validation by convention
Note that JSR-303 bean validation and validation by convention
(explained in the next section) are not mutually exclusive.
In other words Web Flow will apply all available validation
In other words Web Flow will apply all available validation
mechanisms.
</para>
<sect3 id="view-validation-jsr303-partial">
<sect3 xml:id="view-validation-jsr303-partial">
<title>Partial Validation</title>
<para>
JSR-303 Bean Validation supports partial validation via groups. For example:
@@ -519,7 +523,7 @@ private String name;
</sect3>
</sect2>
<sect2 id="view-validation-programmatic">
<sect2 xml:id="view-validation-programmatic">
<title>Programmatic validation</title>
<para>
There are two ways to perform model validation programatically.
@@ -527,7 +531,7 @@ private String name;
The second is to implement an external <code>Validator</code>.
Both ways provide you with a <code>ValidationContext</code> to record error messages and access information about the current user.
</para>
<sect3 id="view-validation-programmatic-validate-method">
<sect3 xml:id="view-validation-programmatic-validate-method">
<title>Implementing a model validate method</title>
<para>
Defining validation logic in your model object is the simplest way to validate its state.
@@ -540,7 +544,7 @@ public class Booking {
private Date checkinDate;
private Date checkoutDate;
...
public void validateEnterBookingDetails(ValidationContext context) {
MessageContext messages = context.getMessageContext();
if (checkinDate.before(today())) {
@@ -566,11 +570,11 @@ public class Booking {
</programlisting>
</para>
<para>
Any number of validation methods are defined. Generally, a flow edits a model over a series of views. In that case, a validate method would be defined
Any number of validation methods are defined. Generally, a flow edits a model over a series of views. In that case, a validate method would be defined
for each view-state where validation needs to run.
</para>
</sect3>
<sect3 id="view-validation-programmatic-validator">
<sect3 xml:id="view-validation-programmatic-validator">
<title>Implementing a Validator</title>
<para>
The second way is to define a separate object, called a <emphasis>Validator</emphasis>, which validates your model object.
@@ -607,7 +611,7 @@ public class BookingValidator {
Then, anytime the <code>booking</code> model needs to be validated, this <code>bookingValidator</code> instance would be invoked for you.
</para>
</sect3>
<sect3 id="default-validate-method">
<sect3 xml:id="default-validate-method">
<title>Default validate method</title>
<para>
A <emphasis>Validator</emphasis> class can also define a method called <code>validate</code> not associated (by convention) with any specific view-state.
@@ -617,7 +621,7 @@ public class BookingValidator {
public class BookingValidator {
public void validate(Booking booking, ValidationContext context) {
//...
}
}
}]]>
</programlisting>
<para>
@@ -636,12 +640,12 @@ public class BookingValidator {
}]]>
</programlisting>
<para>
In above code sample the method <code>validateEnterBookingDetails</code> will be called first.
In above code sample the method <code>validateEnterBookingDetails</code> will be called first.
The default <code>validate</code> method will be called next.
</para>
</sect3>
</sect2>
<sect2 id="view-validation-context">
<sect2 xml:id="view-validation-context">
<title>ValidationContext</title>
<para>
A ValidationContext allows you to obtain a <code>MessageContext</code> to record messages during validation.
@@ -649,9 +653,9 @@ public class BookingValidator {
This information can be used to customize validation logic based on what button or link was activated in the UI, or who is authenticated.
See the API Javadocs for <code>ValidationContext</code> for more information.
</para>
</sect2>
</sect2>
</sect1>
<sect1 id="view-validation-suppression">
<sect1 xml:id="view-validation-suppression">
<title>Suppressing validation</title>
<para>
Use the <code>validate</code> attribute to suppress model validation for particular view events:
@@ -666,7 +670,7 @@ public class BookingValidator {
In this example, data binding will still occur on <code>back</code> but validation will be suppressed.
</para>
</sect1>
<sect1 id="view-transitions">
<sect1 xml:id="view-transitions">
<title>Executing view transitions</title>
<para>
Define one or more <code>transition</code> elements to handle user events that may occur on the view.
@@ -677,7 +681,7 @@ public class BookingValidator {
<para>
Implementing view transitions is illustrated in the following sections.
</para>
<sect2 id="transition-actions">
<sect2 xml:id="transition-actions">
<title>Transition actions</title>
<para>
A view-state transition can execute one or more actions before executing.
@@ -712,10 +716,10 @@ public class BookingAction {
<para>
When there is more than one action defined on a transition, if one returns an error result the remaining actions in the set will <emphasis>not</emphasis> be executed.
If you need to ensure one transition action's result cannot impact the execution of another, define a single transition action that invokes a method that encapsulates all the action logic.
</para>
</para>
</note>
</sect2>
<sect2 id="event-handlers-global">
<sect2 xml:id="event-handlers-global">
<title>Global transitions</title>
<para>
Use the flow's <code>global-transitions</code> element to create transitions that apply across all views.
@@ -727,8 +731,8 @@ public class BookingAction {
<transition on="logout" to="logout" />
</global-transitions>]]>
</programlisting>
</sect2>
<sect2 id="simple-event-handlers">
</sect2>
<sect2 xml:id="simple-event-handlers">
<title>Event handlers</title>
<para>
From a view-state, transitions without targets can also be defined. Such transitions are called "event handlers":
@@ -743,7 +747,7 @@ public class BookingAction {
They simply execute their actions and re-render the current view or one or more fragments of the current view.
</para>
</sect2>
<sect2 id="event-handlers-render">
<sect2 xml:id="event-handlers-render">
<title>Rendering fragments</title>
<para>
Use the <code>render</code> element within a transition to request partial re-rendering of the current view after handling the event:
@@ -751,7 +755,7 @@ public class BookingAction {
<programlisting language="xml"><![CDATA[
<transition on="next">
<evaluate expression="searchCriteria.nextPage()" />
<render fragments="searchResultsFragment" />
<render fragments="searchResultsFragment" />
</transition>]]>
</programlisting>
<para>
@@ -763,7 +767,7 @@ public class BookingAction {
</para>
</sect2>
</sect1>
<sect1 id="view-messages">
<sect1 xml:id="view-messages">
<title>Working with messages</title>
<para>
Spring Web Flow's <code>MessageContext</code> is an API for recording messages during the course of flow executions.
@@ -772,7 +776,7 @@ public class BookingAction {
Three distinct message severities are provided: <code>info</code>, <code>warning</code>, and <code>error</code>.
In addition, a convenient <code>MessageBuilder</code> exists for fluently constructing messages.
</para>
<sect2 id="plain-text-message">
<sect2 xml:id="plain-text-message">
<title>Adding plain text messages</title>
<programlisting language="java"><![CDATA[
MessageContext context = ...
@@ -785,18 +789,18 @@ context.addMessage(builder.info()
.defaultText("We have processed your reservation - thank you and enjoy your stay").build());]]>
</programlisting>
</sect2>
<sect2 id="plain-text-message-intl">
<sect2 xml:id="plain-text-message-intl">
<title>Adding internationalized messages</title>
<programlisting language="java"><![CDATA[
MessageContext context = ...
MessageBuilder builder = new MessageBuilder();
context.addMessage(builder.error().source("checkinDate").code("checkinDate.notFuture").build());
context.addMessage(builder.warn().source("smoking").code("notHealthy")
.resolvableArg("smoking").build());
.resolvableArg("smoking").build());
context.addMessage(builder.info().code("reservationConfirmation").build());]]>
</programlisting>
</sect2>
<sect2 id="message-bundles">
<sect2 xml:id="message-bundles">
<title>Using message bundles</title>
<para>
Internationalized messages are defined in message bundles accessed by a Spring <code>MessageSource</code>.
@@ -816,7 +820,7 @@ reservationConfirmation=We have processed your reservation - thank you and enjoy
<h:outputText value="#{resourceBundle.reservationConfirmation}" />]]>
</programlisting>
</sect2>
<sect2 id="message-generation">
<sect2 xml:id="message-generation">
<title>Understanding system generated messages</title>
<para>
There are several places where Web Flow itself will generate messages to display to the user.
@@ -851,7 +855,7 @@ typeMismatch=The {0} field is of the wrong type.
</programlisting>
</sect2>
</sect1>
<sect1 id="view-popup">
<sect1 xml:id="view-popup">
<title>Displaying popups</title>
<para>
Use the <code>popup</code> attribute to render a view in a modal popup dialog:
@@ -864,13 +868,13 @@ typeMismatch=The {0} field is of the wrong type.
Web Flow will send a response to the client requesting a redirect to the view from a popup, and the client will honor the request.
</para>
</sect1>
<sect1 id="view-backtracking">
<sect1 xml:id="view-backtracking">
<title>View backtracking</title>
<para>
By default, when you exit a view state and transition to a new view state, you can go back to the previous state using the browser back button.
These view state history policies are configurable on a per-transition basis by using the <code>history</code> attribute.
</para>
<sect2 id="history-discard">
<sect2 xml:id="history-discard">
<title>Discarding history</title>
<para>
Set the history attribute to <code>discard</code> to prevent backtracking to a view:
@@ -879,7 +883,7 @@ typeMismatch=The {0} field is of the wrong type.
<transition on="cancel" to="bookingCancelled" history="discard">]]>
</programlisting>
</sect2>
<sect2 id="history-invalidate">
<sect2 xml:id="history-invalidate">
<title>Invalidating history</title>
<para>
Set the history attribute to <code>invalidate</code> to prevent backtracking to a view as well all previously displayed views:
@@ -888,5 +892,5 @@ typeMismatch=The {0} field is of the wrong type.
<transition on="confirm" to="bookingConfirmed" history="invalidate">]]>
</programlisting>
</sect2>
</sect1>
</sect1>
</chapter>

114
src/reference/whatsnew.xml
View File

@@ -1,20 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="whatsnew">
<chapter xml:id="whatsnew"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>What's New</title>
<sect1 id="whatsnew-swf-240">
<sect1 xml:id="whatsnew-swf-240">
<title>Spring Web Flow 2.4</title>
<sect2 id="whatsnew-swf-jsf20">
<sect2 xml:id="whatsnew-swf-jsf20">
<title>Minimum JSF 2.0 Requirement</title>
<para>
Java ServerFaces version 1.2 and earlier are no longer supported by Spring Web Flow, if you have not done so already you will need to upgrade to JSF 2.0 or above.
Java ServerFaces version 1.2 and earlier are no longer supported by Spring Web Flow, if you have not done so already you will need to upgrade to JSF 2.0 or above.
In addition the Spring Faces components that were previously provided with JSF 1.2 for progressive AJAX enhancements have been removed in this release.
See <xref linkend="spring-faces-upgrade-from-swf23"/>.
</para>
</sect2>
<sect2 id="whatsnew-swf-jsf20-portlet">
<sect2 xml:id="whatsnew-swf-jsf20-portlet">
<title>Portlet API 2.0 and JSF 2.0 support</title>
<para>
The internal Portlet integration introduced in Spring Web Flow 2.2 has been upgraded for JSF 2.0 compatibility.
@@ -23,13 +27,13 @@
included as part of their Spring configuration. See <xref linkend="portlet-jsf"/>.
</para>
</sect2>
<sect2 id="whatsnew-swf-mvcflash">
<sect2 xml:id="whatsnew-swf-mvcflash">
<title>Saving Flow Output to Spring MVC Flash Scope</title>
<para>
Flow output can now be saved to Spring MVC Flash Scope for any <code>end-state</code> that issues an internal redirect. To enable this feature set <code>FlowHandlerAdapter.saveOutputToFlashScopeOnRedirect</code>. See <xref linkend="spring-mvc-flash-output"/>.
</para>
</sect2>
<sect2 id="whatsnew-partial-validation">
<sect2 xml:id="whatsnew-partial-validation">
<title>Partial JSR-303 Bean Validation</title>
<para>
Partial validation with JSR-303 Bean Validation groups is now supported through the validation-hints
@@ -37,48 +41,48 @@
</para>
</sect2>
</sect1>
<sect1 id="whatsnew-swf-230">
<sect1 xml:id="whatsnew-swf-230">
<title>Spring Web Flow 2.3</title>
<sect2 id="whatsnew-swf-embedded-flow">
<sect2 xml:id="whatsnew-swf-embedded-flow">
<title>Embedding A Flow On A Page</title>
<para>
By default Web Flow does a client-side redirect upon entering every view state.
That makes it impossible to embed a flow on a page or within a modal dialog and execute more than one view state without causing a full-page refresh.
That makes it impossible to embed a flow on a page or within a modal dialog and execute more than one view state without causing a full-page refresh.
Web Flow now supports launching a flow in "embedded" mode.
In this mode a flow can transition to other view states without a client-side redirect during Ajax requests.
See <xref linkend="spring-mvc-embedded-flow"/> and <xref linkend="spring-faces-embedded-mode"/>.
</para>
</sect2>
<sect2 id="whatsnew-jsr303">
<sect2 xml:id="whatsnew-jsr303">
<title>Support For JSR-303 Bean Validation</title>
<para>
Support for the JSR-303 Bean Validation API is now available building on equivalent support available in Spring MVC.
See <xref linkend="view-validate"/> for more details.
See <xref linkend="view-validate"/> for more details.
</para>
</sect2>
<sect2 id="whatsnew-pc-propagation">
<sect2 xml:id="whatsnew-pc-propagation">
<title>Flow-Managed Persistence Context Propagation</title>
<para>
Starting with Web Flow 2.3 a flow managed <code>PersistenceContext</code> is automatically extended (propagated) to sub-flows assuming the subflow also has the feature enabled as well.
See <xref linkend="flow-managed-persistence-propagation"/>.
</para>
</sect2>
<sect2 id="whatsnew-portlet-resource-requests">
<sect2 xml:id="whatsnew-portlet-resource-requests">
<title>Portlet 2.0 Resource Requests</title>
<para>
Support for Portlet 2.0 resource requests has now been added enabling Ajax requests with partial rendering.
URLs for such requests can be prepared with the <code>&lt;portlet:resourceURL&gt;</code> tag in JSP pages.
Server-side processing is similar to a combined an action and a render requests but combined in a single request.
Unlike a render request, the response from a resource request includes content from the target portlet only.
Unlike a render request, the response from a resource request includes content from the target portlet only.
</para>
</sect2>
<sect2 id="whatsnew-conversation-manager">
<sect2 xml:id="whatsnew-conversation-manager">
<title>Custom ConversationManager</title>
<para>
The <code>&lt;flow-execution-repository&gt;</code> element now provides a conversation-manager attribute accepting a reference to a ConversationManager instance.
The <code>&lt;flow-execution-repository&gt;</code> element now provides a conversation-manager attribute accepting a reference to a ConversationManager instance.
</para>
</sect2>
<sect2 id="whatsnew-redirect-in-same-state">
<sect2 xml:id="whatsnew-redirect-in-same-state">
<title>Redirect In Same State</title>
<para>
By default Web Flow does a client-side redirect when remaining in the same view state as long as the current request is not an Ajax request.
@@ -89,7 +93,7 @@
See <xref linkend="spring-faces-redirect-in-same-state"/>.
</para>
</sect2>
<sect2 id="whatsnew-samples">
<sect2 xml:id="whatsnew-samples">
<title>Samples</title>
<para>
The process for building the samples included with the distribution has been simplified.
@@ -117,26 +121,26 @@ mvn package
</sect2>
</sect1>
<sect1 id="whatsnew-swf-220">
<sect1 xml:id="whatsnew-swf-220">
<title>Spring Web Flow 2.2</title>
<sect2 id="whatsnew-jsf2">
<sect2 xml:id="whatsnew-jsf2">
<title>JSF 2 Support</title>
<sect3>
<title>Comprehensive JSF 2 Support</title>
<para>
Building on 2.1, Spring Web Flow version 2.2 adds support for core JSF 2 features
The following features that were not supported in 2.1 are now available:
partial state saving, JSF 2 resource request, handling, and JSF 2 Ajax requests.
At this point support for JSF 2 is considered
comprehensive although not covering every JSF 2 feature --
Building on 2.1, Spring Web Flow version 2.2 adds support for core JSF 2 features
The following features that were not supported in 2.1 are now available:
partial state saving, JSF 2 resource request, handling, and JSF 2 Ajax requests.
At this point support for JSF 2 is considered
comprehensive although not covering every JSF 2 feature --
excluded are mostly features that overlap with the core value Web Flow provides
such as those relating to navigation and state management.
such as those relating to navigation and state management.
</para>
<para>
See <xref linkend="spring-faces-webflow-config"/> for important configuration changes.
Note that partial state saving is only supported with Sun Mojarra 2.0.3 or later.
It is not yet supported with Apache MyFaces. This is due to the
fact MyFaces was not as easy to customize with regards to how component state is stored.
fact MyFaces was not as easy to customize with regards to how component state is stored.
We will work with Apache MyFaces to provide this support. In the mean time you will need to use
the <code>javax.faces.PARTIAL_STATE_SAVING</code> context parameter in <code>web.xml</code>
to disable partial state saving with Apache MyFaces.
@@ -145,42 +149,42 @@ mvn package
<sect3>
<title>Travel Sample With the PrimeFaces Components</title>
<para>
The main Spring Travel sample demonstrating Spring Web Flow and JSF support
The main Spring Travel sample demonstrating Spring Web Flow and JSF support
is now built on JSF 2 and components from the PrimeFaces component library.
Please check out the booking-faces sample in the distribution.
</para>
<para>
Additional samples can be found at the Spring Web Flow - Prime Faces
<ulink url="https://src.springframework.org/svn/spring-samples/webflow-primefaces-showcase">
Showcase</ulink>, an SVN repository within the
<ulink url="https://src.springframework.org/svn/spring-samples">spring-samples</ulink>
Additional samples can be found at the Spring Web Flow - Prime Faces
<link xl:href="https://src.springframework.org/svn/spring-samples/webflow-primefaces-showcase">
Showcase</link>, an SVN repository within the
<link xl:href="https://src.springframework.org/svn/spring-samples">spring-samples</link>
repository. Use these commands to check out and build:
</para>
<programlisting><![CDATA[svn co https://src.springframework.org/svn/spring-samples/webflow-primefaces-showcase
cd webflow-primefaces-showcase
mvn package
]]></programlisting>
]]></programlisting>
</sect3>
</sect2>
<sect2 id="whatsnew-sec">
<sect2 xml:id="whatsnew-sec">
<title>Spring Security Facelets Tag Library</title>
<para>
A new Spring Security tag library is available for use with with JSF 2.0 or with JSF 1.2 Facelets views.
It provides an &lt;authorize&gt; tag as well as several EL functions.
See <xref linkend="spring-faces-security-taglib"/> for more details.
It provides an &lt;authorize&gt; tag as well as several EL functions.
See <xref linkend="spring-faces-security-taglib"/> for more details.
</para>
</sect2>
<sect2 id="whatsnew-versions">
<sect2 xml:id="whatsnew-versions">
<title>Spring JavaScript Updates</title>
<sect3>
<title>Deprecated ResourcesServlet</title>
<para>
Starting with Spring 3.0.4, the Spring Framework includes
a replacement for the ResourcesServlet. Please see
a replacement for the ResourcesServlet. Please see
the Spring Framework documentation for details on the custom mvc namespace,
specifically the new
<ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html#mvc-static-resources">"resources"</ulink>
specifically the new
<link xl:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html#mvc-static-resources">"resources"</link>
element.
</para>
</sect3>
@@ -192,28 +196,28 @@ mvn package
<para>
Note that applications are generally encouraged to prepare their own custom
Dojo build for optimized performance depending on what parts of Dojo are
commonly used together. For examples see the
<ulink url="https://src.springframework.org/svn/spring-webflow/branches/spring-webflow-2.2-maintenance/spring-js-resources/scripts/dojo">scripts</ulink>
commonly used together. For examples see the
<link xl:href="https://src.springframework.org/svn/spring-webflow/branches/spring-webflow-2.2-maintenance/spring-js-resources/scripts/dojo">scripts</link>
used by Spring Web Flow to prepare its own custom Dojo build.
</para>
</sect3>
<sect3>
<title>Two Spring JS artifacts</title>
<para>
The <code>spring-js</code> artifact has been split in two -- the new artifact
The <code>spring-js</code> artifact has been split in two -- the new artifact
(<code>spring-js-resources</code>) contains client side resource (.js, .css, etc.) while
the existing artifact (<code>spring-js</code>) contains server-side Java code only.
</para>
<para>
Applications preparing their own custom Dojo build have an option now to
avoid including <code>spring-js-resources</code> and put <code>Spring.js</code> and
avoid including <code>spring-js-resources</code> and put <code>Spring.js</code> and
<code>Spring-Dojo.js</code> directly under the root of their web application.
</para>
</sect3>
<sect3>
<title>Client resources moved into META-INF/web-resources</title>
<para>
Bundled client resources (.js, .css, etc.)
Bundled client resources (.js, .css, etc.)
have been moved to <code>META-INF/web-resources</code> from their previous location
under <code>META-INF</code>. This change is transparent for applications but will result
in simpler and safer configuration when using the new resource handling
@@ -221,17 +225,17 @@ mvn package
</para>
</sect3>
</sect2>
<sect2 id="whatsnew-jsf-portlet">
<sect2 xml:id="whatsnew-jsf-portlet">
<title>JSF Portlet Support</title>
<sect3>
<title>Portlet API 2.0 and JSF 1.2 support</title>
<para>
In previous versions of Spring Web Flow support for JSF Portlets relied on
a Portlet Bridge for JSF implementation and was considered experimental.
Spring Web Flow 2.2 adds support for JSF Portlets based on its own internal
In previous versions of Spring Web Flow support for JSF Portlets relied on
a Portlet Bridge for JSF implementation and was considered experimental.
Spring Web Flow 2.2 adds support for JSF Portlets based on its own internal
Portlet integration targeting Portlet API 2.0 and JSF 1.2 environments.
See <xref linkend="portlet-jsf"/> for more details.
The Spring Web Flow Travel JSF Portlets sample has been successfully
The Spring Web Flow Travel JSF Portlets sample has been successfully
tested on the Apache Pluto portal container.
</para>
</sect3>