Top Description Fields Constructors Methods
org.springframework.web.cors.reactive

public Class UrlBasedCorsConfigurationSource

extends Object
implements CorsConfigurationSource
Class Inheritance
All Implemented Interfaces
org.springframework.web.cors.reactive.CorsConfigurationSource
Imports
java.util.LinkedHashMap, .Map, org.springframework.http.server.PathContainer, org.springframework.lang.Nullable, org.springframework.web.cors.CorsConfiguration, org.springframework.web.server.ServerWebExchange, org.springframework.web.util.pattern.PathPattern, .PathPatternParser

CorsConfigurationSource that uses URL patterns to select the CorsConfiguration for a request.
Authors
Sebastien Deleuze, Brian Clozel
Since
5.0
See Also
PathPattern

Field Summary

Modifier and TypeField and Description
private final Map<PathPattern, CorsConfiguration>
private final PathPatternParser

Constructor Summary

AccessConstructor and Description
public
UrlBasedCorsConfigurationSource()

Construct a new UrlBasedCorsConfigurationSource instance with default PathPatternParser.

public
UrlBasedCorsConfigurationSource(PathPatternParser patternParser)

Construct a new UrlBasedCorsConfigurationSource instance from the supplied PathPatternParser.

Method Summary

Modifier and TypeMethod and Description
public CorsConfiguration
public void
registerCorsConfiguration(String path, CorsConfiguration config)

Register a CorsConfiguration for the specified path pattern.

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

Set CORS configuration based on URL patterns.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

corsConfigurationsback to summary
private final Map<PathPattern, CorsConfiguration> corsConfigurations
patternParserback to summary
private final PathPatternParser patternParser

Constructor Detail

UrlBasedCorsConfigurationSourceback to summary
public UrlBasedCorsConfigurationSource()

Construct a new UrlBasedCorsConfigurationSource instance with default PathPatternParser.

Since
5.0.6
UrlBasedCorsConfigurationSourceback to summary
public UrlBasedCorsConfigurationSource(PathPatternParser patternParser)

Construct a new UrlBasedCorsConfigurationSource instance from the supplied PathPatternParser.

Method Detail

getCorsConfigurationback to summary
public CorsConfiguration getCorsConfiguration(ServerWebExchange exchange)

Implements org.springframework.web.cors.reactive.CorsConfigurationSource.getCorsConfiguration.

Doc from org.springframework.web.cors.reactive.CorsConfigurationSource.getCorsConfiguration.

Return a CorsConfiguration based on the incoming request.

Returns:CorsConfiguration

the associated CorsConfiguration, or null if none

Annotations
@Override
@Nullable
registerCorsConfigurationback to summary
public void registerCorsConfiguration(String path, CorsConfiguration config)

Register a CorsConfiguration for the specified path pattern.

setCorsConfigurationsback to summary
public void setCorsConfigurations(Map<String, CorsConfiguration> configMap)

Set CORS configuration based on URL patterns.