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 AbstractHandlerMapping

mappingsLogger

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface HandlerMapping

API_VERSION_ATTRIBUTE, 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 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 @Nullable 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 @Nullable HandlerMethod	lookupHandlerMethod(String lookupPath, jakarta.servlet.http.HttpServletRequest request)

Methods inherited from class RequestMappingHandlerMapping

afterPropertiesSet, createRequestMappingInfo, createRequestMappingInfo, getBuilderConfiguration, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getPathPrefixes, initCorsConfiguration, match, registerHandlerMethod, registerMapping, resolveEmbeddedValuesInPatterns, setContentNegotiationManager, setEmbeddedValueResolver, setPathPrefixes

Methods inherited from class RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class AbstractHandlerMethodMapping

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

Methods inherited from class AbstractHandlerMapping

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

Methods inherited from class WebApplicationObjectSupport

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

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Methods inherited from interface HandlerMapping

getHandler, usesPathPatterns

Methods inherited from interface 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 @Nullable 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 @Nullable 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: