Package io.quarkus.oidc.common

Interface OidcRequestFilter

public interface OidcRequestFilter

Request filter which can be used to customize requests such as the verification JsonWebKey set and token grant requests which are made from the OIDC adapter to the OIDC provider.

Filter can be restricted to a specific OIDC endpoint with a OidcEndpoint annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OidcRequestFilter.OidcRequestContext	OIDC request context which provides access to the HTTP request headers and body, as well as context properties.
static class	OidcRequestFilter.OidcRequestFilterContext

Method Summary

Modifier and Type	Method	Description
default void	filter(OidcRequestFilter.OidcRequestContext requestContext)	Deprecated, for removal: This API element is subject to removal in a future version. use the filter(OidcRequestContext) method instead
default io.smallrye.mutiny.Uni<Void>	filter(OidcRequestFilter.OidcRequestFilterContext requestContext)	Filter OIDC request asynchronously.

Method Details

filter

@Deprecated(since="3.31",
            forRemoval=true)
default void filter(OidcRequestFilter.OidcRequestContext requestContext)

Deprecated, for removal: This API element is subject to removal in a future version.

use the filter(OidcRequestContext) method instead

Filter OIDC request.

Parameters:

requestContext - the request context which provides access to the HTTP request headers and body, as well as context properties.

filter

default io.smallrye.mutiny.Uni<Void> filter(OidcRequestFilter.OidcRequestFilterContext requestContext)

Filter OIDC request asynchronously. Blocking tasks can be run with the OidcRequestFilter.OidcRequestFilterContext.runBlocking(Runnable) method.

Parameters:

requestContext - the request context which provides access to the HTTP request headers and body, as well as context properties.

Returns:

Uni; must not be null