Class ViewControllerRegistry


  • public class ViewControllerRegistry
    extends Object
    Assists with the registration of simple automated controllers pre-configured with status code and/or a view.
    Since:
    3.1
    Author:
    Rossen Stoyanchev, Keith Donald
    • Method Detail

      • addViewController

        public ViewControllerRegistration addViewController​(String urlPath)
        Map a view controller to the given URL path (or pattern) in order to render a response with a pre-configured status code and view.

        Patterns like "/admin/**" or "/articles/{articlename:\\w+}" are allowed. See AntPathMatcher for more details on the syntax.

        Note: If an @RequestMapping method is mapped to a URL for any HTTP method then a view controller cannot handle the same URL. For this reason it is recommended to avoid splitting URL handling across an annotated controller and a view controller.

      • addRedirectViewController

        public RedirectViewControllerRegistration addRedirectViewController​(String urlPath,
                                                                            String redirectUrl)
        Map a view controller to the given URL path (or pattern) in order to redirect to another URL. By default the redirect URL is expected to be relative to the current ServletContext, i.e. as relative to the web application root.
        Since:
        4.1
      • addStatusController

        public void addStatusController​(String urlPath,
                                        HttpStatus statusCode)
        Map a simple controller to the given URL path (or pattern) in order to set the response status to the given code without rendering a body.
        Since:
        4.1
      • setOrder

        public void setOrder​(int order)
        Specify the order to use for the HandlerMapping used to map view controllers relative to other handler mappings configured in Spring MVC.

        By default this is set to 1, i.e. right after annotated controllers, which are ordered at 0.