Class SimpleUrlHandlerMapping
- All Implemented Interfaces:
- Aware,- BeanNameAware,- ApplicationContextAware,- Ordered,- HandlerMapping
HandlerMapping
 interface to map from URLs to request handler beans. Supports both mapping
 to bean instances and mapping to bean names; the latter is required for
 non-singleton handlers.
 The "urlMap" property is suitable for populating the handler map with
 bean instances. Mappings to bean names can be set via the "mappings"
 property, in a form accepted by the java.util.Properties class,
 as follows:
 
/welcome.html=ticketController /show.html=ticketController
The syntax is PATH=HANDLER_BEAN_NAME. If the path doesn't begin
 with a slash, one is prepended.
 
Supports direct matches, e.g. a registered "/test" matches "/test", and
 various Ant-style pattern matches, e.g. a registered "/t*" pattern matches
 both "/test" and "/team", "/test/*" matches all paths under "/test",
 "/test/**" matches all paths below "/test". For details, see the
 PathPattern javadoc.
- Since:
- 5.0
- Author:
- Rossen Stoyanchev, Sam Brannen
- 
Field SummaryFields inherited from class org.springframework.web.reactive.handler.AbstractHandlerMappingmappingsLoggerFields inherited from class org.springframework.context.support.ApplicationObjectSupportloggerFields inherited from interface org.springframework.web.reactive.HandlerMappingBEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTEFields inherited from interface org.springframework.core.OrderedHIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
- 
Constructor SummaryConstructorsConstructorDescriptionCreate aSimpleUrlHandlerMappingwith default settings.SimpleUrlHandlerMapping(Map<String, ?> urlMap) Create aSimpleUrlHandlerMappingusing the supplied URL map.SimpleUrlHandlerMapping(Map<String, ?> urlMap, int order) Create aSimpleUrlHandlerMappingusing the supplied URL map and order.
- 
Method SummaryModifier and TypeMethodDescriptionAllowMapaccess to the URL path mappings, with the option to add or override specific entries.voidCalls theregisterHandlers(java.util.Map<java.lang.String, java.lang.Object>)method in addition to the superclass's initialization.protected voidregisterHandlers(Map<String, Object> urlMap) Register all handlers specified in the URL map for the corresponding paths.voidsetMappings(Properties mappings) Map URL paths to handler bean names.voidSet a Map with URL paths as keys and handler beans (or handler bean names) as values.Methods inherited from class org.springframework.web.reactive.handler.AbstractUrlHandlerMappinggetHandlerInternal, getHandlerMap, lookupHandler, registerHandler, registerHandler, setHandlerPredicate, setLazyInitHandlers, validateHandlerMethods inherited from class org.springframework.web.reactive.handler.AbstractHandlerMappingformatMappingName, getCorsConfiguration, getCorsProcessor, getHandler, getOrder, getPathPatternParser, hasCorsConfigurationSource, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setOrder, setUseCaseSensitiveMatch, setUseTrailingSlashMatchMethods inherited from class org.springframework.context.support.ApplicationObjectSupportgetApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext
- 
Constructor Details- 
SimpleUrlHandlerMappingpublic SimpleUrlHandlerMapping()Create aSimpleUrlHandlerMappingwith default settings.
- 
SimpleUrlHandlerMappingCreate aSimpleUrlHandlerMappingusing the supplied URL map.- Parameters:
- urlMap- map with URL paths as keys and handler beans (or handler bean names) as values
- Since:
- 5.2
- See Also:
 
- 
SimpleUrlHandlerMappingCreate aSimpleUrlHandlerMappingusing the supplied URL map and order.- Parameters:
- urlMap- map with URL paths as keys and handler beans (or handler bean names) as values
- order- the order value for this- SimpleUrlHandlerMapping
- Since:
- 5.2
- See Also:
 
 
- 
- 
Method Details- 
setMappingsMap URL paths to handler bean names. This is the typical way of configuring this HandlerMapping.Supports direct URL matches and Ant-style pattern matches. For syntax details, see the PathPatternjavadoc.- Parameters:
- mappings- properties with URLs as keys and bean names as values
- See Also:
 
- 
setUrlMapSet a Map with URL paths as keys and handler beans (or handler bean names) as values. Convenient for population with bean references.Supports direct URL matches and Ant-style pattern matches. For syntax details, see the PathPatternjavadoc.- Parameters:
- urlMap- map with URLs as keys and beans as values
- See Also:
 
- 
getUrlMapAllowMapaccess to the URL path mappings, with the option to add or override specific entries.Useful for specifying entries directly, for example via "urlMap[myKey]". This is particularly useful for adding or overriding entries in child bean definitions. 
- 
initApplicationContextCalls theregisterHandlers(java.util.Map<java.lang.String, java.lang.Object>)method in addition to the superclass's initialization.- Overrides:
- initApplicationContextin class- ApplicationObjectSupport
- Throws:
- ApplicationContextException- in case of initialization errors
- BeansException- if thrown by ApplicationContext methods
- See Also:
 
- 
registerHandlersRegister all handlers specified in the URL map for the corresponding paths.- Parameters:
- urlMap- a Map with URL paths as keys and handler beans or bean names as values
- Throws:
- BeansException- if a handler couldn't be registered
- IllegalStateException- if there is a conflicting handler registered
 
 
-