Package io.netty.handler.codec.http.cors
Class CorsConfigBuilder
java.lang.Object
io.netty.handler.codec.http.cors.CorsConfigBuilder
Builder used to configure and build a
CorsConfig
instance.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
This class is used for preflight HTTP response values that do not need to be generated, but instead the value is "static" in that the same value will be returned for each call.private static final class
This callable is used for the DATE preflight HTTP response HTTP header. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) boolean
(package private) boolean
(package private) boolean
(package private) final boolean
(package private) boolean
(package private) long
private boolean
(package private) final Map
<CharSequence, Callable<?>> (package private) final Set
<HttpMethod> (package private) boolean
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new Builder instance allowing any origin, "*" which is the wildcard origin.CorsConfigBuilder
(String... origins) Creates a new Builder instance with the origin passed in. -
Method Summary
Modifier and TypeMethodDescriptionBy default cookies are not included in CORS requests, but this method will enable cookies to be added to CORS requests.allowedRequestHeaders
(CharSequence... headers) Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header.allowedRequestHeaders
(String... headers) Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header.allowedRequestMethods
(HttpMethod... methods) Specifies the allowed set of HTTP Request Methods that should be returned in the CORS 'Access-Control-Request-Method' response header.Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system.Web browsers may set the 'Access-Control-Request-Private-Network' request header if a resource is loaded from a local network.build()
Builds aCorsConfig
with settings specified by previous method calls.disable()
Disables CORS support.exposeHeaders
(CharSequence... headers) Specifies the headers to be exposed to calling clients.exposeHeaders
(String... headers) Specifies the headers to be exposed to calling clients.static CorsConfigBuilder
Creates a Builder instance with it's origin set to '*'.static CorsConfigBuilder
Creates aCorsConfigBuilder
instance with the specified origin.static CorsConfigBuilder
forOrigins
(String... origins) Creates aCorsConfigBuilder
instance with the specified origins.maxAge
(long max) When making a preflight request the client has to perform two request with can be inefficient.Specifies that no preflight response headers should be added to a preflight response.preflightResponseHeader
(CharSequence name, Iterable<T> value) Returns HTTP response headers that should be added to a CORS preflight response.preflightResponseHeader
(CharSequence name, Object... values) Returns HTTP response headers that should be added to a CORS preflight response.preflightResponseHeader
(CharSequence name, Callable<T> valueGenerator) Returns HTTP response headers that should be added to a CORS preflight response.Specifies that a CORS request should be rejected if it's invalid before being further processing.
-
Field Details
-
origins
-
anyOrigin
final boolean anyOrigin -
allowNullOrigin
boolean allowNullOrigin -
enabled
boolean enabled -
allowCredentials
boolean allowCredentials -
exposeHeaders
-
maxAge
long maxAge -
requestMethods
-
requestHeaders
-
preflightHeaders
-
noPreflightHeaders
private boolean noPreflightHeaders -
shortCircuit
boolean shortCircuit -
allowPrivateNetwork
boolean allowPrivateNetwork
-
-
Constructor Details
-
CorsConfigBuilder
CorsConfigBuilder(String... origins) Creates a new Builder instance with the origin passed in.- Parameters:
origins
- the origin to be used for this builder.
-
CorsConfigBuilder
CorsConfigBuilder()Creates a new Builder instance allowing any origin, "*" which is the wildcard origin.
-
-
Method Details
-
forAnyOrigin
Creates a Builder instance with it's origin set to '*'.- Returns:
- Builder to support method chaining.
-
forOrigin
Creates aCorsConfigBuilder
instance with the specified origin.- Returns:
CorsConfigBuilder
to support method chaining.
-
forOrigins
Creates aCorsConfigBuilder
instance with the specified origins.- Returns:
CorsConfigBuilder
to support method chaining.
-
allowNullOrigin
Web browsers may set the 'Origin' request header to 'null' if a resource is loaded from the local file system. Calling this method will enable a successful CORS response with a"null"
value for the CORS response header 'Access-Control-Allow-Origin'.- Returns:
CorsConfigBuilder
to support method chaining.
-
disable
Disables CORS support.- Returns:
CorsConfigBuilder
to support method chaining.
-
exposeHeaders
Specifies the 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
- Parameters:
headers
- the values to be added to the 'Access-Control-Expose-Headers' response header- Returns:
CorsConfigBuilder
to support method chaining.
-
exposeHeaders
Specifies the 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(HttpHeaderNames.CONTENT_TYPE);
The headers that are available by default are:- Cache-Control
- Content-Language
- Content-Type
- Expires
- Last-Modified
- Pragma
- Parameters:
headers
- the values to be added to the 'Access-Control-Expose-Headers' response header- Returns:
CorsConfigBuilder
to support method chaining.
-
allowCredentials
By default cookies are not included in CORS requests, but this method will enable cookies to be added to CORS requests. Calling this method 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:
CorsConfigBuilder
to support method chaining.
-
maxAge
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.- Parameters:
max
- the maximum time, in seconds, that the preflight response may be cached.- Returns:
CorsConfigBuilder
to support method chaining.
-
allowedRequestMethods
Specifies the allowed set of HTTP Request Methods that should be returned in the CORS 'Access-Control-Request-Method' response header.- Parameters:
methods
- theHttpMethod
s that should be allowed.- Returns:
CorsConfigBuilder
to support method chaining.
-
allowedRequestHeaders
Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header. If a client specifies headers on the request, for example by calling: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).- Parameters:
headers
- the headers to be added to the preflight 'Access-Control-Allow-Headers' response header.- Returns:
CorsConfigBuilder
to support method chaining.
-
allowedRequestHeaders
Specifies the if headers that should be returned in the CORS 'Access-Control-Allow-Headers' response header. If a client specifies headers on the request, for example by calling: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).- Parameters:
headers
- the headers to be added to the preflight 'Access-Control-Allow-Headers' response header.- Returns:
CorsConfigBuilder
to support method chaining.
-
preflightResponseHeader
Returns HTTP response headers that should be added to a CORS preflight response. An intermediary like a load balancer might require that a CORS preflight request have certain headers set. This enables such headers to be added.- Parameters:
name
- the name of the HTTP header.values
- the values for the HTTP header.- Returns:
CorsConfigBuilder
to support method chaining.
-
preflightResponseHeader
Returns HTTP response headers that should be added to a CORS preflight response. An intermediary like a load balancer might require that a CORS preflight request have certain headers set. This enables such headers to be added.- Type Parameters:
T
- the type of values that the Iterable contains.- Parameters:
name
- the name of the HTTP header.value
- the values for the HTTP header.- Returns:
CorsConfigBuilder
to support method chaining.
-
preflightResponseHeader
Returns HTTP response headers that should be added to a CORS preflight response. An intermediary like a load balancer might require that a CORS preflight request have certain headers set. This enables such headers to be added. Some values must be dynamically created when the HTTP response is created, for example the 'Date' response header. This can be accomplished by using a Callable which will have its 'call' method invoked when the HTTP response is created.- Type Parameters:
T
- the type of the value that the Callable can return.- Parameters:
name
- the name of the HTTP header.valueGenerator
- a Callable which will be invoked at HTTP response creation.- Returns:
CorsConfigBuilder
to support method chaining.
-
noPreflightResponseHeaders
Specifies that no preflight response headers should be added to a preflight response.- Returns:
CorsConfigBuilder
to support method chaining.
-
shortCircuit
Specifies that 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:
CorsConfigBuilder
to support method chaining.
-
allowPrivateNetwork
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. Calling this method will set the CORS 'Access-Control-Request-Private-Network' response header to true.- Returns:
CorsConfigBuilder
to support method chaining.
-
build
Builds aCorsConfig
with settings specified by previous method calls.- Returns:
CorsConfig
the configured CorsConfig instance.
-