org.broadleafcommerce.frameworkmapping

Class FrameworkMappingHandlerMapping

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<org.springframework.web.servlet.mvc.method.RequestMappingInfo>

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

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

org.broadleafcommerce.frameworkmapping.FrameworkMappingHandlerMapping

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.EmbeddedValueResolverAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.handler.MatchableHandlerMapping, org.springframework.web.servlet.HandlerMapping

public class FrameworkMappingHandlerMapping
extends org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

HandlerMapping to find and map FrameworkMappings inside FrameworkController and FrameworkRestController classes.

When framework controllers are enabled with FrameworkControllerScan, and a class is annotated with FrameworkController or FrameworkRestController, then this class will add FrameworkMappings found within the class to handler mappings. This class has a lower priority than the default RequestMappingHandlerMapping so when a request comes in, RequestMappings located inside a class annotated with Controller or RestController will have a higher priority and be found before FrameworkMappings found within a FrameworkController or FrameworkRestController.

The site handler mappings in play in order of precedence from highest to lowest are:

1. RequestMappingHandlerMapping
2. FrameworkMappingHandlerMapping

Author:

Philip Baggett (pbaggett)

See Also:

FrameworkControllerScan, FrameworkController, FrameworkRestController, FrameworkMapping

Field Summary

Fields

Modifier and Type	Field and Description
static int	REQUEST_MAPPING_ORDER

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, 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 and Description
FrameworkMappingHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.servlet.mvc.method.RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)
protected boolean	isHandler(Class<?> beanType) See AopUtils and ClassUtils.

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

afterPropertiesSet, createRequestMappingInfo, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getFileExtensions, initCorsConfiguration, match, resolveEmbeddedValuesInPatterns, setContentNegotiationManager, setEmbeddedValueResolver, setUseRegisteredSuffixPatternMatch, setUseSuffixPatternMatch, setUseTrailingSlashMatch, useRegisteredSuffixPatternMatch, useSuffixPatternMatch, useTrailingSlashMatch

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

getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

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

createHandlerMethod, detectHandlerMethods, getCorsConfiguration, getHandlerInternal, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, initHandlerMethods, lookupHandlerMethod, registerHandlerMethod, registerMapping, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping

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

adaptInterceptor, detectMappedInterceptors, extendInterceptors, getAdaptedInterceptors, getCorsConfigurations, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setCorsConfigurations, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper

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

Field Detail

REQUEST_MAPPING_ORDER

public static final int REQUEST_MAPPING_ORDER

See Also:

Constant Field Values

Constructor Detail

FrameworkMappingHandlerMapping

public FrameworkMappingHandlerMapping()

Method Detail

isHandler

protected boolean isHandler(Class<?> beanType)

See AopUtils and ClassUtils. We want to generally prevent traversal up of super classes for determninig if beans fit within this handler mapping. However, if the controller itself is proxied (which can happen with @PreAuthorize @Transaction or other annotations on controller methods) then the "real" class is actually "super class" of the type passed in to this method. This util ensures that we always get the real bean type from the CGLib proxy type passed in here

Overrides:

isHandler in class org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

See Also:

AOPUtils, ClassUtils, AnnotationUtils, AnnotatedElementUtils

getMappingForMethod

protected org.springframework.web.servlet.mvc.method.RequestMappingInfo getMappingForMethod(Method method,
                                                                                            Class<?> handlerType)

Overrides:

getMappingForMethod in class org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping