org.springframework.web.cors

Class DefaultCorsProcessor

java.lang.Object

org.springframework.web.cors.DefaultCorsProcessor

All Implemented Interfaces:

CorsProcessor

public class DefaultCorsProcessor
extends java.lang.Object
implements CorsProcessor

Default implementation of CorsProcessor, as defined by the CORS W3C recommendation.

Note that when input CorsConfiguration is null, this implementation does not reject simple or actual requests outright but simply avoid adding CORS headers to the response. CORS processing is also skipped if the response already contains CORS headers, or if the request is detected as a same-origin one.

Since:

4.2

Author:

Sebastien Deleuze, Rossen Stoyanhcev

Field Summary

Fields

Modifier and Type	Field and Description
private static Log	logger
private static java.nio.charset.Charset	UTF8_CHARSET

Constructor Summary

Constructors

Constructor and Description
DefaultCorsProcessor()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	checkHeaders(CorsConfiguration config, java.util.List<java.lang.String> requestHeaders) Check the headers and determine the headers for the response of a pre-flight request.
protected java.util.List<HttpMethod>	checkMethods(CorsConfiguration config, HttpMethod requestMethod) Check the HTTP method and determine the methods for the response of a pre-flight request.
protected java.lang.String	checkOrigin(CorsConfiguration config, java.lang.String requestOrigin) Check the origin and determine the origin for the response.
private java.util.List<java.lang.String>	getHeadersToUse(ServerHttpRequest request, boolean isPreFlight)
private HttpMethod	getMethodToUse(ServerHttpRequest request, boolean isPreFlight)
protected boolean	handleInternal(ServerHttpRequest request, ServerHttpResponse response, CorsConfiguration config, boolean preFlightRequest) Handle the given request.
boolean	processRequest(CorsConfiguration config, HttpServletRequest request, HttpServletResponse response) Process a request given a CorsConfiguration.
protected void	rejectRequest(ServerHttpResponse response) Invoked when one of the CORS checks failed.
private boolean	responseHasCors(ServerHttpResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

UTF8_CHARSET

private static final java.nio.charset.Charset UTF8_CHARSET

logger

private static final Log logger

Constructor Detail

DefaultCorsProcessor

public DefaultCorsProcessor()

Method Detail

processRequest

public boolean processRequest(CorsConfiguration config,
                              HttpServletRequest request,
                              HttpServletResponse response)
                       throws java.io.IOException

Description copied from interface: CorsProcessor

Process a request given a CorsConfiguration.

Specified by:

processRequest in interface CorsProcessor

Parameters:

config - the applicable CORS configuration, possibly null

request - the current request

response - the current response

Returns:

false if the request is rejected, else true.

Throws:

java.io.IOException

responseHasCors

private boolean responseHasCors(ServerHttpResponse response)

rejectRequest

protected void rejectRequest(ServerHttpResponse response)
                      throws java.io.IOException

Invoked when one of the CORS checks failed. The default implementation sets the response status to 403 and writes "Invalid CORS request" to the response.

Throws:

java.io.IOException

handleInternal

protected boolean handleInternal(ServerHttpRequest request,
                                 ServerHttpResponse response,
                                 CorsConfiguration config,
                                 boolean preFlightRequest)
                          throws java.io.IOException

Handle the given request.

Throws:

java.io.IOException

checkOrigin

protected java.lang.String checkOrigin(CorsConfiguration config,
                                       java.lang.String requestOrigin)

Check the origin and determine the origin for the response. The default implementation simply delegates to CorsConfiguration.checkOrigin(String)

checkMethods

protected java.util.List<HttpMethod> checkMethods(CorsConfiguration config,
                                                  HttpMethod requestMethod)

Check the HTTP method and determine the methods for the response of a pre-flight request. The default implementation simply delegates to CorsConfiguration.checkOrigin(String)

getMethodToUse

private HttpMethod getMethodToUse(ServerHttpRequest request,
                                  boolean isPreFlight)

checkHeaders

protected java.util.List<java.lang.String> checkHeaders(CorsConfiguration config,
                                                        java.util.List<java.lang.String> requestHeaders)

Check the headers and determine the headers for the response of a pre-flight request. The default implementation simply delegates to CorsConfiguration.checkOrigin(String)

getHeadersToUse

private java.util.List<java.lang.String> getHeadersToUse(ServerHttpRequest request,
                                                         boolean isPreFlight)