Interface OidcObserver

All Superinterfaces:
JoseObserver, OAuthObserver

@ThreadSafe public interface OidcObserver extends OAuthObserver
Receives caller-thread OIDC events and the inherited OAuth/JOSE endpoint events. Hooks carry no tokens or claims. Hook failures are contained except for VirtualMachineError; implementations must be thread-safe and fast.
Since:
1.0.0
Author:
Mark Allen
  • Method Details

    • disabledInstance

      Returns a silent observer.
      Returns:
      the disabled observer
      Since:
      1.0.0
    • didEnableCompatibilityMode

      Called after a client successfully builds with an explicit compatibility mode.
      Parameters:
      mode - enabled mode; no credential is passed
      Since:
      1.0.0
    • didUseCompatibilityMode

      Called when validation uses the mode, including when its signature or later checks fail.
      Parameters:
      mode - used mode; no credential or token is passed
      Since:
      1.0.0
    • didRejectIdToken

      Called when an ID token or OIDC token response fails validation, before token release.
      Parameters:
      exception - the same fixed-message exception the caller receives
      Since:
      1.0.0
    • didCompleteAuthentication

      default void didCompleteAuthentication()
      Called after successful OIDC validation. No identity or credential is passed.
      Since:
      1.0.0
    • didRejectUserInfo

      Called when a UserInfo response fails profile validation. No claims or credentials are passed.
      Parameters:
      exception - fixed-message rejection
      Since:
      1.0.0
    • didFetchUserInfo

      default void didFetchUserInfo(@NonNull Boolean signed)
      Called after the UserInfo subject matches the verified authentication.
      Parameters:
      signed - whether a signed response was validated
      Since:
      1.0.0
    • didRejectRefresh

      Called when refresh profile/continuity checks reject. No endpoint credential or rejected claim is passed.
      Parameters:
      exception - fixed-message rejection
      Since:
      1.0.0
    • didRefreshTokens

      default void didRefreshTokens(@NonNull Boolean idTokenReturned, @NonNull Boolean refreshTokenReturned)
      Called after refresh tokens are released following all required ID-token checks.
      Parameters:
      idTokenReturned - whether a new verified ID token was returned
      refreshTokenReturned - whether the endpoint supplied a replacement refresh token
      Since:
      1.0.0
    • didEnableMicrosoftEntraMultiTenant

      Called once after successful build selects the fixed Entra issuer policy.
      Since:
      1.0.0
    • didUseMicrosoftEntraMultiTenant

      Called when Entra ID-token validation or an authenticated UserInfo tenant check uses the selected policy, including rejected outcomes. No tenant or credential is supplied.
      Since:
      1.0.0