diff --git a/src/dist/javascript-copyright.txt b/src/dist/javascript-copyright.txt index ac3362c1..96b13ec8 100644 --- a/src/dist/javascript-copyright.txt +++ b/src/dist/javascript-copyright.txt @@ -1,5 +1,5 @@ /* - * Copyright 2004-2008 the original author or authors. + * Copyright 2004-2018 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/dist/notice.txt b/src/dist/notice.txt index 7b4acaf2..1c23906d 100644 --- a/src/dist/notice.txt +++ b/src/dist/notice.txt @@ -1,11 +1,11 @@ Spring Web Flow ${version} -Copyright (c) 2002-${copyright} SpringSource, a division of VMware, Inc. +Copyright 2002-${copyright} the original author or authors. This product is licensed to you under the Apache License, Version 2.0 (the "License"). You may not use this product except in compliance with the License. -This product may include a number of subcomponents with separate +This product may include a number of sub-components with separate copyright notices and license terms. Your use of the source code for these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the license.txt file. diff --git a/src/dist/readme.txt b/src/dist/readme.txt index eb95a20c..b39c97c7 100644 --- a/src/dist/readme.txt +++ b/src/dist/readme.txt @@ -1,6 +1,6 @@ SPRING WEB FLOW ${version} -------------------------- -http://www.springframework.org/webflow +http://projects.spring.io/spring-webflow/ 1. INTRODUCTION --------------- @@ -34,18 +34,18 @@ Spring Web Flow is released under the terms of the Apache Software License (see 3. GETTING STARTED ------------------ Current samples: -https://github.com/SpringSource/spring-webflow-samples. +https://github.com/spring-projects/spring-webflow-samples. -4. OBTAINING RELEASE JARS WITH MAVEN OR IVY -------------------------------------------- +4. OBTAINING RELEASE JARS THROUGH MAVEN REPOSITORY +-------------------------------------------------- Release versions of Spring Web Flow artifacts are available via Maven Central. -For milestones and snapshots only (and for Ivy dependencies) you'll need to use the -SpringSource repository. Add the following repository to your Maven pom.xml: +For milestones and snapshots only you'll need to use the Spring repository. +Add the following repository to your Maven pom.xml: - springsource-repository - Spring project releases, milestones, and snapshots + spring + Spring Snapshots http://repo.spring.io/snapshot @@ -73,36 +73,6 @@ If using JSF all you need to include is: ${version} -To access jars using Ivy, add the following repositories to your Ivy config: - - - - - - - - - - - -Then declare the following dependencies in your ivy.xml: - - - - - -If using JavaServerFaces: - - - -For more information see the reference documentation and the SpringSource Repository FAQ: -https://github.com/spring-projects/spring-framework/wiki/Spring-repository-FAQ - -5. ADDITIONAL RESOURCES ------------------------ -The Spring Web Flow homepage is located at: - http://projects.spring.io/spring-webflow/ - -The Spring Web Flow community forums are located at: - http://forum.spring.io/ +For more details see the following Spring Framework wiki page: +https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-Artifacts diff --git a/src/reference/overview.xml b/src/reference/overview.xml index ecfe2752..e1f73135 100644 --- a/src/reference/overview.xml +++ b/src/reference/overview.xml @@ -19,10 +19,10 @@ What Web Flow requires to run - Java 1.6 or higher. + Java 1.8 or higher. - Spring 3.2 or higher. + Spring 5.0 or higher. @@ -48,8 +48,7 @@ build system for your web development project. - To access Web Flow jars from Maven Central, declare the following dependency in your pom (includes - transitive dependencies "spring-binding"): + To access Web Flow jars from Maven Central, declare the following dependency in your pom: @@ -72,54 +71,6 @@ ]]> - - How to access Web Flow artifacts with Ivy - - To access Spring Web Flow jars with Ivy, add the following repositories to your Ivy config: - - - - - - - - - -]]> - - - To access Spring Web Flow jars as well as 3rd party dependencies with Ivy, add the following repository to your Ivy config: - - - - -]]> - - - Then declare the following dependencies in your ivy.xml: - - runtime" /> - -]]> - - - If using JavaServer Faces, declare the following dependency in your pom (also adds the above dependencies): - - runtime" />]]> - - How to access nightly builds and milestone releases @@ -134,8 +85,8 @@ - springsource-repository - Spring project snapshots, milestones, and releases + spring + Spring Repository http://repo.spring.io/snapshot ]]> @@ -143,12 +94,6 @@ Then declare the following dependencies: - org.springframework.webflow - spring-binding - x.y.z.BUILD-SNAPSHOT - - org.springframework.webflow spring-webflow @@ -156,7 +101,7 @@ ]]> - And if using JavaServerFaces: + And if using JSF: diff --git a/src/reference/spring-faces.xml b/src/reference/spring-faces.xml index 0ba3fd05..be572bc6 100644 --- a/src/reference/spring-faces.xml +++ b/src/reference/spring-faces.xml @@ -11,121 +11,12 @@ xsi:schemaLocation=" Introduction - - Spring Web Flow provides a JSF integration that simplifies using JSF - with Spring. It lets you use the JSF UI Component Model with Spring MVC - and Spring Web Flow controllers. Along with the JSF integration Spring Web - Flow provides a Spring Security tag library for use in JSF environments - (see for more details). + + Spring Web Flow provides a JSF integration that lets you use the JSF UI + Component Model with Spring Web Flow controllers. Web Flow also provides + a Spring Security tag library for use in JSF environments, + see for more details. - - Starting with Spring Web Flow version 2.4, JSF integration requires - JSF v2.0 or above. Both Sun Mojarra and Apache MyFaces runtime environments - are supported. - - - - - JSF Integration For Spring Developers - - Spring Web Flow complements the strengths of JSF, its component - model, and provides more sophisticated state management and navigation. In - addition you have the ability to use Spring MVC @Controller or flow - definitions as controllers in the web layer. - - JSF applications using Spring Web Flow applications gain benefits in - the following areas: - - Managed bean facility - - - - Scope management - - - - Event handling - - - - Navigation - - - - Modularization and packaging of views - - - - Cleaner URLs - - - - Model-level validation - - Using these features significantly reduce the amount of - configuration required in faces-config.xml. They provide a cleaner - separation between the view and controller layers along with better - modularization of application functionals. These features are detailed in - the sections to follow. The majority of these features build on the flow - definition language of Spring Web Flow. Therefore it is assumed that you - have an understanding of the foundations presented in . - - - - Upgrading from Spring Web Flow 2.3 - - If you are upgrading from Spring Web Flow 2.3 or earlier you may need to - update several aspects of your project. JSF 2.0 is now a minimum requirement - and as result some components from previous releases are no longer included. - - - Spring Faces Components - Previous releases of Spring Web Flow shipped with a component library - which provided Ajax and client-side validation capabilities for JSF 1.2 - environments. Applications using these components will need to switch to a - 3rd party JSF component library such as PrimeFaces or RichFaces. - Components that have been removed include <sf:clientTextValidator>, - <sf:clientNumberValidator>, <sf:clientDateValidator>, - <sf:validateAllOnClick>, <sf:resource> and - <sf:resourceGroup>. - The swf-booking-faces sample in the Spring Web Flow distribution - shows an example built with PrimeFaces components. - - - - Configuring faces-config.xml - If your application defines a faces-config.xml file you should - ensure that the correct schema version is specified. In addition you should remove - any FaceletViewHandler references as Facelets are now the default rendering - technology for JSF 2.0 - - -<?xml version='1.0' encoding='UTF-8'?> -<faces-config xmlns="http://java.sun.com/xml/ns/javaee" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd" - version="2.0"> - -</faces-config> - - - - - Third-party Libraries - Previous releases of Spring Web Flow would often require additional configuration in order - for 3rd party component libraries to work correctly. JSF 2.0 introduced standard resource - loading mechanisms that removes the need for such custom configuration. As long as you - have a <faces:resources> element in your Spring configuration, libraries - such as RichFaces or Apache Trinidad you should work. - - - - Spring Security Facelets Tag Library - If you have a previously configured /WEB-INF/springsecurity.taglib.xml file - you may need to update the contents. See for - details. - @@ -737,7 +628,7 @@ mvn package with these components JSF must take complete control of parsing multi-part requests and Spring MVC's MultipartResolver cannot be used. - Spring Web Flow has been tested with file upload components from PrimeFaces and RichFaces. Check the + Spring Web Flow has been tested with file upload components from PrimeFaces. Check the documentation of your JSF component library for other providers to see how to configure file upload. @@ -753,42 +644,16 @@ mvn package PrimeFaces FileUpload Filter Spring MVC Dispatcher Servlet -]]> + + + + primefaces.UPLOADER + commons +]]> For more details refer to the PrimeFaces documentation. - - - File Uploads with RichFaces - RichFaces provides a <rich:fileUpload> component for uploading files. No - special configuration is required to use the component, however, you will need to perform - some additional steps in your fileUploadListener. - Here is some typical XHTML markup. In this example the fileUploadBean refers - to Spring singleton bean. - -]]> - Within your fileUploadBean you need to tell Web Flow that the response has been - handled and that it should not attempt any redirects. The org.springframework.webflow.context.ExternalContext - interface provides a recordResponseComplete() for just such purposes. - In addition, it is imperative that some partial response data is returned to the client. If your - <rich:fileUpload> component does not specify a render attribute you - may need to call processPartial(PhaseId.RENDER_RESPONSE) on the JSF - PartialViewContext. - public class FileUploadBean { - - public void listener(FileUploadEvent event) throws Exception{ - FacesContext.getCurrentInstance().getPartialViewContext().processPartial(PhaseId.RENDER_RESPONSE); - ExternalContextHolder.getExternalContext().recordResponseComplete(); - UploadedFile file = event.getUploadedFile(); - // Do something with the file - } -} - For more details refer to the - RichFaces documentation. - diff --git a/src/reference/spring-js.xml b/src/reference/spring-js.xml index 36a68c56..47acd4a9 100644 --- a/src/reference/spring-js.xml +++ b/src/reference/spring-js.xml @@ -11,42 +11,23 @@ Introduction - 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. + The spring-js-resources module is a legacy module that is no longer recommended for use + but is provided still as an optional module for backwards compatibility. Its original aim is to provide a + client-side programming model for progressively enhancing a web page with behavior and Ajax remoting. - Use of the Spring JS API is demonstrated in the the Spring MVC + Web Flow version of the Spring Travel reference application. + Use of the Spring JS API is demonstrated in the + samples repository. Serving Javascript Resources - Spring JS provides a generic ResourceServlet 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 web.xml: - - - - Resource Servlet - org.springframework.js.resource.ResourceServlet - - - - - Resource Servlet - /resources/* -]]> - - - Note that starting with version 3.0.4, the Spring Framework includes - a replacement for the ResourceServlet (see the - Spring Framework documentation). - With the new <mvc:resources> element resource requests (.js, .css) are handled by the - DispatcherSevlet without the need for a separate ResourceServlet. - Here is the relevant portion of the Spring MVC configuration in - the mvc-booking sample: + The Spring Framework provides a mechanism for serving static resources. + See the + Spring Framework documentation). + With the new <mvc:resources> element resource requests (.js, .css) are handled by theDispatcherSevlet. + Here is example configuration in XML (Java config is also available): @@ -77,12 +58,12 @@ - Spring MVC Dispatcher Servlet + DispatcherServlet org.springframework.web.servlet.DispatcherServlet - Spring MVC Dispatcher Servlet + DispatcherServlet / ]]> @@ -263,7 +244,7 @@ - + ]]> diff --git a/src/reference/whatsnew.xml b/src/reference/whatsnew.xml index bd12e4b3..f8ad6cf2 100644 --- a/src/reference/whatsnew.xml +++ b/src/reference/whatsnew.xml @@ -11,8 +11,19 @@ Spring Web Flow 2.5 - This release requires JDK 1.8 and Spring Framework 5.0. - + + This release provides an upgrade path to Spring Framework 5 that in turn requires + Java 8+, Servlet 3.1, Hibernate 5, Tiles 3. See the + Spring Framework wiki + for more details. The samples repository + has been upgraded to Spring Web Flow 2.5. + + + As of 2.5 there is no longer a spring-js module. The classes from that module + have been kept but moved to new packages in the spring-webflow module. + The spring-js-resources module is available as an optional module that + must be included explicitly. +