org.springframework.web.cors

Class UrlBasedCorsConfigurationSource

java.lang.Object

org.springframework.web.cors.UrlBasedCorsConfigurationSource

All Implemented Interfaces:

CorsConfigurationSource

public class UrlBasedCorsConfigurationSource
extends Object
implements CorsConfigurationSource

Provide a per request CorsConfiguration instance based on a collection of CorsConfiguration mapped on path patterns.

Exact path mapping URIs (such as "/admin") are supported as well as Ant-style path patterns (such as "/admin/**").

Since:

4.2

Author:

Sebastien Deleuze

Constructor Summary

Constructors

Constructor and Description
UrlBasedCorsConfigurationSource()

Method Summary

Modifier and Type	Method and Description
CorsConfiguration	getCorsConfiguration(HttpServletRequest request) Return a CorsConfiguration based on the incoming request.
Map<String,CorsConfiguration>	getCorsConfigurations() Get the CORS configuration.
void	registerCorsConfiguration(String path, CorsConfiguration config) Register a CorsConfiguration for the specified path pattern.
void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Shortcut to same property on underlying UrlPathHelper.
void	setCorsConfigurations(Map<String,CorsConfiguration> corsConfigurations) Set CORS configuration based on URL patterns.
void	setLookupPathAttributeName(String lookupPathAttributeName) Optionally configure the name of the attribute that caches the lookupPath.
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setRemoveSemicolonContent(boolean removeSemicolonContent) Shortcut to same property on underlying UrlPathHelper.
void	setUrlDecode(boolean urlDecode) Shortcut to same property on underlying UrlPathHelper.
void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use for resolution of lookup paths.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlBasedCorsConfigurationSource

public UrlBasedCorsConfigurationSource()

Method Detail

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

See Also:

AntPathMatcher

setAlwaysUseFullPath

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Shortcut to same property on underlying UrlPathHelper.

See Also:

UrlPathHelper.setAlwaysUseFullPath(boolean)

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Shortcut to same property on underlying UrlPathHelper.

See Also:

UrlPathHelper.setUrlDecode(boolean)

setLookupPathAttributeName

public void setLookupPathAttributeName(@Nullable
                                       String lookupPathAttributeName)

Optionally configure the name of the attribute that caches the lookupPath. This is used to make the call to UrlPathHelper.getLookupPathForRequest(HttpServletRequest, String)

Parameters:

lookupPathAttributeName - the request attribute to check

Since:

5.2

setRemoveSemicolonContent

public void setRemoveSemicolonContent(boolean removeSemicolonContent)

Shortcut to same property on underlying UrlPathHelper.

See Also:

UrlPathHelper.setRemoveSemicolonContent(boolean)

setUrlPathHelper

public void setUrlPathHelper(UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use for resolution of lookup paths.

Use this to override the default UrlPathHelper with a custom subclass.

setCorsConfigurations

public void setCorsConfigurations(@Nullable
                                  Map<String,CorsConfiguration> corsConfigurations)

Set CORS configuration based on URL patterns.

getCorsConfigurations

public Map<String,CorsConfiguration> getCorsConfigurations()

Get the CORS configuration.

registerCorsConfiguration

public void registerCorsConfiguration(String path,
                                      CorsConfiguration config)

Register a CorsConfiguration for the specified path pattern.

getCorsConfiguration

@Nullable
public CorsConfiguration getCorsConfiguration(HttpServletRequest request)

Description copied from interface: CorsConfigurationSource

Return a CorsConfiguration based on the incoming request.

Specified by:

getCorsConfiguration in interface CorsConfigurationSource

Returns:

the associated CorsConfiguration, or null if none