org.springframework.web.servlet.handler Documentation Differences

This file contains all the changes in documentation in the package org.springframework.web.servlet.handler as colored differences. Deletions are shown like this, and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Abstract base class for org.springframework.web.servlet.HandlerMapping implementations. Supports ordering, a default handler, handler interceptors, including handler interceptors mapped by path patterns.

Note: This base class does not support exposure of the .PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE. Support for this attribute is up to concrete subclasses, typically based on request URL mappings. @author Juergen Hoeller @author Rossen Stoyanchev @since 07.04.2003 @see #getHandlerInternal @see #setDefaultHandler @see #setAlwaysUseFullPath @see #setUrlDecode @see org.springframework.util.AntPathMatcher @see #setInterceptors @see org.springframework.web.servlet.HandlerInterceptor

Detects beans of type MappedInterceptor and adds them to the list of mapped interceptors. This is done in addition to any MappedInterceptors that may have been provided via .setInterceptors(Object[]). Subclasses can override this method to change that. @param mappedInterceptors an empty list to add MappedInterceptor types to

Initialize the specified interceptors, checking for MappedInterceptors and adaptingadapting HandlerInterceptors where necessary. @see #setInterceptors @see #adaptInterceptor

Set the interceptors to apply for all handlers mapped by this handler mapping.

Supported interceptor types are HandlerInterceptor, WebRequestInterceptor, and MappedInterceptor. Mapped interceptors apply only to request URLs that match its path patterns. Mapped interceptor beans are also detected by type during initialization. @param interceptors array of handler interceptors, or null if none @see #adaptInterceptor @see org.springframework.web.servlet.HandlerInterceptor @see org.springframework.web.context.request.WebRequestInterceptor

Abstract base class forfor HandlerExceptionResolver implementations that support handling exceptions from handlers of type HandlerMethods rather than handlers. @author Rossen Stoyanchev @since 3.1

Checks if the handler is a HandlerMethod instance and performs thethen check against the bean instance itdelegates to the base class implementation of contains. If theshouldApplyTo(HttpServletRequest, providedObject) handler is not an instancepassing the bean of the of{@code HandlerMethod,}. Otherwise returns {@code false} is returned instead.

Abstract base class for HandlerMapping implementations that define a mapping between a request and a HandlerMethod.

For each registered handler method, a unique mapping is maintained with with subclasses defining the details of the mapping type {@code }. @param The mapping for a HandlerMethod containing the conditions needed to match the handler method to incoming request. @author Arjen Poutsma @author Rossen Stoyanchev @since 3.1

Provide the mapping for a handler method. A method for which nono mapping can be provided is not a handler method. @param method the method to provide a mapping for @param handlerType the handler type, possibly a sub-type of the method's declaring class @return the mapping, or {@code null} if the method is not mapped

Check if a mapping matches the current request and return a (potentiallypotentially new) mapping with conditions relevant to the current request. @param mapping the mapping to get a match for @param request the current HTTP servlet request @return the match, or {@code null} if the mapping doesn't match

Invoked when a matching mapping is found. @param mapping the matching mapping mapping @param lookupPath mapping lookup path within the current servlet mapping @param request the current request

Look up the best-matching handler method for the current request. If multiple matches are found, the best match is selected. @param lookupPath mapping lookup path within the current servlet mapping @param request the current request @return the best-matching handler method, or {@code null} if no match @see #handleMatch(Object, String, HttpServletRequest) @see #handleNoMatch(Set, String, HttpServletRequest)

Register a handler method and its unique mapping. @param handler the bean name of the handler or the handler instance @param method the method to register @param mapping the mapping conditions associated with the handler method @throws IllegalStateException if another method was already registered registered under the same mapping

Create a new DispatcherServletWebRequest instance for the given request and response. @param request current HTTP request @param requestresponse current HTTP response

Create a new MappedInterceptor instance. @param pathPatternsincludePatterns the path patterns to map with a {@code null} value matching to all paths @param interceptor the HandlerInterceptor instance to map to the given patterns

Create a new MappedInterceptor instance. @param pathPatternsincludePatterns the path patterns to map with a {@code null} value matching to all paths @param interceptor the WebRequestInterceptor instance to map to the given patterns

Returns {@code true} if the interceptor applies to the given request path. @param lookupPath the current request path @param pathMatcher a path matcher for path pattern matching

org.springframework.web.servlet.HandlerExceptionResolver implementation that allows for mapping exception class names to view names, either for a set of given handlers or for all handlers in the DispatcherServlet.

Error views are analogous to error page JSPs, but can be used with any kind of exception including any checked one, with fine-granular mappings for specific handlers. @author Juergen Hoeller @author Arjen Poutsma @author Rossen Stoyanchev @since 22.11.2003 @see org.springframework.web.servlet.DispatcherServlet

An alternative to .setStatusCodes(Properties) for use withwith Java-based configuration.

Determine the view name for the given exception, first checking against the "excludedExecptions", then searching thethe "exceptionMappings", and finally using thethe "defaultErrorView" as a fallback. @param ex the exception that got thrown during handler execution @param request current HTTP request (useful for obtaining metadata) @return the resolved view name, or null if excluded or none found