Package org.springframework.data.rest.webmvc

Class BasePathAwareHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<RequestMappingInfo>

org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping

Direct Known Subclasses:

RepositoryRestHandlerMapping

public class BasePathAwareHandlerMapping
extends RequestMappingHandlerMapping

A RequestMappingHandlerMapping that augments the request mappings

Author:

Oliver Gierke

Field Summary

Fields inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

mappingsLogger

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.HandlerMapping

BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
BasePathAwareHandlerMapping(RepositoryRestConfiguration configuration)	Creates a new BasePathAwareHandlerMapping using the given RepositoryRestConfiguration.

Method Summary

Modifier and Type	Method	Description
protected ProducesRequestCondition	customize(ProducesRequestCondition condition)	Customize the given ProducesRequestCondition.
protected RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)
protected boolean	hasCorsConfigurationSource(Object handler)
protected boolean	isHandler(Class<?> beanType)	Deprecated. for overriding in 3.6.
protected boolean	isHandlerInternal(Class<?> type)	Returns whether the given controller type is considered a handler.
protected HandlerMethod	lookupHandlerMethod(String lookupPath, jakarta.servlet.http.HttpServletRequest request)

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

afterPropertiesSet, createRequestMappingInfo, getBuilderConfiguration, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getFileExtensions, getPathPrefixes, initCorsConfiguration, match, registerHandlerMethod, registerMapping, resolveEmbeddedValuesInPatterns, setContentNegotiationManager, setEmbeddedValueResolver, setPathPrefixes, setUseRegisteredSuffixPatternMatch, setUseSuffixPatternMatch, setUseTrailingSlashMatch, useRegisteredSuffixPatternMatch, useSuffixPatternMatch, useTrailingSlashMatch

Methods inherited from class org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping

createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, initHandlerMethods, processCandidateBean, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, setPatternParser, unregisterMapping

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.servlet.HandlerMapping

getHandler, usesPathPatterns

Methods inherited from interface org.springframework.web.servlet.handler.MatchableHandlerMapping

getPatternParser

Constructor Details

BasePathAwareHandlerMapping

public BasePathAwareHandlerMapping(RepositoryRestConfiguration configuration)

Creates a new BasePathAwareHandlerMapping using the given RepositoryRestConfiguration.

Parameters:

configuration - must not be null.

Method Details

lookupHandlerMethod

protected HandlerMethod lookupHandlerMethod(String lookupPath,
 jakarta.servlet.http.HttpServletRequest request)
                                     throws Exception

Overrides:

lookupHandlerMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

Throws:

Exception

hasCorsConfigurationSource

protected boolean hasCorsConfigurationSource(Object handler)

Overrides:

hasCorsConfigurationSource in class AbstractHandlerMethodMapping<RequestMappingInfo>

getMappingForMethod

protected RequestMappingInfo getMappingForMethod(Method method,
 Class<?> handlerType)

Overrides:

getMappingForMethod in class RequestMappingHandlerMapping

customize

protected ProducesRequestCondition customize(ProducesRequestCondition condition)

Customize the given ProducesRequestCondition. Default implementation returns the condition as is.

Parameters:

condition - will never be null.

Returns:

isHandler

@Deprecated
protected boolean isHandler(Class<?> beanType)

Deprecated.

for overriding in 3.6. Will be made final in 4.0.

Returns whether the given type is considered a handler. Performs additional configuration checks. If you only want to customize the handler selection criteria, override isHandlerInternal(Class). Will be made final in 4.0.

Overrides:

isHandler in class RequestMappingHandlerMapping

See Also:

• RequestMappingHandlerMapping.isHandler(java.lang.Class)

isHandlerInternal

protected boolean isHandlerInternal(Class<?> type)

Returns whether the given controller type is considered a handler.

Parameters:

type - will never be null.

Returns: