ChainedCorsPolicyBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.server.cors.ChainedCorsPolicyBuilder

```
public final class ChainedCorsPolicyBuilder
extends Object
```
Builds a new CorsPolicy.
This class can only be created through the CorsServiceBuilder.andForOrigins(String...) or CorsServiceBuilder.andForOrigin(String) method of the CorsServiceBuilder.
Calling and() method will return the control to CorsServiceBuilder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChainedCorsPolicyBuilder`	`allowCredentials()` Enables cookies to be added to CORS requests.
`ChainedCorsPolicyBuilder`	`allowNullOrigin()` Enables a successful CORS response with a `"null"` value for the CORS response header `"Access-Control-Allow-Origin"`.
`ChainedCorsPolicyBuilder`	`allowRequestHeaders(CharSequence... headers)` Specifies the headers that should be returned in the CORS `"Access-Control-Allow-Headers"` response header.
`ChainedCorsPolicyBuilder`	`allowRequestHeaders(Iterable<? extends CharSequence> headers)` Specifies the headers that should be returned in the CORS `"Access-Control-Allow-Headers"` response header.
`ChainedCorsPolicyBuilder`	`allowRequestMethods(HttpMethod... methods)` Specifies the allowed set of HTTP request methods that should be returned in the CORS `"Access-Control-Allow-Methods"` response header.
`ChainedCorsPolicyBuilder`	`allowRequestMethods(Iterable<HttpMethod> methods)` Specifies the allowed set of HTTP request methods that should be returned in the CORS `"Access-Control-Allow-Methods"` response header.
`CorsServiceBuilder`	`and()` Returns the parent `CorsServiceBuilder`.
`ChainedCorsPolicyBuilder`	`andForOrigin(String origin)` Creates a new instance of `ChainedCorsPolicyBuilder` added to the parent `CorsServiceBuilder`.
`ChainedCorsPolicyBuilder`	`andForOrigins(String... origins)` Creates a new instance of `ChainedCorsPolicyBuilder` added to the parent `CorsServiceBuilder`.
`ChainedCorsPolicyBuilder`	`disablePreflightResponseHeaders()` Specifies that no preflight response headers should be added to a preflight response.
`ChainedCorsPolicyBuilder`	`exposeHeaders(CharSequence... headers)` Specifies the headers to be exposed to calling clients.
`ChainedCorsPolicyBuilder`	`exposeHeaders(Iterable<? extends CharSequence> headers)` Specifies the headers to be exposed to calling clients.
`ChainedCorsPolicyBuilder`	`maxAge(long maxAge)` Sets the CORS `"Access-Control-Max-Age"` response header and enables the caching of the preflight response for the specified time.
`ChainedCorsPolicyBuilder`	`preflightResponseHeader(CharSequence name, Iterable<?> values)` Specifies HTTP response headers that should be added to a CORS preflight response.
`ChainedCorsPolicyBuilder`	`preflightResponseHeader(CharSequence name, Object... values)` Specifies HTTP response headers that should be added to a CORS preflight response.
`ChainedCorsPolicyBuilder`	`preflightResponseHeader(CharSequence name, Supplier<?> valueSupplier)` Specifies HTTP response headers that should be added to a CORS preflight response.
`ChainedCorsPolicyBuilder`	`route(String pathPattern)` Adds a path pattern that this policy is supposed to be applied to.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - and
```
public CorsServiceBuilder and()
```
    Returns the parent CorsServiceBuilder.
  - andForOrigins
```
public ChainedCorsPolicyBuilder andForOrigins(String... origins)
```
    Creates a new instance of ChainedCorsPolicyBuilder added to the parent CorsServiceBuilder.
    
    Returns:
    
    the created instance.
  - andForOrigin
```
public ChainedCorsPolicyBuilder andForOrigin(String origin)
```
    Creates a new instance of ChainedCorsPolicyBuilder added to the parent CorsServiceBuilder.
    
    Returns:
    
    the created instance.
  - route
```
public ChainedCorsPolicyBuilder route(String pathPattern)
```
    Adds a path pattern that this policy is supposed to be applied to.
    
    Parameters:
    
    pathPattern - the path pattern that this policy is supposed to be applied to
    
    Returns:
    
    this to support method chaining.
  - allowNullOrigin
```
public ChainedCorsPolicyBuilder allowNullOrigin()
```
    Enables a successful CORS response with a "null" value for the CORS response header "Access-Control-Allow-Origin". Web browsers may set the "Origin" request header to "null" if a resource is loaded from the local file system.
    
    Returns:
    
    this to support method chaining.
  - allowCredentials
```
public ChainedCorsPolicyBuilder allowCredentials()
```
    Enables cookies to be added to CORS requests. Calling this method will set the CORS "Access-Control-Allow-Credentials" response header to true. By default, cookies are not included in CORS requests.
    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 include cookies in cross origin requests.
    Returns:
    
    this to support method chaining.
  - maxAge
```
public ChainedCorsPolicyBuilder maxAge(long maxAge)
```
    Sets 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:
    
    maxAge - the maximum time, in seconds, that the preflight response may be cached.
    
    Returns:
    
    this to support method chaining.
  - exposeHeaders
```
public ChainedCorsPolicyBuilder exposeHeaders(CharSequence... headers)
```
    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
    To expose other headers they need to be specified which is what this method enables by adding the headers to the CORS "Access-Control-Expose-Headers" response header.
    Parameters:
    
    headers - the values to be added to the "Access-Control-Expose-Headers" response header
    
    Returns:
    
    this to support method chaining.
  - exposeHeaders
```
public ChainedCorsPolicyBuilder exposeHeaders(Iterable<? extends CharSequence> headers)
```
    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
    To expose other headers they need to be specified which is what this method enables by adding the headers to the CORS "Access-Control-Expose-Headers" response header.
    Parameters:
    
    headers - the values to be added to the "Access-Control-Expose-Headers" response header
    
    Returns:
    
    this to support method chaining.
  - allowRequestMethods
```
public ChainedCorsPolicyBuilder allowRequestMethods(HttpMethod... methods)
```
    Specifies the allowed set of HTTP request methods that should be returned in the CORS "Access-Control-Allow-Methods" response header.
    
    Parameters:
    
    methods - the HttpMethods that should be allowed.
    
    Returns:
    
    this to support method chaining.
  - allowRequestMethods
```
public ChainedCorsPolicyBuilder allowRequestMethods(Iterable<HttpMethod> methods)
```
    Specifies the allowed set of HTTP request methods that should be returned in the CORS "Access-Control-Allow-Methods" response header.
    
    Parameters:
    
    methods - the HttpMethods that should be allowed.
    
    Returns:
    
    this to support method chaining.
  - allowRequestHeaders
```
public ChainedCorsPolicyBuilder allowRequestHeaders(CharSequence... headers)
```
    Specifies the 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 allows a request).
    Parameters:
    
    headers - the headers to be added to the preflight "Access-Control-Allow-Headers" response header.
    
    Returns:
    
    this to support method chaining.
  - allowRequestHeaders
```
public ChainedCorsPolicyBuilder allowRequestHeaders(Iterable<? extends CharSequence> headers)
```
    Specifies the 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 allows a request).
    Parameters:
    
    headers - the headers to be added to the preflight "Access-Control-Allow-Headers" response header.
    
    Returns:
    
    this to support method chaining.
  - preflightResponseHeader
```
public ChainedCorsPolicyBuilder preflightResponseHeader(CharSequence name,
                                                        Object... values)
