Class urlBasedCorsConfigurationSource

java.lang.Object

org.springframework.web.cors.reactive.urlBasedCorsConfigurationSource

All Implemented Interfaces:

CorsConfigurationSource

public class urlBasedCorsConfigurationSource
extends Object
implements CorsConfigurationSource

CorsConfigurationSource that uses url patterns to select the CorsConfiguration for a request.

Since:

5.0

Author:

Sebastien Deleuze, Brian Clozel

See Also:

• PathPattern

Constructor Summary

Constructors

Constructor	Description
urlBasedCorsConfigurationSource()	Construct a new urlBasedCorsConfigurationSource instance with default PathPatternParser.
urlBasedCorsConfigurationSource(PathPatternParser patternParser)	Construct a new urlBasedCorsConfigurationSource instance from the supplied PathPatternParser.

Method Summary

Modifier and Type	Method	Description
@Nullable CorsConfiguration	getCorsConfiguration(ServerWebExchange exchange)	Return a CorsConfiguration based on the incoming request.
void	registerCorsConfiguration(String path, CorsConfiguration config)	Register a CorsConfiguration for the specified path pattern.
void	setCorsConfigurations(@Nullable Map<String, CorsConfiguration> configMap)	Set CORS configuration based on url patterns.

Methods inherited from class Object

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

Constructor Details

urlBasedCorsConfigurationSource

public urlBasedCorsConfigurationSource()

Construct a new urlBasedCorsConfigurationSource instance with default PathPatternParser.

Since:

5.0.6

urlBasedCorsConfigurationSource

public urlBasedCorsConfigurationSource(PathPatternParser patternParser)

Construct a new urlBasedCorsConfigurationSource instance from the supplied PathPatternParser.

Method Details

setCorsConfigurations

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

Set CORS configuration based on url patterns.

registerCorsConfiguration

public void registerCorsConfiguration(String path,
 CorsConfiguration config)

Register a CorsConfiguration for the specified path pattern.

getCorsConfiguration

public @Nullable 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