Custom SPI configuration in Keycloak 21 #19544

tobiasge · 2023-04-05T08:56:58Z

tobiasge
Apr 5, 2023

I noticed that the keys for configuration variables show some behaviour I don't understand.

spi-eventsListener-my-listener-my-option=MYVALUE in keycloak.conf
kc.bat show-config -> kc.spi-eventsListener-my-listener-my-option = MYVALUE (PropertiesConfigSource[source=file:/C:/Coding/Keycloak/keycloak-21.0.2/bin/../conf/keycloak.conf])
Config.Scope.getPropertyNames -> kc.spi-eventsListener-my-listener-my-option
Config.Scope.get("kc.spi-eventsListener-my-listener-my-option") -> null
Config.Scope.get("my-option") -> null
spi-eventsListener-my-listener-my-option=MYVALUE in keycloak.conf and env variable KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION="MYVALUE2"
kc.bat show-config -> kc.spi-eventsListener-my-listener-my-option = MYVALUE2 (KcEnvVarConfigSource)
Config.Scope.getPropertyNames -> kc.spi-eventsListener-my-listener-my-option, KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION
Config.Scope.get("kc.spi-eventsListener-my-listener-my-option") -> null
Config.Scope.get("KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION") -> null
Config.Scope.get("my-option") -> null
Only set env variable KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION="MYVALUE2"
kc.bat show-config -> kc.spi.eventslistener.my.listener.my.option = MYVALUE2 (KcEnvVarConfigSource)
Config.Scope.getPropertyNames -> kc.spi-eventsListener-my-listener-my-option, KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION
Config.Scope.get("kc.spi-eventsListener-my-listener-my-option") -> null
Config.Scope.get("KC_SPI_EVENTSLISTENER_MY_LISTENER_MY_OPTION") -> null
Config.Scope.get("my-option") -> null

How do I correctly access the configuration in EventListenerProviderFactory.init(Config.Scope config)?

Apr 17, 2023

The problem here is the SPI name "eventsListener". The options in the configuration file have to be "spi-events-listener-$providerid-$option" and not with "spi-eventsListener".

View full answer

tobiasge · 2023-04-17T11:45:57Z

tobiasge
Apr 17, 2023
Author

The problem here is the SPI name "eventsListener". The options in the configuration file have to be "spi-events-listener-$providerid-$option" and not with "spi-eventsListener".

0 replies

Navigation Menu

Repository navigation

Custom SPI configuration in Keycloak 21 #19544

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Custom SPI configuration in Keycloak 21 #19544

Uh oh!

Uh oh!

tobiasge Apr 5, 2023

Replies: 1 comment

Uh oh!

tobiasge Apr 17, 2023 Author

tobiasge
Apr 5, 2023

tobiasge
Apr 17, 2023
Author