org.springframework.web.servlet.view.InternalResourceViewResolver Maven / Gradle / Ivy
/*
* Copyright 2002-2006 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.servlet.view;
/**
* Convenient subclass of {@link UrlBasedViewResolver} that supports
* {@link InternalResourceView} (i.e. Servlets and JSPs) and subclasses
* such as {@link JstlView} and
* {@link org.springframework.web.servlet.view.tiles.TilesView}.
*
* The view class for all views generated by this resolver can be specified
* via {@link #setViewClass}. See UrlBasedViewResolver's javadoc for details.
*
*
BTW, it's good practice to put JSP files that just serve as views under
* WEB-INF, to hide them from direct access (e.g. via a manually entered URL).
* Only controllers will be able to access them then.
*
*
Note: When chaining ViewResolvers, an InternalResourceViewResolver
* always needs to be last, as it will attempt to resolve any view name,
* no matter whether the underlying resource actually exists.
*
* @author Juergen Hoeller
* @since 17.02.2003
* @see #setViewClass
* @see #setPrefix
* @see #setSuffix
* @see #setRequestContextAttribute
* @see InternalResourceView
* @see JstlView
* @see org.springframework.web.servlet.view.tiles.TilesView
*/
public class InternalResourceViewResolver extends UrlBasedViewResolver {
private boolean alwaysInclude = false;
/**
* Sets default viewClass to requiredViewClass.
* @see #setViewClass
* @see #requiredViewClass
*/
public InternalResourceViewResolver() {
setViewClass(requiredViewClass());
}
/**
* Requires InternalResourceView.
* @see InternalResourceView
*/
protected Class requiredViewClass() {
return InternalResourceView.class;
}
/**
* Specify whether to always include the view rather than forward to it.
*
Default is "false". Switch this flag on to enforce the use of a
* Servlet include, even if a forward would be possible.
* @see InternalResourceView#setAlwaysInclude
*/
public void setAlwaysInclude(boolean alwaysInclude) {
this.alwaysInclude = alwaysInclude;
}
protected AbstractUrlBasedView buildView(String viewName) throws Exception {
InternalResourceView view = (InternalResourceView) super.buildView(viewName);
view.setAlwaysInclude(this.alwaysInclude);
return view;
}
}