public final class CorsConfigBuilder
extends java.lang.Object
CorsConfig
instance.
This class was lifted from the Netty project:
https://github.com/netty/nettyModifier and Type | Method and Description |
---|---|
CorsConfigBuilder |
allowCredentials()
By default cookies are not included in CORS requests, but this method will enable cookies to
be added to CORS requests.
|
CorsConfigBuilder |
allowedRequestHeaders(java.lang.String... headers)
Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers'
response header.
|
CorsConfigBuilder |
allowedRequestMethods(org.jboss.netty.handler.codec.http.HttpMethod... methods)
Specifies the allowed set of HTTP Request Methods that should be returned in the
CORS 'Access-Control-Request-Method' response header.
|
CorsConfig |
build()
Builds a
CorsConfig with settings specified by previous method calls. |
CorsConfigBuilder |
disable()
Disables CORS support.
|
static CorsConfigBuilder |
forAnyOrigin()
Creates a Builder instance with it's origin set to '*'.
|
static CorsConfigBuilder |
forOrigin(java.lang.String origin)
Creates a
CorsConfigBuilder instance with the specified origin. |
static CorsConfigBuilder |
forOrigins(java.lang.String... origins)
Creates a
CorsConfigBuilder instance with the specified origins. |
static CorsConfigBuilder |
forPattern(java.util.regex.Pattern pattern)
Create a
CorsConfigBuilder instance with the specified pattern origin. |
CorsConfigBuilder |
maxAge(long max)
When making a preflight request the client has to perform two request with can be inefficient.
|
CorsConfigBuilder |
noPreflightResponseHeaders()
Specifies that no preflight response headers should be added to a preflight response.
|
<T> CorsConfigBuilder |
preflightResponseHeader(java.lang.CharSequence name,
java.util.concurrent.Callable<T> valueGenerator)
Returns HTTP response headers that should be added to a CORS preflight response.
|
<T> CorsConfigBuilder |
preflightResponseHeader(java.lang.CharSequence name,
java.lang.Iterable<T> value)
Returns HTTP response headers that should be added to a CORS preflight response.
|
CorsConfigBuilder |
preflightResponseHeader(java.lang.CharSequence name,
java.lang.Object... values)
Returns HTTP response headers that should be added to a CORS preflight response.
|
CorsConfigBuilder |
shortCircuit()
Specifies that a CORS request should be rejected if it's invalid before being
further processing.
|
public static CorsConfigBuilder forAnyOrigin()
public static CorsConfigBuilder forOrigin(java.lang.String origin)
CorsConfigBuilder
instance with the specified origin.CorsConfigBuilder
to support method chaining.public static CorsConfigBuilder forPattern(java.util.regex.Pattern pattern)
CorsConfigBuilder
instance with the specified pattern origin.pattern
- the regular expression pattern to match incoming origins on.CorsConfigBuilder
with the configured origin pattern.public static CorsConfigBuilder forOrigins(java.lang.String... origins)
CorsConfigBuilder
instance with the specified origins.CorsConfigBuilder
to support method chaining.public CorsConfigBuilder disable()
CorsConfigBuilder
to support method chaining.public CorsConfigBuilder allowCredentials()
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.
CorsConfigBuilder
to support method chaining.public CorsConfigBuilder maxAge(long max)
max
- the maximum time, in seconds, that the preflight response may be cached.CorsConfigBuilder
to support method chaining.public CorsConfigBuilder allowedRequestMethods(org.jboss.netty.handler.codec.http.HttpMethod... methods)
methods
- the HttpMethod
s that should be allowed.CorsConfigBuilder
to support method chaining.public CorsConfigBuilder allowedRequestHeaders(java.lang.String... headers)
xhr.setRequestHeader('My-Custom-Header', "SomeValue");the server will receive the above header name in the 'Access-Control-Request-Headers' of the preflight request. The server will then decide if it allows this header to be sent for the real request (remember that a preflight is not the real request but a request asking the server if it allow a request).
headers
- the headers to be added to the preflight 'Access-Control-Allow-Headers' response header.CorsConfigBuilder
to support method chaining.public CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name, java.lang.Object... values)
name
- the name of the HTTP header.values
- the values for the HTTP header.CorsConfigBuilder
to support method chaining.public <T> CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name, java.lang.Iterable<T> value)
T
- the type of values that the Iterable contains.name
- the name of the HTTP header.value
- the values for the HTTP header.CorsConfigBuilder
to support method chaining.public <T> CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name, java.util.concurrent.Callable<T> valueGenerator)
T
- the type of the value that the Callable can return.name
- the name of the HTTP header.valueGenerator
- a Callable which will be invoked at HTTP response creation.CorsConfigBuilder
to support method chaining.public CorsConfigBuilder noPreflightResponseHeaders()
CorsConfigBuilder
to support method chaining.public CorsConfigBuilder shortCircuit()
CorsConfigBuilder
to support method chaining.public CorsConfig build()
CorsConfig
with settings specified by previous method calls.CorsConfig
the configured CorsConfig instance.