org.springframework.security.oauth2.provider.endpoint

Class FrameworkEndpointHandlerMapping

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.springframework.security.oauth2.provider.endpoint.FrameworkEndpointHandlerMapping

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.HandlerMapping

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

A handler mapping for framework endpoints (those annotated with @FrameworkEndpoint).

Author:

Dave Syer

Field Summary

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

logger

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

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
FrameworkEndpointHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.servlet.mvc.method.RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)
String	getPath(String defaultPath)
Set<String>	getPaths()
String	getServletPath(String defaultPath)
protected boolean	isHandler(Class<?> beanType) Detects @FrameworkEndpoint annotations in handler beans.
void	setApprovalParameter(String approvalParameter) The name of the request parameter that distinguishes a call to approve an authorization.
void	setMappings(Map<String,String> patternMap) Custom mappings for framework endpoint paths.
void	setPrefix(String prefix)

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

afterPropertiesSet, createRequestMappingInfo, getContentNegotiationManager, getCustomMethodCondition, getCustomTypeCondition, getFileExtensions, 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, getHandlerInternal, getHandlerMethods, handlerMethodsInitialized, initHandlerMethods, lookupHandlerMethod, registerHandlerMethod, setDetectHandlerMethodsInAncestorContexts

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

adaptInterceptor, detectMappedInterceptors, extendInterceptors, getAdaptedInterceptors, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, 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, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameworkEndpointHandlerMapping

public FrameworkEndpointHandlerMapping()

Method Detail

setPrefix

public void setPrefix(String prefix)

Parameters:

prefix - the prefix to set

setMappings

public void setMappings(Map<String,String> patternMap)

Custom mappings for framework endpoint paths. The keys in the map are the default framework endpoint path, e.g. "/oauth/authorize", and the values are the desired runtime paths.

Parameters:

patternMap - the mappings to set

getServletPath

public String getServletPath(String defaultPath)

Returns:

the mapping from default endpoint paths to custom ones (or the default if no customization is known)

getPath

public String getPath(String defaultPath)

Returns:

the mapping from default endpoint paths to custom ones (or the default if no customization is known)

getPaths

public Set<String> getPaths()

setApprovalParameter

public void setApprovalParameter(String approvalParameter)

The name of the request parameter that distinguishes a call to approve an authorization. Default is OAuth2Utils.USER_OAUTH_APPROVAL.

Parameters:

approvalParameter - the approvalParameter to set

isHandler

protected boolean isHandler(Class<?> beanType)

Detects @FrameworkEndpoint annotations in handler beans.

Overrides:

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

See Also:

RequestMappingHandlerMapping.isHandler(java.lang.Class)

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