org.springframework.web.cors.reactive

Class UrlBasedCorsConfigurationSource

java.lang.Object

org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource

All Implemented Interfaces:

CorsConfigurationSource

public class UrlBasedCorsConfigurationSource
extends 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

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.
Map<String,CorsConfiguration>	getCorsConfigurations() Get the CORS configuration.
void	registerCorsConfiguration(String path, CorsConfiguration config) Register a CorsConfiguration for the specified path pattern.
void	setCorsConfigurations(Map<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(org.springframework.util.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

Constructor Detail

UrlBasedCorsConfigurationSource

public UrlBasedCorsConfigurationSource()

Method Detail

setPathMatcher

public void setPathMatcher(org.springframework.util.PathMatcher pathMatcher)

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

See Also:

AntPathMatcher

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

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