Package io.quarkus.oidc

Record Class OidcRedirectFilter.OidcRedirectContext

java.lang.Object
java.lang.Record
io.quarkus.oidc.OidcRedirectFilter.OidcRedirectContext
Enclosing interface:
OidcRedirectFilter
public static record OidcRedirectFilter.OidcRedirectContext(io.vertx.ext.web.RoutingContext routingContext, OidcTenantConfig oidcTenantConfig, String redirectUri, io.vertx.core.MultiMap additionalQueryParams) extends Record
OIDC redirect context which provides access to the routing context, current OIDC tenant configuration, redirect uri and additional query parameters. The additional query parameters are visible to all OIDC redirect filters. They are URL-encoded and added to the redirect URI after all the filters have run.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OidcRedirectContext(io.vertx.ext.web.RoutingContext routingContext, OidcTenantConfig oidcTenantConfig, String redirectUri, io.vertx.core.MultiMap additionalQueryParams)
    Creates an instance of a OidcRedirectContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.vertx.core.MultiMap
    additionalQueryParams()
    Returns the value of the additionalQueryParams record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    OidcTenantConfig
    oidcTenantConfig()
    Returns the value of the oidcTenantConfig record component.
    String
    redirectUri()
    Returns the value of the redirectUri record component.
    io.vertx.ext.web.RoutingContext
    routingContext()
    Returns the value of the routingContext record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OidcRedirectContext

      public OidcRedirectContext(io.vertx.ext.web.RoutingContext routingContext, OidcTenantConfig oidcTenantConfig, String redirectUri, io.vertx.core.MultiMap additionalQueryParams)
      Creates an instance of a OidcRedirectContext record class.
      Parameters:
      routingContext - the value for the routingContext record component
      oidcTenantConfig - the value for the oidcTenantConfig record component
      redirectUri - the value for the redirectUri record component
      additionalQueryParams - the value for the additionalQueryParams record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • routingContext

      public io.vertx.ext.web.RoutingContext routingContext()
      Returns the value of the routingContext record component.
      Returns:
      the value of the routingContext record component

    • oidcTenantConfig

      public OidcTenantConfig oidcTenantConfig()
      Returns the value of the oidcTenantConfig record component.
      Returns:
      the value of the oidcTenantConfig record component

    • redirectUri

      public String redirectUri()
      Returns the value of the redirectUri record component.
      Returns:
      the value of the redirectUri record component

    • additionalQueryParams

      public io.vertx.core.MultiMap additionalQueryParams()
      Returns the value of the additionalQueryParams record component.
      Returns:
      the value of the additionalQueryParams record component