Package org.keycloak.services.logging

Class DefaultMappedDiagnosticContextProviderFactory

java.lang.Object

org.keycloak.services.logging.DefaultMappedDiagnosticContextProviderFactory

All Implemented Interfaces:

MappedDiagnosticContextProvider, MappedDiagnosticContextProviderFactory, EnvironmentDependentProviderFactory, Provider, ProviderFactory<MappedDiagnosticContextProvider>

public class DefaultMappedDiagnosticContextProviderFactory
extends Object
implements MappedDiagnosticContextProviderFactory, MappedDiagnosticContextProvider, EnvironmentDependentProviderFactory

The default provider factory can be configured via --spi-mapped-diagnostic-context-default-mdc-keys to define mdc keys to add as a comma-separated list. By default, "realm", "clientId", "userId", "ipAddress" and "org" are supported by the default provider implementation. If you need further keys, you need to extend the provider.

Author:

Björn Eickvonder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MDC_KEY_CLIENT_ID
static final String	MDC_KEY_IP_ADDRESS
static final String	MDC_KEY_ORGANIZATION
static final String	MDC_KEY_REALM
static final String	MDC_KEY_USER_ID
static final String	MDC_KEYS

Fields inherited from interface org.keycloak.logging.MappedDiagnosticContextProvider

MDC_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultMappedDiagnosticContextProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
MappedDiagnosticContextProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
protected void	putMdc(String key, String value)
void	update(KeycloakContext keycloakContext, ClientModel client)	Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
void	update(KeycloakContext keycloakContext, OrganizationModel organization)	Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
void	update(KeycloakContext keycloakContext, RealmModel realm)	Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
void	update(KeycloakContext keycloakContext, UserSessionModel userSession)	Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.
void	update(KeycloakContext keycloakContext, AuthenticationSessionModel session)	Updates the Mapped Diagnostic Context (MDC) with key/value pairs based on the current Keycloak context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, order

Field Details

MDC_KEY_REALM

public static final String MDC_KEY_REALM

See Also:

• Constant Field Values

MDC_KEY_CLIENT_ID

public static final String MDC_KEY_CLIENT_ID

See Also:

• Constant Field Values

MDC_KEY_USER_ID

public static final String MDC_KEY_USER_ID

See Also:

• Constant Field Values

MDC_KEY_IP_ADDRESS

public static final String MDC_KEY_IP_ADDRESS

See Also:

• Constant Field Values

MDC_KEY_ORGANIZATION

public static final String MDC_KEY_ORGANIZATION

See Also:

• Constant Field Values

MDC_KEYS

public static final String MDC_KEYS

See Also:

• Constant Field Values

Constructor Details

DefaultMappedDiagnosticContextProviderFactory

public DefaultMappedDiagnosticContextProviderFactory()

Method Details

create

public MappedDiagnosticContextProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<MappedDiagnosticContextProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<MappedDiagnosticContextProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<MappedDiagnosticContextProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<MappedDiagnosticContextProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<MappedDiagnosticContextProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<MappedDiagnosticContextProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

update

public void update(KeycloakContext keycloakContext,
 AuthenticationSessionModel session)

Description copied from interface: MappedDiagnosticContextProvider

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.

Specified by:

update in interface MappedDiagnosticContextProvider

Parameters:

keycloakContext - the current Keycloak context, never null

session - the authentication session

update

public void update(KeycloakContext keycloakContext,
 RealmModel realm)

Description copied from interface: MappedDiagnosticContextProvider

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.

Specified by:

update in interface MappedDiagnosticContextProvider

Parameters:

keycloakContext - the current Keycloak context, never null

realm - the realm

update

public void update(KeycloakContext keycloakContext,
 ClientModel client)

Description copied from interface: MappedDiagnosticContextProvider

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.

Specified by:

update in interface MappedDiagnosticContextProvider

Parameters:

keycloakContext - the current Keycloak context, never null

client - the client

update

public void update(KeycloakContext keycloakContext,
 OrganizationModel organization)

Description copied from interface: MappedDiagnosticContextProvider

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.

Specified by:

update in interface MappedDiagnosticContextProvider

Parameters:

keycloakContext - the current Keycloak context, never null

organization - the organization

update

public void update(KeycloakContext keycloakContext,
 UserSessionModel userSession)

Description copied from interface: MappedDiagnosticContextProvider

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.

Specified by:

update in interface MappedDiagnosticContextProvider

Parameters:

keycloakContext - the current Keycloak context, never null

userSession - the user session

putMdc

protected void putMdc(String key,
 String value)