org.springframework.web.cors.reactive

Class UrlBasedCorsConfigurationSource

java.lang.Object

org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource

All Implemented Interfaces:

CorsConfigurationSource

public class UrlBasedCorsConfigurationSource
extends java.lang.Object
implements CorsConfigurationSource

Provide a per reactive 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:

5.0

Author:

Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,CorsConfiguration>	corsConfigurations
private HttpRequestPathHelper	pathHelper
private PathMatcher	pathMatcher

Constructor Summary

Constructors

Constructor and Description
UrlBasedCorsConfigurationSource()

Method Summary

Modifier and Type	Method and Description
CorsConfiguration	getCorsConfiguration(ServerWebExchange exchange) Return a CorsConfiguration based on the incoming request.
java.util.Map<java.lang.String,CorsConfiguration>	getCorsConfigurations() Get the CORS configuration.
void	registerCorsConfiguration(java.lang.String path, CorsConfiguration config) Register a CorsConfiguration for the specified path pattern.
void	setCorsConfigurations(java.util.Map<java.lang.String,CorsConfiguration> corsConfigurations) Set CORS configuration based on URL patterns.
void	setHttpRequestPathHelper(HttpRequestPathHelper pathHelper) Set the UrlPathHelper to use for resolution of lookup paths.
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setUrlDecode(boolean urlDecode) Set if context path and request URI should be URL-decoded.

Methods inherited from class java.lang.Object

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

Field Detail

corsConfigurations

private final java.util.Map<java.lang.String,CorsConfiguration> corsConfigurations

pathMatcher

private PathMatcher pathMatcher

pathHelper

private HttpRequestPathHelper pathHelper

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

See Also:

ParsingPathMatcher

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

See Also:

HttpRequestPathHelper.setUrlDecode(boolean)

setHttpRequestPathHelper

public void setHttpRequestPathHelper(HttpRequestPathHelper pathHelper)

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(java.util.Map<java.lang.String,CorsConfiguration> corsConfigurations)

Set CORS configuration based on URL patterns.

getCorsConfigurations

public java.util.Map<java.lang.String,CorsConfiguration> getCorsConfigurations()

Get the CORS configuration.

registerCorsConfiguration

public void registerCorsConfiguration(java.lang.String path,
                                      CorsConfiguration config)

Register a CorsConfiguration for the specified path pattern.

getCorsConfiguration

public CorsConfiguration getCorsConfiguration(ServerWebExchange exchange)

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