Skip to content

Add additional Keycloak lifecycle events #42671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomasdarimont wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add additional Keycloak lifecycle events #42671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42ef88d
Add additional Keycloak lifecycle events (#42670)
thomasdarimont Sep 16, 2025
1e26001
Make PostMigrationEvent an AbstractLifecycleEvent
thomasdarimont Sep 17, 2025
78b4d23
Make PostMigrationEvent an AbstractLifecycleEvent
thomasdarimont Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions server-spi-private/src/main/java/org/keycloak/models/utils/PostMigrationEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,17 @@
package org.keycloak.models.utils;

import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.provider.AbstractLifecycleEvent;
import org.keycloak.provider.ProviderEvent;

/**
* Executed at startup after model migration is finished
*
* @author <a href="mailto:[email protected]">Marek Posolda</a>
*/
public class PostMigrationEvent implements ProviderEvent {

private final KeycloakSessionFactory factory;
public class PostMigrationEvent extends AbstractLifecycleEvent {

public PostMigrationEvent(KeycloakSessionFactory factory) {
this.factory = factory;
}

public KeycloakSessionFactory getFactory() {
return this.factory;
super(factory);
}
}
16 changes: 16 additions & 0 deletions server-spi/src/main/java/org/keycloak/provider/AbstractLifecycleEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package org.keycloak.provider;

import org.keycloak.models.KeycloakSessionFactory;

public abstract class AbstractLifecycleEvent implements ProviderEvent {

protected final KeycloakSessionFactory sessionFactory;

public AbstractLifecycleEvent(KeycloakSessionFactory sessionFactory) {
this.sessionFactory = sessionFactory;
}

public KeycloakSessionFactory getFactory() {
return sessionFactory;
}
}
13 changes: 13 additions & 0 deletions server-spi/src/main/java/org/keycloak/provider/KeycloakInitializedEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package org.keycloak.provider;

import org.keycloak.models.KeycloakSessionFactory;

/**
* Signals that the infrastructure initialization has completed.
*/
public class KeycloakInitializedEvent extends AbstractLifecycleEvent {

public KeycloakInitializedEvent(KeycloakSessionFactory factory) {
super(factory);
}
}
13 changes: 13 additions & 0 deletions server-spi/src/main/java/org/keycloak/provider/KeycloakShutdownEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package org.keycloak.provider;

import org.keycloak.models.KeycloakSessionFactory;

/**
* Signals that Keycloak is about to shutdown.
*/
public class KeycloakShutdownEvent extends AbstractLifecycleEvent {

public KeycloakShutdownEvent(KeycloakSessionFactory factory) {
super(factory);
}
}
4 changes: 4 additions & 0 deletions services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
import org.keycloak.models.utils.PostMigrationEvent;
import org.keycloak.platform.Platform;
import org.keycloak.platform.PlatformProvider;
import org.keycloak.provider.KeycloakInitializedEvent;
import org.keycloak.provider.KeycloakShutdownEvent;
import org.keycloak.services.managers.ApplianceBootstrap;
import org.keycloak.transaction.JtaTransactionManagerLookup;

Expand Down Expand Up @@ -97,10 +99,12 @@ public void run(KeycloakSession session) {
}

sessionFactory.publish(new PostMigrationEvent(sessionFactory));
sessionFactory.publish(new KeycloakInitializedEvent(sessionFactory));
}

protected void shutdown() {
if (sessionFactory != null) {
sessionFactory.publish(new KeycloakShutdownEvent(sessionFactory));
sessionFactory.close();
}
}
Expand Down
Loading