io.micronaut.http.server.cors

Class CorsOriginConfiguration

java.lang.Object

io.micronaut.http.server.cors.CorsOriginConfiguration

public class CorsOriginConfiguration
extends Object

Stores configuration for CORS.

Since:

1.0

Author:

James Kleeh, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	ANY Constant to represent any value.
static List<HttpMethod>	ANY_METHOD Constant to represent any method.

Constructor Summary

Constructors

Constructor and Description
CorsOriginConfiguration()

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedHeaders()
List<HttpMethod>	getAllowedMethods()
List<String>	getAllowedOrigins()
Optional<String>	getAllowedOriginsRegex()
List<String>	getExposedHeaders()
Long	getMaxAge()
boolean	isAllowCredentials()
void	setAllowCredentials(boolean allowCredentials) Sets whether to allow credentials.
void	setAllowedHeaders(List<String> allowedHeaders) Sets the allowed headers.
void	setAllowedMethods(List<HttpMethod> allowedMethods) Sets the allowed methods.
void	setAllowedOrigins(List<String> allowedOrigins) Sets the allowed origins.
void	setAllowedOriginsRegex(String allowedOriginsRegex) Sets a regular expression for matching Allowed Origins.
void	setExposedHeaders(List<String> exposedHeaders) Sets the exposed headers.
void	setMaxAge(Long maxAge) Sets the max age.

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final List<String> ANY

Constant to represent any value.

ANY_METHOD

public static final List<HttpMethod> ANY_METHOD

Constant to represent any method.

Constructor Detail

CorsOriginConfiguration

public CorsOriginConfiguration()

Method Detail

getAllowedOrigins

public List<String> getAllowedOrigins()

Returns:

The allowed origins

setAllowedOrigins

public void setAllowedOrigins(@Nullable
                              List<String> allowedOrigins)

Sets the allowed origins.

Parameters:

allowedOrigins - The allow origins

getAllowedOriginsRegex

@NonNull
public Optional<String> getAllowedOriginsRegex()

Returns:

a regular expression for matching Allowed Origins.

setAllowedOriginsRegex

public void setAllowedOriginsRegex(String allowedOriginsRegex)

Sets a regular expression for matching Allowed Origins.

Parameters:

allowedOriginsRegex - a regular expression for matching Allowed Origins.

getAllowedMethods

public List<HttpMethod> getAllowedMethods()

Returns:

The allowed methods

setAllowedMethods

public void setAllowedMethods(@Nullable
                              List<HttpMethod> allowedMethods)

Sets the allowed methods.

Parameters:

allowedMethods - The allowed methods

getAllowedHeaders

public List<String> getAllowedHeaders()

Returns:

The allowed headers

setAllowedHeaders

public void setAllowedHeaders(@Nullable
                              List<String> allowedHeaders)

Sets the allowed headers.

Parameters:

allowedHeaders - The allowed headers

getExposedHeaders

public List<String> getExposedHeaders()

Returns:

The exposed headers

setExposedHeaders

public void setExposedHeaders(@Nullable
                              List<String> exposedHeaders)

Sets the exposed headers.

Parameters:

exposedHeaders - The exposed headers

isAllowCredentials

public boolean isAllowCredentials()

Returns:

Whether to allow credentials

setAllowCredentials

public void setAllowCredentials(boolean allowCredentials)

Sets whether to allow credentials.

Parameters:

allowCredentials - The credentials

getMaxAge

public Long getMaxAge()

Returns:

The max age. A value of -1 indicates no max age

setMaxAge

public void setMaxAge(@Nullable
                      Long maxAge)

Sets the max age.

Parameters:

maxAge - The max age