176 lines
6.9 KiB
XML
176 lines
6.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<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 xml:id="manual-overview">
|
|
<title>What this guide covers</title>
|
|
<para>
|
|
This guide covers all aspects of Spring Web Flow.
|
|
It covers implementing flows in end-user applications and working with the feature set.
|
|
It also covers extending the framework and the overall architectural model.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="system-requirements">
|
|
<title>What Web Flow requires to run</title>
|
|
<para>
|
|
Java 1.6 or higher.
|
|
</para>
|
|
<para>
|
|
Spring 3.2 or higher.
|
|
</para>
|
|
</sect1>
|
|
<sect1 xml:id="resources">
|
|
<title>Resources</title>
|
|
<para>
|
|
You can ask questions and interact on StackOverflow using the designated tags,
|
|
see <link xl:href="https://spring.io/questions">Spring at StackOverflow</link>.
|
|
</para>
|
|
<para>
|
|
Report bugs and make requests using the
|
|
<link xl:href="http://jira.spring.io">Spring Issue Tracker</link>.
|
|
</para>
|
|
<para>
|
|
Submit pull requests and work with the source code ,
|
|
see <link xl:href="https://github.com/spring-projects/spring-webflow">Web Flow on Github</link>.
|
|
</para>
|
|
</sect1>
|
|
<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 <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>
|
|
To access Web Flow jars from Maven Central, declare the following dependency in your pom (includes
|
|
transitive dependencies "spring-binding" and "spring-js"):
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<dependency>
|
|
<groupId>org.springframework.webflow</groupId>
|
|
<artifactId>spring-webflow</artifactId>
|
|
<version>x.y.z.RELEASE</version>
|
|
</dependency>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
If using JavaServer Faces, declare the following dependency in your pom (includes transitive dependencies "spring-binding", "spring-webflow" and "spring-js"):
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<dependency>
|
|
<groupId>org.springframework.webflow</groupId>
|
|
<artifactId>spring-faces</artifactId>
|
|
<version>x.y.z.RELEASE</version>
|
|
</dependency>
|
|
]]>
|
|
</programlisting>
|
|
</sect1>
|
|
<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:
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<url name="com.springsource.repository.bundles.release">
|
|
<ivy pattern="http://repository.springsource.com/ivy/bundles/release/
|
|
[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
|
<artifact pattern="http://repository.springsource.com/ivy/bundles/release/
|
|
[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
|
</url>
|
|
|
|
<url name="com.springsource.repository.bundles.external">
|
|
<ivy pattern="http://repository.springsource.com/ivy/bundles/external/
|
|
[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
|
<artifact pattern="http://repository.springsource.com/ivy/bundles/external/
|
|
[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
|
</url>]]>
|
|
</programlisting>
|
|
<para>
|
|
To access Spring Web Flow jars as well as 3rd party dependencies with Ivy, add the following repository to your Ivy config:
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<url name="springsource-repository">
|
|
<ivy pattern="http://repo.spring.io/libs-release/[organization]/[module]/[revision]/[type]s/ivy-[revision].xml" />
|
|
<artifact pattern="http://repo.spring.io/libs-release/[organization]/[module]/[revision]/[type]s/[module](-[classifier])-[revision].[ext]" />
|
|
</url>]]>
|
|
</programlisting>
|
|
<para>
|
|
Then declare the following dependencies in your ivy.xml:
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<dependency org="org.springframework.webflow" name="org.springframework.binding"
|
|
rev="x.y.z.RELEASE" conf="compile->runtime" />
|
|
<dependency org="org.springframework.webflow" name="org.springframework.js"
|
|
rev="x.y.z.RELEASE" conf="compile->runtime" />
|
|
<dependency org="org.springframework.webflow" name="org.springframework.webflow"
|
|
rev="x.y.z.RELEASE" conf="compile->runtime" />]]>
|
|
</programlisting>
|
|
<para>
|
|
If using JavaServer Faces, declare the following dependency in your pom (also adds the above dependencies):
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<dependency org="org.springframework.webflow" name="org.springframework.faces"
|
|
rev="x.y.z.RELEASE" conf="compile->runtime" />]]>
|
|
</programlisting>
|
|
</sect1>
|
|
<sect1>
|
|
<title>How to access nightly builds and milestone releases</title>
|
|
<para>
|
|
Nightly snapshots of Web Flow development branches are available using Maven.
|
|
These snapshot builds are useful for testing out fixes you depend on in advance of the next release, and provide a convenient way for you to provide feedback about whether a fix meets your needs.
|
|
</para>
|
|
<sect2>
|
|
<title>Accessing snapshots and milestones with Maven</title>
|
|
<para>
|
|
For milestones and snapshots you'll need to use the SpringSource repository.
|
|
Add the following repository to your Maven pom.xml:
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<repository>
|
|
<id>springsource-repository</id>
|
|
<name>Spring project snapshots, milestones, and releases</name>
|
|
<url>http://repo.spring.io/snapshot</url>
|
|
</repository>]]>
|
|
</programlisting>
|
|
<para>
|
|
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>
|
|
<groupId>org.springframework.webflow</groupId>
|
|
<artifactId>spring-js</artifactId>
|
|
<version>x.y.z.BUILD-SNAPSHOT</version>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>org.springframework.webflow</groupId>
|
|
<artifactId>spring-webflow</artifactId>
|
|
<version>x.y.z.BUILD-SNAPSHOT</version>
|
|
</dependency>]]>
|
|
</programlisting>
|
|
<para>
|
|
And if using JavaServerFaces:
|
|
</para>
|
|
<programlisting language="xml"><![CDATA[
|
|
<dependency>
|
|
<groupId>org.springframework.webflow</groupId>
|
|
<artifactId>spring-faces</artifactId>
|
|
<version>x.y.z.BUILD-SNAPSHOT</version>
|
|
</dependency>]]>
|
|
</programlisting>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|