Modifier and Type	Class and Description
public static class	CorsConfig.Builder Deprecated Use `CorsConfigBuilder` instead.
public static class	CorsConfig.DateValueGenerator Deprecated Removed without alternatives.

Modifier and Type	Field and Description
private final boolean	allowCredentials
private final Set<String>	allowedRequestHeaders
private final Set<HttpMethod>	allowedRequestMethods
private final boolean	allowNullOrigin
private final boolean	allowPrivateNetwork
private final boolean	anyOrigin
private final boolean	enabled
private final Set<String>	exposeHeaders
private final long	maxAge
private final Set<String>	origins
private final Map<CharSequence, Callable<?>>	preflightHeaders
private final boolean	shortCircuit

Access	Constructor and Description
pack-priv	CorsConfig(final CorsConfigBuilder builder)

Method Summary

Modifier and Type	Method and Description
public Set<String>	Returns: `Set<String>` of strings that represent the allowed Request Headers. allowedRequestHeaders() Returns the allowed set of Request Headers.
public Set<HttpMethod>	Returns: `Set` of `HttpMethod`s that represent the allowed Request Methods. allowedRequestMethods() Returns the allowed set of Request Methods.
public Set<String>	Returns: `List<String>` a list of the headers to expose. exposedHeaders() Returns a set of headers to be exposed to calling clients.
private static <T> T	getValue(final Callable<T> callable)
public boolean	Returns: `boolean` true if any origin is allowed. isAnyOriginSupported() Determines whether a wildcard origin, '*', is supported.
public boolean	Returns: `true` if support for CORS is enabled, false otherwise. isCorsSupportEnabled() Determines if support for CORS is enabled.
public boolean	Returns: `true` if cookies are supported. isCredentialsAllowed() Determines if cookies are supported for CORS requests.
public boolean	Returns: `true` if a 'null' origin should be supported. isNullOriginAllowed() Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system.
public boolean	Returns: `true` if private network access should be allowed. isPrivateNetworkAllowed() Web browsers may set the 'Access-Control-Request-Private-Network' request header if a resource is loaded from a local network.
public boolean	Returns: `true` if a CORS request should short-circuit upon receiving an invalid Origin header. isShortCircuit() Determines whether a CORS request should be rejected if it's invalid before being further processing.
public boolean	isShortCurcuit() Deprecated Use `isShortCircuit()` instead.
public long	Returns: `long` the time in seconds that a preflight request may be cached. maxAge() Gets the maxAge setting.
public String	Returns: the value that will be used for the CORS response header 'Access-Control-Allow-Origin' origin() Returns the allowed origin.
public Set<String>	Returns: `Set` the allowed origins. origins() Returns the set of allowed origins.
public HttpHeaders	Returns: `HttpHeaders` the HTTP response headers to be added. preflightResponseHeaders() Returns HTTP response headers that should be added to a CORS preflight response.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static CorsConfig.Builder	withAnyOrigin() Deprecated Use `CorsConfigBuilder#forAnyOrigin()` instead.
public static CorsConfig.Builder	withOrigin(final String origin) Deprecated Use `CorsConfigBuilder#forOrigin(String)` instead.
public static CorsConfig.Builder	withOrigins(final String... origins) Deprecated Use `CorsConfigBuilder#forOrigins(String...)` instead.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

allowCredentials	back to summary
private final boolean allowCredentials

allowedRequestHeaders	back to summary
private final Set<String> allowedRequestHeaders

allowedRequestMethods	back to summary
private final Set<HttpMethod> allowedRequestMethods

allowNullOrigin	back to summary
private final boolean allowNullOrigin

allowPrivateNetwork	back to summary
private final boolean allowPrivateNetwork

anyOrigin	back to summary
private final boolean anyOrigin

enabled	back to summary
private final boolean enabled

exposeHeaders	back to summary
private final Set<String> exposeHeaders

maxAge	back to summary
private final long maxAge

origins	back to summary
private final Set<String> origins

preflightHeaders	back to summary
private final Map<CharSequence, Callable<?>> preflightHeaders

shortCircuit	back to summary
private final boolean shortCircuit

CorsConfig	back to summary
pack-priv CorsConfig(final CorsConfigBuilder builder)

Method Detail

allowedRequestHeaders back to summary

allowedRequestHeaders	back to summary
public Set<String> allowedRequestHeaders() Returns the allowed set of Request Headers. The header names returned from this method will be used to set the CORS 'Access-Control-Allow-Headers' response header. Returns:Set<String> `Set<String>` of strings that represent the allowed Request Headers.

public Set<String> allowedRequestHeaders()

