Deprecate Velocity support

Issue: SPR-13235

Author: jhoeller

spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactory.java

@@ -69,7 +69,9 @@
  * @see VelocityEngineFactoryBean
  * @see org.springframework.web.servlet.view.velocity.VelocityConfigurer
  * @see org.apache.velocity.app.VelocityEngine
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityEngineFactory {
 
 	protected final Log logger = LogFactory.getLog(getClass());

spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactoryBean.java

@@ -46,7 +46,9 @@
  * @see #setVelocityProperties
  * @see #setResourceLoaderPath
  * @see org.springframework.web.servlet.view.velocity.VelocityConfigurer
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityEngineFactoryBean extends VelocityEngineFactory
 		implements FactoryBean<VelocityEngine>, InitializingBean, ResourceLoaderAware {
 

spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineUtils.java

@@ -30,7 +30,9 @@
  *
  * @author Juergen Hoeller
  * @since 22.01.2004
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public abstract class VelocityEngineUtils {
 
 	/**

spring-webmvc/src/main/java/org/springframework/web/servlet/config/ViewResolversBeanDefinitionParser.java

@@ -39,7 +39,6 @@
 import org.springframework.web.servlet.view.groovy.GroovyMarkupViewResolver;
 import org.springframework.web.servlet.view.script.ScriptTemplateViewResolver;
 import org.springframework.web.servlet.view.tiles3.TilesViewResolver;
-import org.springframework.web.servlet.view.velocity.VelocityViewResolver;
 
 /**
  * Parse the {@code view-resolvers} MVC namespace element and register
@@ -69,6 +68,7 @@ public class ViewResolversBeanDefinitionParser implements BeanDefinitionParser {
 	public static final String VIEW_RESOLVER_BEAN_NAME = "mvcViewResolver";
 
 
+	@SuppressWarnings("deprecation")
 	public BeanDefinition parse(Element element, ParserContext context) {
 		Object source = context.extractSource(element);
 		context.pushContainingComponent(new CompositeComponentDefinition(element.getTagName(), source));
@@ -100,7 +100,7 @@ else if ("freemarker".equals(name)) {
 				addUrlBasedViewResolverProperties(resolverElement, resolverBeanDef);
 			}
 			else if ("velocity".equals(name)) {
-				resolverBeanDef = new RootBeanDefinition(VelocityViewResolver.class);
+				resolverBeanDef = new RootBeanDefinition(org.springframework.web.servlet.view.velocity.VelocityViewResolver.class);
 				resolverBeanDef.getPropertyValues().add("suffix", ".vm");
 				addUrlBasedViewResolverProperties(resolverElement, resolverBeanDef);
 			}

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ViewResolverRegistry.java

@@ -41,8 +41,6 @@
 import org.springframework.web.servlet.view.script.ScriptTemplateViewResolver;
 import org.springframework.web.servlet.view.tiles3.TilesConfigurer;
 import org.springframework.web.servlet.view.tiles3.TilesViewResolver;
-import org.springframework.web.servlet.view.velocity.VelocityConfigurer;
-import org.springframework.web.servlet.view.velocity.VelocityViewResolver;
 
 /**
  * Assist with the configuration of a chain of
@@ -86,10 +84,8 @@ public boolean hasRegistrations() {
 	 * Enable use of a {@link ContentNegotiatingViewResolver} to front all other
 	 * configured view resolvers and select among all selected Views based on
 	 * media types requested by the client (e.g. in the Accept header).
-	 *
 	 * <p>If invoked multiple times the provided default views will be added to
 	 * any other default views that may have been configured already.
-	 *
 	 * @see ContentNegotiatingViewResolver#setDefaultViews
 	 */
 	public void enableContentNegotiation(View... defaultViews) {
@@ -100,7 +96,6 @@ public void enableContentNegotiation(View... defaultViews) {
 	 * Enable use of a {@link ContentNegotiatingViewResolver} to front all other
 	 * configured view resolvers and select among all selected Views based on
 	 * media types requested by the client (e.g. in the Accept header).
-	 *
 	 * <p>If invoked multiple times the provided default views will be added to
 	 * any other default views that may have been configured already.
 	 *
@@ -112,9 +107,8 @@ public void enableContentNegotiation(boolean useNotAcceptableStatus, View... def
 	}
 
 	private void initContentNegotiatingViewResolver(View[] defaultViews) {
-
 		// ContentNegotiatingResolver in the registry: elevate its precedence!
-		this.order = (this.order == null ? Ordered.HIGHEST_PRECEDENCE : this.order);
+		this.order = (this.order != null ? this.order : Ordered.HIGHEST_PRECEDENCE);
 
 		if (this.contentNegotiatingResolver != null) {
 			if (!ObjectUtils.isEmpty(defaultViews)) {
@@ -136,7 +130,6 @@ private void initContentNegotiatingViewResolver(View[] defaultViews) {
 	/**
 	 * Register JSP view resolver using a default view name prefix of "/WEB-INF/"
 	 * and a default suffix of ".jsp".
-	 *
 	 * <p>When this method is invoked more than once, each call will register a
 	 * new ViewResolver instance. Note that since it's not easy to determine
 	 * if a JSP exists without forwarding to it, using multiple JSP-based view
@@ -149,7 +142,6 @@ public UrlBasedViewResolverRegistration jsp() {
 
 	/**
 	 * Register JSP view resolver with the specified prefix and suffix.
-	 *
 	 * <p>When this method is invoked more than once, each call will register a
 	 * new ViewResolver instance. Note that since it's not easy to determine
 	 * if a JSP exists without forwarding to it, using multiple JSP-based view
@@ -166,7 +158,6 @@ public UrlBasedViewResolverRegistration jsp(String prefix, String suffix) {
 
 	/**
 	 * Register Tiles 3.x view resolver.
-	 *
 	 * <p><strong>Note</strong> that you must also configure Tiles by adding a
 	 * {@link org.springframework.web.servlet.view.tiles3.TilesConfigurer} bean.
 	 */
@@ -184,7 +175,6 @@ public UrlBasedViewResolverRegistration tiles() {
 	/**
 	 * Register a FreeMarker view resolver with an empty default view name
 	 * prefix and a default suffix of ".ftl".
-	 *
 	 * <p><strong>Note</strong> that you must also configure FreeMarker by adding a
 	 * {@link org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer} bean.
 	 */
@@ -203,12 +193,13 @@ public UrlBasedViewResolverRegistration freeMarker() {
 	/**
 	 * Register Velocity view resolver with an empty default view name
 	 * prefix and a default suffix of ".vm".
-	 *
 	 * <p><strong>Note</strong> that you must also configure Velocity by adding a
 	 * {@link org.springframework.web.servlet.view.velocity.VelocityConfigurer} bean.
+	 * @deprecated as of Spring 4.3, in favor of FreeMarker
 	 */
+	@Deprecated
 	public UrlBasedViewResolverRegistration velocity() {
-		if (this.applicationContext != null && !hasBeanOfType(VelocityConfigurer.class)) {
+		if (this.applicationContext != null && !hasBeanOfType(org.springframework.web.servlet.view.velocity.VelocityConfigurer.class)) {
 			throw new BeanInitializationException("In addition to a Velocity view resolver " +
 					"there must also be a single VelocityConfig bean in this web application context " +
 					"(or its parent): VelocityConfigurer is the usual implementation. " +
@@ -313,38 +304,39 @@ protected List<ViewResolver> getViewResolvers() {
 
 	private static class TilesRegistration extends UrlBasedViewResolverRegistration {
 
-		private TilesRegistration() {
+		public TilesRegistration() {
 			super(new TilesViewResolver());
 		}
 	}
 
 	private static class VelocityRegistration extends UrlBasedViewResolverRegistration {
 
-		private VelocityRegistration() {
-			super(new VelocityViewResolver());
+		@SuppressWarnings("deprecation")
+		public VelocityRegistration() {
+			super(new org.springframework.web.servlet.view.velocity.VelocityViewResolver());
 			getViewResolver().setSuffix(".vm");
 		}
 	}
 
 	private static class FreeMarkerRegistration extends UrlBasedViewResolverRegistration {
 
-		private FreeMarkerRegistration() {
+		public FreeMarkerRegistration() {
 			super(new FreeMarkerViewResolver());
 			getViewResolver().setSuffix(".ftl");
 		}
 	}
 
 	private static class GroovyMarkupRegistration extends UrlBasedViewResolverRegistration {
 
-		private GroovyMarkupRegistration() {
+		public GroovyMarkupRegistration() {
 			super(new GroovyMarkupViewResolver());
 			getViewResolver().setSuffix(".tpl");
 		}
 	}
 
 	private static class ScriptRegistration extends UrlBasedViewResolverRegistration {
 
-		private ScriptRegistration() {
+		public ScriptRegistration() {
 			super(new ScriptTemplateViewResolver());
 			getViewResolver();
 		}

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityConfig.java

@@ -26,7 +26,9 @@
  * @author Rod Johnson
  * @see VelocityConfigurer
  * @see VelocityView
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public interface VelocityConfig {
 
 	/**

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityConfigurer.java

@@ -25,7 +25,6 @@
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.context.ResourceLoaderAware;
-import org.springframework.ui.velocity.VelocityEngineFactory;
 import org.springframework.web.context.ServletContextAware;
 
 /**
@@ -69,8 +68,10 @@
  * @see #setResourceLoaderPath
  * @see #setVelocityEngine
  * @see VelocityView
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
-public class VelocityConfigurer extends VelocityEngineFactory
+@Deprecated
+public class VelocityConfigurer extends org.springframework.ui.velocity.VelocityEngineFactory
 		implements VelocityConfig, InitializingBean, ResourceLoaderAware, ServletContextAware {
 
 	/** the name of the resource loader for Spring's bind macros */

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityLayoutView.java

@@ -50,7 +50,9 @@
  * @see #setLayoutUrl
  * @see #setLayoutKey
  * @see #setScreenContentKey
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityLayoutView extends VelocityToolboxView {
 
 	/**

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityLayoutViewResolver.java

@@ -31,7 +31,9 @@
  * @see #setLayoutUrl
  * @see #setLayoutKey
  * @see #setScreenContentKey
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityLayoutViewResolver extends VelocityViewResolver {
 
 	private String layoutUrl;

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityToolboxView.java

@@ -62,7 +62,9 @@
  * @see #initTool
  * @see org.apache.velocity.tools.view.context.ViewContext
  * @see org.apache.velocity.tools.view.context.ChainedContext
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityToolboxView extends VelocityView {
 
 	private String toolboxConfigLocation;

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityView.java

@@ -83,7 +83,9 @@
  * @see #setVelocityEngine
  * @see VelocityConfig
  * @see VelocityConfigurer
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityView extends AbstractTemplateView {
 
 	private Map<String, Class<?>> toolAttributes;

spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity/VelocityViewResolver.java

@@ -40,7 +40,9 @@
  * @see #setDateToolAttribute
  * @see #setNumberToolAttribute
  * @see VelocityView
+ * @deprecated as of Spring 4.3, in favor of FreeMarker
  */
+@Deprecated
 public class VelocityViewResolver extends AbstractTemplateViewResolver {
 
 	private String dateToolAttribute;

spring-webmvc/src/main/resources/org/springframework/web/servlet/config/spring-mvc-4.3.xsd

@@ -1022,16 +1022,6 @@
 							]]></xsd:documentation>
 						</xsd:annotation>
 					</xsd:element>
-					<xsd:element name="velocity" type="urlViewResolverType">
-						<xsd:annotation>
-							<xsd:documentation><![CDATA[
-	Register a VelocityViewResolver.
-	By default, ".vm" is configured as a view name suffix.
-	To configure Velocity you must also add a top-level <mvc:velocity-configurer> element
-	or declare a VelocityConfigurer bean.
-							]]></xsd:documentation>
-						</xsd:annotation>
-					</xsd:element>
 					<xsd:element name="groovy" type="urlViewResolverType">
 						<xsd:annotation>
 							<xsd:documentation><![CDATA[
@@ -1170,24 +1160,6 @@
 		</xsd:complexType>
 	</xsd:element>
 
-	<xsd:element name="velocity-configurer">
-		<xsd:annotation>
-			<xsd:documentation><![CDATA[
-	Configure Velocity for view resolution by registering a VelocityConfigurer bean.
-	This is a shortcut alternative to declaring a VelocityConfigurer bean directly.
-			]]></xsd:documentation>
-		</xsd:annotation>
-		<xsd:complexType>
-			<xsd:attribute name="resource-loader-path" type="xsd:string" use="required">
-				<xsd:annotation>
-					<xsd:documentation><![CDATA[
-	The Velocity resource loader path via a Spring resource location.
-					]]></xsd:documentation>
-				</xsd:annotation>
-			</xsd:attribute>
-		</xsd:complexType>
-	</xsd:element>
-
 	<xsd:element name="groovy-configurer">
 		<xsd:annotation>
 			<xsd:documentation><![CDATA[