Interface AccessTokenHealthProvider

All Known Subinterfaces:
AccessTokenProvider
All Known Implementing Classes:
AbstractAccessTokenHealthProvider, AbstractCachedAccessTokenProvider, AbstractStatefulUrlAccessTokenProvider, AbstractUrlAccessTokenProvider, BaseAccessTokenProvider, DefaultAccessTokenHealthProvider, DefaultCachedAccessTokenProvider, EagerAccessTokenHealthProvider, PreemptiveCachedAccessTokenProvider, RetryingAccessTokenProvider, StatefulUrlAccessTokenProvider, UrlAccessTokenProvider

public interface AccessTokenHealthProvider
  • Method Summary

    Modifier and Type
    Method
    Description
    getHealth(boolean refresh)
    Get health.
    boolean
     
  • Method Details

    • getHealth

      default AccessTokenHealth getHealth(boolean refresh)
      Get health. An implementation is expected to refresh the health status if there is no current status, or if the last status was unsuccessful.
      Parameters:
      refresh - true if the provider (optionally) can refresh the state before returning (typically if the health is missing or bad)
      Returns:
      health status, or null if none is available.
      Throws:
      AccessTokenHealthNotSupportedException - if operation is not supported
    • supportsHealth

      boolean supportsHealth()