Returns the allowed set of Request Headers. The header names returned from this method will be used to set the CORS 'Access-Control-Allow-Headers' response header.

Returns:Set<String>: Set<String> of strings that represent the allowed Request Headers.

allowedRequestMethods back to summary

allowedRequestMethods	back to summary
public Set<HttpMethod> allowedRequestMethods() Returns the allowed set of Request Methods. The Http methods that should be returned in the CORS 'Access-Control-Request-Method' response header. Returns:Set<HttpMethod> `Set` of `HttpMethod`s that represent the allowed Request Methods.

public Set<HttpMethod> allowedRequestMethods()

Returns the allowed set of Request Methods. The Http methods that should be returned in the CORS 'Access-Control-Request-Method' response header.

Returns:Set<HttpMethod>: Set of HttpMethods that represent the allowed Request Methods.

exposedHeaders back to summary

exposedHeaders	back to summary
public Set<String> exposedHeaders() Returns a set of headers to be exposed to calling clients. During a simple CORS request only certain response headers are made available by the browser, for example using: xhr.getResponseHeader("Content-Type"); The headers that are available by default are: Cache-Control Content-Language Content-Type Expires Last-Modified Pragma To expose other headers they need to be specified, which is what this method enables by adding the headers names to the CORS 'Access-Control-Expose-Headers' response header. Returns:Set<String> `List<String>` a list of the headers to expose.

public Set<String> exposedHeaders()

Returns a set of headers to be exposed to calling clients. During a simple CORS request only certain response headers are made available by the browser, for example using:

xhr.getResponseHeader("Content-Type");

The headers that are available by default are:

Cache-Control
Content-Language
Content-Type
Expires
Last-Modified
Pragma

To expose other headers they need to be specified, which is what this method enables by adding the headers names to the CORS 'Access-Control-Expose-Headers' response header.

Returns:Set<String>: List<String> a list of the headers to expose.

getValue	back to summary
private static <T> T getValue(final Callable<T> callable)

isAnyOriginSupported back to summary

isAnyOriginSupported	back to summary
public boolean isAnyOriginSupported() Determines whether a wildcard origin, '*', is supported. Returns:boolean `boolean` true if any origin is allowed.

public boolean isAnyOriginSupported()

Determines whether a wildcard origin, '*', is supported.

Returns:boolean: boolean true if any origin is allowed.

isCorsSupportEnabled back to summary

isCorsSupportEnabled	back to summary
public boolean isCorsSupportEnabled() Determines if support for CORS is enabled. Returns:boolean `true` if support for CORS is enabled, false otherwise.

public boolean isCorsSupportEnabled()

Determines if support for CORS is enabled.

Returns:boolean: true if support for CORS is enabled, false otherwise.

isCredentialsAllowed back to summary

isCredentialsAllowed	back to summary
public boolean isCredentialsAllowed() Determines if cookies are supported for CORS requests. By default cookies are not included in CORS requests but if isCredentialsAllowed returns true cookies will be added to CORS requests. Setting this value to true will set the CORS 'Access-Control-Allow-Credentials' response header to true. Please note that cookie support needs to be enabled on the client side as well. The client needs to opt-in to send cookies by calling: xhr.withCredentials = true; The default value for 'withCredentials' is false in which case no cookies are sent. Setting this to true will included cookies in cross origin requests. Returns:boolean `true` if cookies are supported.

public boolean isCredentialsAllowed()

Determines if cookies are supported for CORS requests. By default cookies are not included in CORS requests but if isCredentialsAllowed returns true cookies will be added to CORS requests. Setting this value to true will set the CORS 'Access-Control-Allow-Credentials' response header to true. Please note that cookie support needs to be enabled on the client side as well. The client needs to opt-in to send cookies by calling:

xhr.withCredentials = true;

The default value for 'withCredentials' is false in which case no cookies are sent. Setting this to true will included cookies in cross origin requests.

Returns:boolean: true if cookies are supported.

isNullOriginAllowed back to summary

isNullOriginAllowed	back to summary
public boolean isNullOriginAllowed() Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system. If isNullOriginAllowed is true then the server will response with the wildcard for the CORS response header 'Access-Control-Allow-Origin'. Returns:boolean `true` if a 'null' origin should be supported.

public boolean isNullOriginAllowed()

Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system. If isNullOriginAllowed is true then the server will response with the wildcard for the CORS response header 'Access-Control-Allow-Origin'.

Returns:boolean: true if a 'null' origin should be supported.

isPrivateNetworkAllowed back to summary

isPrivateNetworkAllowed	back to summary
public boolean isPrivateNetworkAllowed() Web browsers may set the 'Access-Control-Request-Private-Network' request header if a resource is loaded from a local network. By default direct access to private network endpoints from public websites is not allowed. If isPrivateNetworkAllowed is true the server will response with the CORS response header 'Access-Control-Request-Private-Network'. Returns:boolean `true` if private network access should be allowed.

public boolean isPrivateNetworkAllowed()

Web browsers may set the 'Access-Control-Request-Private-Network' request header if a resource is loaded from a local network. By default direct access to private network endpoints from public websites is not allowed. If isPrivateNetworkAllowed is true the server will response with the CORS response header 'Access-Control-Request-Private-Network'.

Returns:boolean: true if private network access should be allowed.

isShortCircuit back to summary

isShortCircuit	back to summary
public boolean isShortCircuit() Determines whether a CORS request should be rejected if it's invalid before being further processing. CORS headers are set after a request is processed. This may not always be desired and this setting will check that the Origin is valid and if it is not valid no further processing will take place, and an error will be returned to the calling client. Returns:boolean `true` if a CORS request should short-circuit upon receiving an invalid Origin header.

public boolean isShortCircuit()

Determines whether a CORS request should be rejected if it's invalid before being further processing. CORS headers are set after a request is processed. This may not always be desired and this setting will check that the Origin is valid and if it is not valid no further processing will take place, and an error will be returned to the calling client.

Returns:boolean: true if a CORS request should short-circuit upon receiving an invalid Origin header.

isShortCurcuit	back to summary
public boolean isShortCurcuit() Deprecated Use `isShortCircuit()` instead. Annotations @Deprecated

maxAge back to summary

maxAge	back to summary
public long maxAge() Gets the maxAge setting. When making a preflight request the client has to perform two request with can be inefficient. This setting will set the CORS 'Access-Control-Max-Age' response header and enables the caching of the preflight response for the specified time. During this time no preflight request will be made. Returns:long `long` the time in seconds that a preflight request may be cached.

public long maxAge()

Gets the maxAge setting. When making a preflight request the client has to perform two request with can be inefficient. This setting will set the CORS 'Access-Control-Max-Age' response header and enables the caching of the preflight response for the specified time. During this time no preflight request will be made.

Returns:long: long the time in seconds that a preflight request may be cached.

origin	back to summary
public String origin() Returns the allowed origin. This can either be a wildcard or an origin value. Returns:String the value that will be used for the CORS response header 'Access-Control-Allow-Origin'

origin

back to summary

public String origin()

Returns the allowed origin. This can either be a wildcard or an origin value.

Returns:String: the value that will be used for the CORS response header 'Access-Control-Allow-Origin'

origins back to summary

origins	back to summary
public Set<String> origins() Returns the set of allowed origins. Returns:Set<String> `Set` the allowed origins.

public Set<String> origins()

Returns the set of allowed origins.

Returns:Set<String>: Set the allowed origins.

preflightResponseHeaders back to summary

preflightResponseHeaders	back to summary
public HttpHeaders preflightResponseHeaders() Returns HTTP response headers that should be added to a CORS preflight response. Returns:HttpHeaders `HttpHeaders` the HTTP response headers to be added.

public HttpHeaders preflightResponseHeaders()

Returns HTTP response headers that should be added to a CORS preflight response.

Returns:HttpHeaders: HttpHeaders the HTTP response headers to be added.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

withAnyOrigin	back to summary
public static CorsConfig.Builder withAnyOrigin() Deprecated Use `CorsConfigBuilder#forAnyOrigin()` instead. Annotations @Deprecated

withOrigin	back to summary
public static CorsConfig.Builder withOrigin(final String origin) Deprecated Use `CorsConfigBuilder#forOrigin(String)` instead. Annotations @Deprecated

withOrigins	back to summary
public static CorsConfig.Builder withOrigins(final String... origins) Deprecated Use `CorsConfigBuilder#forOrigins(String...)` instead. Annotations @Deprecated

io.netty.handler.codec.http.cors back to summary

public Class CorsConfig.Builder

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.cors.CorsConfig.Builder

Annotations

@Deprecated

Deprecated

Use CorsConfigBuilder instead.

Field Summary

Modifier and Type	Field and Description
private final CorsConfigBuilder	builder

Constructor Summary

Access	Constructor and Description
public	Builder(final String... origins) Deprecated Use `CorsConfigBuilder` instead.
public	Builder() Deprecated Use `CorsConfigBuilder` instead.

Method Summary

