org.springframework.web.servlet.config.annotation

Class CorsRegistration

java.lang.Object

org.springframework.web.servlet.config.annotation.CorsRegistration

public class CorsRegistration
extends java.lang.Object

CorsRegistration assists with the creation of a CorsConfiguration instance mapped to a path pattern.

If no path pattern is specified, cross-origin request handling is mapped to "/**".

By default, all origins, all headers, credentials and GET, HEAD, and POST methods are allowed, and the max age is set to 30 minutes.

Since:

4.2

Author:

Sebastien Deleuze, Sam Brannen

See Also:

CorsConfiguration, CorsRegistry

Field Summary

Fields

Modifier and Type	Field and Description
private CorsConfiguration	config
private java.lang.String	pathPattern

Constructor Summary

Constructors

Constructor and Description
CorsRegistration(java.lang.String pathPattern)

Method Summary

Modifier and Type	Method and Description
CorsRegistration	allowCredentials(boolean allowCredentials)
CorsRegistration	allowedHeaders(java.lang.String... headers)
CorsRegistration	allowedMethods(java.lang.String... methods)
CorsRegistration	allowedOrigins(java.lang.String... origins)
CorsRegistration	exposedHeaders(java.lang.String... headers)
protected CorsConfiguration	getCorsConfiguration()
protected java.lang.String	getPathPattern()
CorsRegistration	maxAge(long maxAge)

Methods inherited from class java.lang.Object

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

Field Detail

pathPattern

private final java.lang.String pathPattern

config

private final CorsConfiguration config

Constructor Detail

CorsRegistration

public CorsRegistration(java.lang.String pathPattern)

Method Detail

allowedOrigins

public CorsRegistration allowedOrigins(java.lang.String... origins)

allowedMethods

public CorsRegistration allowedMethods(java.lang.String... methods)

allowedHeaders

public CorsRegistration allowedHeaders(java.lang.String... headers)

exposedHeaders

public CorsRegistration exposedHeaders(java.lang.String... headers)

maxAge

public CorsRegistration maxAge(long maxAge)

allowCredentials

public CorsRegistration allowCredentials(boolean allowCredentials)

getPathPattern

protected java.lang.String getPathPattern()

getCorsConfiguration

protected CorsConfiguration getCorsConfiguration()