Package org.keycloak.services.cors

Interface Cors

All Superinterfaces:

Provider

All Known Implementing Classes:

DefaultCors

public interface Cors
extends Provider

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_CONTROL_ALLOW_CREDENTIALS
static final String	ACCESS_CONTROL_ALLOW_HEADERS
static final String	ACCESS_CONTROL_ALLOW_METHODS
static final String	ACCESS_CONTROL_ALLOW_ORIGIN
static final String	ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD
static final String	ACCESS_CONTROL_EXPOSE_HEADERS
static final String	ACCESS_CONTROL_MAX_AGE
static final String	AUTHORIZATION_HEADER
static final String	DEFAULT_ALLOW_HEADERS
static final String	DEFAULT_ALLOW_METHODS
static final long	DEFAULT_MAX_AGE
static final String	INCLUDE_REDIRECTS
static final String	ORIGIN_HEADER

Method Summary

Modifier and Type	Method	Description
static Cors	add(HttpRequest request)
static Cors	add(HttpRequest request, jakarta.ws.rs.core.Response.ResponseBuilder response)
Cors	addExposedHeaders(String... exposedHeaders)
Cors	allowAllOrigins()
Cors	allowedMethods(String... allowedMethods)
Cors	allowedOrigins(String... allowedOrigins)
Cors	allowedOrigins(KeycloakSession session, ClientModel client)
Cors	allowedOrigins(AccessToken token)
Cors	auth()
jakarta.ws.rs.core.Response	build()
boolean	build(BiConsumer<String,String> addHeader)
boolean	build(HttpResponse response)
Cors	builder(jakarta.ws.rs.core.Response.ResponseBuilder builder)
Cors	exposedHeaders(String... exposedHeaders)
Cors	preflight()
Cors	request(HttpRequest request)

Methods inherited from interface org.keycloak.provider.Provider

close

Field Details

DEFAULT_MAX_AGE

static final long DEFAULT_MAX_AGE

DEFAULT_ALLOW_METHODS

static final String DEFAULT_ALLOW_METHODS

See Also:

• Constant Field Values

DEFAULT_ALLOW_HEADERS

static final String DEFAULT_ALLOW_HEADERS

See Also:

• Constant Field Values

ORIGIN_HEADER

static final String ORIGIN_HEADER

See Also:

• Constant Field Values

AUTHORIZATION_HEADER

static final String AUTHORIZATION_HEADER

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

static final String ACCESS_CONTROL_ALLOW_ORIGIN

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_METHODS

static final String ACCESS_CONTROL_ALLOW_METHODS

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_HEADERS

static final String ACCESS_CONTROL_ALLOW_HEADERS

See Also:

• Constant Field Values

ACCESS_CONTROL_EXPOSE_HEADERS

static final String ACCESS_CONTROL_EXPOSE_HEADERS

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_CREDENTIALS

static final String ACCESS_CONTROL_ALLOW_CREDENTIALS

See Also:

• Constant Field Values

ACCESS_CONTROL_MAX_AGE

static final String ACCESS_CONTROL_MAX_AGE

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD

static final String ACCESS_CONTROL_ALLOW_ORIGIN_WILDCARD

See Also:

• Constant Field Values

INCLUDE_REDIRECTS

static final String INCLUDE_REDIRECTS

See Also:

• Constant Field Values

Method Details

add

static Cors add(HttpRequest request,
 jakarta.ws.rs.core.Response.ResponseBuilder response)

add

static Cors add(HttpRequest request)

request

Cors request(HttpRequest request)

builder

Cors builder(jakarta.ws.rs.core.Response.ResponseBuilder builder)

preflight

Cors preflight()

auth

Cors auth()

allowAllOrigins

Cors allowAllOrigins()

allowedOrigins

Cors allowedOrigins(KeycloakSession session,
 ClientModel client)

allowedOrigins

Cors allowedOrigins(AccessToken token)

allowedOrigins

Cors allowedOrigins(String... allowedOrigins)

allowedMethods

Cors allowedMethods(String... allowedMethods)

exposedHeaders

Cors exposedHeaders(String... exposedHeaders)

addExposedHeaders

Cors addExposedHeaders(String... exposedHeaders)

build

jakarta.ws.rs.core.Response build()

build

boolean build(HttpResponse response)

build

boolean build(BiConsumer<String,String> addHeader)