Modifier and Type	Method and Description
public CorsConfig.Builder	allowCredentials() Deprecated Use `CorsConfigBuilder#allowCredentials()` instead.
public CorsConfig.Builder	allowedRequestHeaders(final String... headers) Deprecated Use `CorsConfigBuilder#allowedRequestHeaders(String...)` instead.
public CorsConfig.Builder	allowedRequestMethods(final HttpMethod... methods) Deprecated Use `CorsConfigBuilder#allowedRequestMethods(HttpMethod...)` instead.
public CorsConfig.Builder	allowNullOrigin() Deprecated Use `CorsConfigBuilder#allowNullOrigin()` instead.
public CorsConfig	build() Deprecated Use `CorsConfigBuilder#build()` instead.
public CorsConfig.Builder	disable() Deprecated Use `CorsConfigBuilder#disable()` instead.
public CorsConfig.Builder	exposeHeaders(final String... headers) Deprecated Use `CorsConfigBuilder#exposeHeaders(String...)` instead.
public CorsConfig.Builder	maxAge(final long max) Deprecated Use `CorsConfigBuilder#maxAge(long)` instead.
public CorsConfig.Builder	noPreflightResponseHeaders() Deprecated Use `CorsConfigBuilder#noPreflightResponseHeaders()` instead.
public CorsConfig.Builder	preflightResponseHeader(final CharSequence name, final Object... values) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Object...)` instead.
public <T> CorsConfig.Builder	preflightResponseHeader(final CharSequence name, final Iterable<T> value) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Iterable)` instead.
public <T> CorsConfig.Builder	preflightResponseHeader(final String name, final Callable<T> valueGenerator) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Callable)` instead.
public CorsConfig.Builder	shortCurcuit() Deprecated Use `CorsConfigBuilder#shortCircuit()` instead.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builder	back to summary
private final CorsConfigBuilder builder

Constructor Detail

Builder	back to summary
public Builder(final String... origins) Deprecated Use `CorsConfigBuilder` instead. Annotations @Deprecated

Builder	back to summary
public Builder() Deprecated Use `CorsConfigBuilder` instead. Annotations @Deprecated

Method Detail

allowCredentials	back to summary
public CorsConfig.Builder allowCredentials() Deprecated Use `CorsConfigBuilder#allowCredentials()` instead. Annotations @Deprecated

allowedRequestHeaders	back to summary
public CorsConfig.Builder allowedRequestHeaders(final String... headers) Deprecated Use `CorsConfigBuilder#allowedRequestHeaders(String...)` instead. Annotations @Deprecated

allowedRequestMethods	back to summary
public CorsConfig.Builder allowedRequestMethods(final HttpMethod... methods) Deprecated Use `CorsConfigBuilder#allowedRequestMethods(HttpMethod...)` instead. Annotations @Deprecated

allowNullOrigin	back to summary
public CorsConfig.Builder allowNullOrigin() Deprecated Use `CorsConfigBuilder#allowNullOrigin()` instead. Annotations @Deprecated

build	back to summary
public CorsConfig build() Deprecated Use `CorsConfigBuilder#build()` instead. Annotations @Deprecated

disable	back to summary
public CorsConfig.Builder disable() Deprecated Use `CorsConfigBuilder#disable()` instead. Annotations @Deprecated

exposeHeaders	back to summary
public CorsConfig.Builder exposeHeaders(final String... headers) Deprecated Use `CorsConfigBuilder#exposeHeaders(String...)` instead. Annotations @Deprecated

maxAge	back to summary
public CorsConfig.Builder maxAge(final long max) Deprecated Use `CorsConfigBuilder#maxAge(long)` instead. Annotations @Deprecated

noPreflightResponseHeaders	back to summary
public CorsConfig.Builder noPreflightResponseHeaders() Deprecated Use `CorsConfigBuilder#noPreflightResponseHeaders()` instead. Annotations @Deprecated

preflightResponseHeader	back to summary
public CorsConfig.Builder preflightResponseHeader(final CharSequence name, final Object... values) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Object...)` instead. Annotations @Deprecated

preflightResponseHeader	back to summary
public <T> CorsConfig.Builder preflightResponseHeader(final CharSequence name, final Iterable<T> value) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Iterable)` instead. Annotations @Deprecated

preflightResponseHeader	back to summary
public <T> CorsConfig.Builder preflightResponseHeader(final String name, final Callable<T> valueGenerator) Deprecated Use `CorsConfigBuilder#preflightResponseHeader(CharSequence, Callable)` instead. Annotations @Deprecated

shortCurcuit	back to summary
public CorsConfig.Builder shortCurcuit() Deprecated Use `CorsConfigBuilder#shortCircuit()` instead. Annotations @Deprecated

public final Class CorsConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CorsConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class CorsConfig.DateValueGenerator

Constructor Summary

Method Summary

Constructor Detail

Method Detail