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 final record 
    OidcRequestFilter.OidcRequestContext
    OIDC request context which provides access to the HTTP request headers and body, as well as context properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    filter(OidcRequestFilter.OidcRequestContext requestContext)
    Filter OIDC request.
    default void
    filter(io.vertx.mutiny.ext.web.client.HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request, io.vertx.mutiny.core.buffer.Buffer requestBody, OidcRequestContextProperties contextProperties)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use filter(OidcRequestContext)

  • Method Details

    • filter

      default void filter(OidcRequestFilter.OidcRequestContext requestContext)
      Filter OIDC request.
      Parameters:
      requestContext - the request context which provides access to the HTTP request headers and body, as well as context properties.

    • filter

      @Deprecated(forRemoval=true) default void filter(io.vertx.mutiny.ext.web.client.HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request, io.vertx.mutiny.core.buffer.Buffer requestBody, OidcRequestContextProperties contextProperties)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use filter(OidcRequestContext)
      Filter OIDC requests
      Parameters:
      request - HTTP request that can have its headers customized
      requestBody - request body, will be null for HTTP GET methods, may be null for other HTTP methods
      contextProperties - context properties that can be available in context of some requests