org.springframework.web.servlet.mvc.ParameterizableViewController Maven / Gradle / Ivy
/*
* Copyright 2002-2007 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.mvc;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
/**
* Trivial controller that always returns a named view. The view
* can be configured using an exposed configuration property. This
* controller offers an alternative to sending a request straight to a view
* such as a JSP. The advantage here is that the client is not exposed to
* the concrete view technology but rather just to the controller URL;
* the concrete view will be determined by the ViewResolver.
*
*
An alternative to the ParameterizableViewController is a
* {@link org.springframework.web.servlet.mvc.multiaction.MultiActionController MultiActionController},
* which can define a variety of handler methods that just return a plain
* ModelAndView instance for a given view name.
*
*
Workflow
* (and that defined by superclass):
*
* - Request is received by the controller
* - call to {@link #handleRequestInternal handleRequestInternal} which
* just returns the view, named by the configuration property
*
viewName. Nothing more, nothing less
*
*
*
* Exposed configuration properties
* (and those defined by superclass):
*
*
* name
* default
* description
*
*
* viewName
* null
* the name of the view the viewResolver will use to forward to
* (if this property is not set, an exception will be thrown during
* initialization)
*
*
*
*
* @author Rod Johnson
* @author Juergen Hoeller
*/
public class ParameterizableViewController extends AbstractController {
private String viewName;
/**
* Set the name of the view to delegate to.
*/
public void setViewName(String viewName) {
this.viewName = viewName;
}
/**
* Return the name of the view to delegate to.
*/
public String getViewName() {
return this.viewName;
}
protected void initApplicationContext() {
if (this.viewName == null) {
throw new IllegalArgumentException("Property 'viewName' is required");
}
}
/**
* Return a ModelAndView object with the specified view name.
* @see #getViewName()
*/
protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)
throws Exception {
return new ModelAndView(getViewName());
}
}