Package org.keycloak.logging

Interface MappedDiagnosticContextProvider

All Superinterfaces:
org.keycloak.provider.Provider
All Known Implementing Classes:
NoopMappedDiagnosticContextProvider
public interface MappedDiagnosticContextProvider extends org.keycloak.provider.Provider
Provider interface for updating the Mapped Diagnostic Context (MDC) with key/value pairs based on the current keycloak context. All keys in the MDC will be prefixed with "kc." to avoid conflicts.
Author:
Björn Eickvonder

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MDC_PREFIX
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.ClientModel client)
    Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
    void
    update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.OrganizationModel organization)
    Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
    void
    update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.RealmModel realm)
    Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
    void
    update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.UserSessionModel userSession)
    Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
    void
    update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.sessions.AuthenticationSessionModel session)
    Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Field Details

  • Method Details

    • update

      void update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.sessions.AuthenticationSessionModel session)
      Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context. This method is called when a Keycloak Session is set and when the authentication session property of the Keycloak context is updated.
      Parameters:
      keycloakContext - the current Keycloak context, never null
      session - the authentication session

    • update

      void update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.RealmModel realm)
      Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context. This method is called when a Keycloak Session is set and when the realm property of the Keycloak context is updated.
      Parameters:
      keycloakContext - the current Keycloak context, never null
      realm - the realm

    • update

      void update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.ClientModel client)
      Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context. This method is called when a Keycloak Session is set and when the client property of the Keycloak context is updated.
      Parameters:
      keycloakContext - the current Keycloak context, never null
      client - the client

    • update

      void update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.OrganizationModel organization)
      Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context. This method is called when a Keycloak Session is set and when the organization property of the Keycloak context is updated.
      Parameters:
      keycloakContext - the current Keycloak context, never null
      organization - the organization

    • update

      void update(org.keycloak.models.KeycloakContext keycloakContext, org.keycloak.models.UserSessionModel userSession)
      Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context. This method is called when a Keycloak Session is set and when the user session property of the Keycloak context is updated.
      Parameters:
      keycloakContext - the current Keycloak context, never null
      userSession - the user session