Package org.springframework.web.servlet.mvc

Class ParameterizableViewController

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.context.support.WebApplicationObjectSupport
org.springframework.web.servlet.support.WebContentGenerator
org.springframework.web.servlet.mvc.AbstractController
org.springframework.web.servlet.mvc.ParameterizableViewController
All Implemented Interfaces:
Aware, ApplicationContextAware, ServletContextAware, Controller
public class ParameterizableViewController extends AbstractController
Trivial controller that always returns a pre-configured view and optionally sets the response status code. The view and status can be configured using the provided configuration properties.
Author:
Rod Johnson, Juergen Hoeller, Keith Donald, Rossen Stoyanchev

  • Constructor Details

    • ParameterizableViewController

      public ParameterizableViewController()

  • Method Details

    • setViewName

      public void setViewName(@Nullable String viewName)
      Set a view name for the ModelAndView to return, to be resolved by the DispatcherServlet via a ViewResolver. Will override any pre-existing view name or View.

    • getViewName

      @Nullable public String getViewName()
      Return the name of the view to delegate to, or null if using a View instance.

    • setView

      public void setView(View view)
      Set a View object for the ModelAndView to return. Will override any pre-existing view name or View.
      Since:
      4.1

    • getView

      @Nullable public View getView()
      Return the View object, or null if we are using a view name to be resolved by the DispatcherServlet via a ViewResolver.
      Since:
      4.1

    • setStatusCode

      public void setStatusCode(@Nullable HttpStatusCode statusCode)
      Configure the HTTP status code that this controller should set on the response.

      When a "redirect:" prefixed view name is configured, there is no need to set this property since RedirectView will do that. However this property may still be used to override the 3xx status code of RedirectView. For full control over redirecting provide a RedirectView instance.

      If the status code is 204 and no view is configured, the request is fully handled within the controller.

      Since:
      4.1

    • getStatusCode

      @Nullable public HttpStatusCode getStatusCode()
      Return the configured HTTP status code or null.
      Since:
      4.1

    • setStatusOnly

      public void setStatusOnly(boolean statusOnly)
      The property can be used to indicate the request is considered fully handled within the controller and that no view should be used for rendering. Useful in combination with setStatusCode(org.springframework.http.HttpStatusCode).

      By default this is set to false.

      Since:
      4.1

    • isStatusOnly

      public boolean isStatusOnly()
      Whether the request is fully handled within the controller.

    • handleRequestInternal

      @Nullable protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) throws Exception
      Return a ModelAndView object with the specified view name.

      The content of the "input" FlashMap is also added to the model.

      Specified by:
      handleRequestInternal in class AbstractController
      Throws:
      Exception
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object