Package io.quarkus.vertx.http.security

Class CORS.Builder

java.lang.Object

io.quarkus.vertx.http.security.CORS.Builder

Enclosing interface:

CORS

public static final class CORS.Builder
extends Object

The Quarkus CORS filter configuration builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	CORS.Builder.CORSImpl

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(CORSConfig corsConfig)

Method Summary

Modifier and Type	Method	Description
CORS.Builder	accessControlAllowCredentials()	This method is a shortcut for accessControlAllowCredentials(true).
CORS.Builder	accessControlAllowCredentials(boolean accessControlAllowCredentials)
CORS.Builder	accessControlMaxAge(Duration accessControlMaxAge)
CORS	build()	Create a new CORS configuration.
CORS.Builder	exposedHeader(String exposedHeader)	This method is a shortcut for exposedHeaders(Set.of(exposedHeader)).
CORS.Builder	exposedHeaders(Set<String> exposedHeaders)
CORS.Builder	header(String header)	This method is a shortcut for headers(Set.of(header)).
CORS.Builder	headers(Set<String> newHeaders)
CORS.Builder	method(String method)	This method is a shortcut for methods(Set.of(method)).
CORS.Builder	methods(Set<String> newMethods)
CORS.Builder	origin(String origin)	This method is a shortcut for origins(Set.of(origin)).
CORS.Builder	origins(Set<String> newOrigins)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Builder

public Builder(CORSConfig corsConfig)

Method Details

accessControlMaxAge

public CORS.Builder accessControlMaxAge(Duration accessControlMaxAge)

Parameters:

accessControlMaxAge - CORSConfig.accessControlMaxAge()

Returns:

this builder

accessControlAllowCredentials

public CORS.Builder accessControlAllowCredentials()

This method is a shortcut for accessControlAllowCredentials(true).

Returns:

this builder

accessControlAllowCredentials

public CORS.Builder accessControlAllowCredentials(boolean accessControlAllowCredentials)

Parameters:

accessControlAllowCredentials - CORSConfig.accessControlAllowCredentials()

Returns:

this builder

exposedHeader

public CORS.Builder exposedHeader(String exposedHeader)

This method is a shortcut for exposedHeaders(Set.of(exposedHeader)).

Returns:

this builder

exposedHeaders

public CORS.Builder exposedHeaders(Set<String> exposedHeaders)

Parameters:

exposedHeaders - CORSConfig.exposedHeaders()

Returns:

this builder

header

public CORS.Builder header(String header)

This method is a shortcut for headers(Set.of(header)).

Returns:

this builder

headers

public CORS.Builder headers(Set<String> newHeaders)

Parameters:

newHeaders - CORSConfig.headers()

Returns:

this builder

method

public CORS.Builder method(String method)

This method is a shortcut for methods(Set.of(method)).

Returns:

this builder

methods

public CORS.Builder methods(Set<String> newMethods)

Parameters:

newMethods - CORSConfig.methods()

Returns:

this builder

origin

public CORS.Builder origin(String origin)

This method is a shortcut for origins(Set.of(origin)).

Returns:

this builder

origins

public CORS.Builder origins(Set<String> newOrigins)

Parameters:

newOrigins - CORSConfig.origins()

Returns:

this builder

build

public CORS build()

Create a new CORS configuration.

Returns:

CORS instance, which should be passed to the HttpSecurity event