Class CorsConfigurer<H extends HttpSecurityBuilder<H>>

java.lang.Object

org.springframework.security.config.annotation.SecurityConfigurerAdapter<DefaultSecurityFilterChain, H>

org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<CorsConfigurer<H>, H>

org.springframework.security.config.annotation.web.configurers.CorsConfigurer<H>

Type Parameters:

H - the builder to return.

All Implemented Interfaces:

SecurityConfigurer<DefaultSecurityFilterChain, H>

public class CorsConfigurer<H extends HttpSecurityBuilder<H>>
extends AbstractHttpConfigurer<CorsConfigurer<H>, H>

Adds CorsFilter or PreFlightRequestFilter to the Spring Security filter chain. If a bean by the name of corsFilter is provided, that CorsFilter is used. Else if corsConfigurationSource is defined, then that CorsConfigurationSource is used. If a PreFlightRequestHandler is set on this configurer, CorsFilter is not used and PreFlightRequestFilter is registered instead.

Since:

4.1.1

Constructor Summary

Constructors

Constructor	Description
CorsConfigurer()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
CorsConfigurer<H>	configurationSource(org.springframework.web.cors.CorsConfigurationSource configurationSource)
void	configure(H http)	Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.
CorsConfigurer<H>	preFlightRequestHandler(org.springframework.web.cors.PreFlightRequestHandler preFlightRequestHandler)	Use the given PreFlightRequestHandler for CORS preflight requests.

Methods inherited from class AbstractHttpConfigurer

disable, getRequestMatcherBuilder, getSecurityContextHolderStrategy, withObjectPostProcessor

Methods inherited from class SecurityConfigurerAdapter

addObjectPostProcessor, getBuilder, init, postProcess, setBuilder

Methods inherited from class Object

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

Constructor Details

CorsConfigurer

public CorsConfigurer()

Creates a new instance.

See Also:

• HttpSecurity.cors(Customizer)

Method Details

configurationSource

public CorsConfigurer<H> configurationSource(org.springframework.web.cors.CorsConfigurationSource configurationSource)

preFlightRequestHandler

public CorsConfigurer<H> preFlightRequestHandler(org.springframework.web.cors.PreFlightRequestHandler preFlightRequestHandler)

Use the given PreFlightRequestHandler for CORS preflight requests. When set, CorsFilter is not used. Cannot be combined with configurationSource(CorsConfigurationSource).

Parameters:

preFlightRequestHandler - the handler to use

Returns:

the CorsConfigurer for additional configuration

configure

public void configure(H http)

Description copied from interface: SecurityConfigurer

Configure the SecurityBuilder by setting the necessary properties on the SecurityBuilder.

Specified by:

configure in interface SecurityConfigurer<DefaultSecurityFilterChain, H extends HttpSecurityBuilder<H>>

Overrides:

configure in class SecurityConfigurerAdapter<DefaultSecurityFilterChain, H extends HttpSecurityBuilder<H>>

Parameters:

http -