Package io.quarkus.oidc

Class OidcTenantConfig.Backchannel

java.lang.Object
io.quarkus.oidc.OidcTenantConfig.Backchannel
All Implemented Interfaces:
OidcTenantConfig.Backchannel
Enclosing class:
OidcTenantConfig
@Deprecated(since="3.18", forRemoval=true) public static class OidcTenantConfig.Backchannel extends Object implements OidcTenantConfig.Backchannel
Deprecated, for removal: This API element is subject to removal in a future version.
use the
invalid reference 
OidcTenantConfigBuilder.BackchannelBuilder
builder

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Optional<Duration>
    cleanUpTimerInterval
    Deprecated, for removal: This API element is subject to removal in a future version.
    Token cache timer interval.
    String
    logoutTokenKey
    Deprecated, for removal: This API element is subject to removal in a future version.
    Logout token claim whose value is used as a key for caching the tokens.
    Optional<String>
    path
    Deprecated, for removal: This API element is subject to removal in a future version.
    The relative path of the Back-Channel Logout endpoint at the application.
    int
    tokenCacheSize
    Deprecated, for removal: This API element is subject to removal in a future version.
    Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
    Duration
    tokenCacheTimeToLive
    Deprecated, for removal: This API element is subject to removal in a future version.
    Number of minutes a logout token can be cached for.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Backchannel()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Duration>
    cleanUpTimerInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Token cache timer interval.
    Optional<Duration>
    getCleanUpTimerInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getLogoutTokenKey()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<String>
    getPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getTokenCacheSize()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Duration
    getTokenCacheTimeToLive()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    logoutTokenKey()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Logout token claim whose value is used as a key for caching the tokens.
    Optional<String>
    path()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The relative path of the Back-Channel Logout endpoint at the application.
    void
    setCleanUpTimerInterval(Duration cleanUpTimerInterval)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setLogoutTokenKey(String logoutTokenKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setPath(Optional<String> path)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTokenCacheSize(int tokenCacheSize)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTokenCacheTimeToLive(Duration tokenCacheTimeToLive)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    tokenCacheSize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
    Duration
    tokenCacheTimeToLive()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Number of minutes a logout token can be cached for.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • path

      public Optional<String> path
      Deprecated, for removal: This API element is subject to removal in a future version.
      The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.

    • tokenCacheSize

      public int tokenCacheSize
      Deprecated, for removal: This API element is subject to removal in a future version.
      Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.

    • tokenCacheTimeToLive

      public Duration tokenCacheTimeToLive
      Deprecated, for removal: This API element is subject to removal in a future version.
      Number of minutes a logout token can be cached for.

    • cleanUpTimerInterval

      public Optional<Duration> cleanUpTimerInterval
      Deprecated, for removal: This API element is subject to removal in a future version.
      Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.

    • logoutTokenKey

      public String logoutTokenKey
      Deprecated, for removal: This API element is subject to removal in a future version.
      Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.

  • Constructor Details

    • Backchannel

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

  • Method Details

    • setPath

      public void setPath(Optional<String> path)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPath

      public Optional<String> getPath()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getLogoutTokenKey

      public String getLogoutTokenKey()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setLogoutTokenKey

      public void setLogoutTokenKey(String logoutTokenKey)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTokenCacheSize

      public int getTokenCacheSize()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTokenCacheSize

      public void setTokenCacheSize(int tokenCacheSize)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTokenCacheTimeToLive

      public Duration getTokenCacheTimeToLive()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTokenCacheTimeToLive

      public void setTokenCacheTimeToLive(Duration tokenCacheTimeToLive)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCleanUpTimerInterval

      public Optional<Duration> getCleanUpTimerInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCleanUpTimerInterval

      public void setCleanUpTimerInterval(Duration cleanUpTimerInterval)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • path

      public Optional<String> path()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Backchannel
      The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.
      Specified by:
      path in interface OidcTenantConfig.Backchannel

    • tokenCacheSize

      public int tokenCacheSize()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Backchannel
      Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
      Specified by:
      tokenCacheSize in interface OidcTenantConfig.Backchannel

    • tokenCacheTimeToLive

      public Duration tokenCacheTimeToLive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Backchannel
      Number of minutes a logout token can be cached for.
      Specified by:
      tokenCacheTimeToLive in interface OidcTenantConfig.Backchannel

    • cleanUpTimerInterval

      public Optional<Duration> cleanUpTimerInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Backchannel
      Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.
      Specified by:
      cleanUpTimerInterval in interface OidcTenantConfig.Backchannel

    • logoutTokenKey

      public String logoutTokenKey()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Backchannel
      Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.
      Specified by:
      logoutTokenKey in interface OidcTenantConfig.Backchannel