```
    Specifies 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:
    
    this to support method chaining.
  - preflightResponseHeader
```
public ChainedCorsPolicyBuilder preflightResponseHeader(CharSequence name,
                                                        Iterable<?> values)
```
    Specifies 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:
    
    this to support method chaining.
  - preflightResponseHeader
```
public ChainedCorsPolicyBuilder preflightResponseHeader(CharSequence name,
                                                        Supplier<?> valueSupplier)
```
    Specifies 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 Supplier which will have its Supplier.get() method invoked when the HTTP response is created.
    
    Parameters:
    
    name - the name of the HTTP header.
    
    valueSupplier - a Supplier which will be invoked at HTTP response creation.
    
    Returns:
    
    this to support method chaining.
  - disablePreflightResponseHeaders
```
public ChainedCorsPolicyBuilder disablePreflightResponseHeaders()
```
    Specifies that no preflight response headers should be added to a preflight response.
    
    Returns:
    
    this to support method chaining.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ChainedCorsPolicyBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

and

andForOrigins

andForOrigin

route

allowNullOrigin

allowCredentials

maxAge

exposeHeaders

exposeHeaders

allowRequestMethods

allowRequestMethods

allowRequestHeaders

allowRequestHeaders

preflightResponseHeader

preflightResponseHeader

preflightResponseHeader

disablePreflightResponseHeaders

toString