Class ViewControllerRegistry
- Since:
- 3.1
- Author:
- Rossen Stoyanchev, Keith Donald
-
Constructor Summary
ConstructorDescriptionViewControllerRegistry
(@Nullable ApplicationContext applicationContext) Class constructor withApplicationContext
. -
Method Summary
Modifier and TypeMethodDescriptionaddRedirectViewController
(String urlPath, String redirectUrl) Map a view controller to the given URL path or pattern in order to redirect to another URL.void
addStatusController
(String urlPath, HttpStatusCode 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.addViewController
(String urlPathOrPattern) Map a URL path or pattern to a view controller to render a response with the configured status code and view.protected @Nullable SimpleUrlHandlerMapping
Return theHandlerMapping
that contains the registered view controller mappings, ornull
for no registrations.void
setOrder
(int order) Specify the order to use for theHandlerMapping
used to map view controllers relative to other handler mappings configured in Spring MVC.
-
Constructor Details
-
ViewControllerRegistry
Class constructor withApplicationContext
.- Since:
- 4.3.12
-
-
Method Details
-
addViewController
Map a URL path or pattern to a view controller to render a response with the configured status code and view.Patterns such as
"/admin/**"
or"/articles/{articlename:\\w+}"
are supported. For pattern syntax seePathPattern
when parsed patterns areenabled
orAntPathMatcher
otherwise. The syntax is largely the same withPathPattern
more tailored for web usage and more efficient.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.For pattern syntax see
PathPattern
when parsed patterns areenabled
orAntPathMatcher
otherwise. The syntax is largely the same withPathPattern
more tailored for web usage and more efficient.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
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.For pattern syntax see
PathPattern
when parsed patterns areenabled
orAntPathMatcher
otherwise. The syntax is largely the same withPathPattern
more tailored for web usage and more efficient.- Since:
- 4.1
-
setOrder
public void setOrder(int order) Specify the order to use for theHandlerMapping
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.
-
buildHandlerMapping
Return theHandlerMapping
that contains the registered view controller mappings, ornull
for no registrations.- Since:
- 4.3.12
-