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_AUTHENTICATION_SESSION_ID
static final String	MDC_KEY_AUTHENTICATION_TAB_ID
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_NAME
static final String	MDC_KEY_SESSION_ID
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()
MappedDiagnosticContextProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()
String	getId()
void	init(Config.Scope config)
boolean	isSupported(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)
protected void	putMdc(String key, String value)
void	update(KeycloakContext keycloakContext, ClientModel client)
void	update(KeycloakContext keycloakContext, OrganizationModel organization)
void	update(KeycloakContext keycloakContext, RealmModel realm)
void	update(KeycloakContext keycloakContext, UserSessionModel userSession)
void	update(KeycloakContext keycloakContext, AuthenticationSessionModel session)

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_NAME

public static final String MDC_KEY_REALM_NAME

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_KEY_SESSION_ID

public static final String MDC_KEY_SESSION_ID

See Also:

• Constant Field Values

MDC_KEY_AUTHENTICATION_SESSION_ID

public static final String MDC_KEY_AUTHENTICATION_SESSION_ID

See Also:

• Constant Field Values

MDC_KEY_AUTHENTICATION_TAB_ID

public static final String MDC_KEY_AUTHENTICATION_TAB_ID

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)

Specified by:

init in interface ProviderFactory<MappedDiagnosticContextProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<MappedDiagnosticContextProvider>

close

public void close()

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()

Specified by:

getConfigMetadata in interface ProviderFactory<MappedDiagnosticContextProvider>

isSupported

public boolean isSupported(Config.Scope config)

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

update

public void update(KeycloakContext keycloakContext,
 AuthenticationSessionModel session)

Specified by:

update in interface MappedDiagnosticContextProvider

update

public void update(KeycloakContext keycloakContext,
 RealmModel realm)

Specified by:

update in interface MappedDiagnosticContextProvider

update

public void update(KeycloakContext keycloakContext,
 ClientModel client)

Specified by:

update in interface MappedDiagnosticContextProvider

update

public void update(KeycloakContext keycloakContext,
 OrganizationModel organization)

Specified by:

update in interface MappedDiagnosticContextProvider

update

public void update(KeycloakContext keycloakContext,
 UserSessionModel userSession)

Specified by:

update in interface MappedDiagnosticContextProvider

putMdc

protected void putMdc(String key,
 String value)