org.keycloak.storage.client

Interface ClientStorageProvider

All Superinterfaces:

ClientLookupProvider, Provider

public interface ClientStorageProvider
extends Provider, ClientLookupProvider

Base interface for components that want to provide an alternative storage mechanism for clients This is currently a private incomplete SPI. Please discuss on dev list if you want us to complete it or want to do the work yourself. This work is described in KEYCLOAK-6408 JIRA issue.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
default void	preRemove(RealmModel realm) Callback when a realm is removed.
default void	preRemove(RealmModel realm, GroupModel group) Callback when a group is removed.
default void	preRemove(RealmModel realm, RoleModel role) Callback when a role is removed.

Methods inherited from interface org.keycloak.provider.Provider

close

Methods inherited from interface org.keycloak.storage.client.ClientLookupProvider

getClientByClientId, getClientById, searchClientsByAttributes, searchClientsByClientId

Method Detail

preRemove

default void preRemove(RealmModel realm)

Callback when a realm is removed. Implement this if, for example, you want to do some cleanup in your user storage when a realm is removed

Parameters:

realm -

preRemove

default void preRemove(RealmModel realm,
                       GroupModel group)

Callback when a group is removed. Allows you to do things like remove a user group mapping in your external store if appropriate

Parameters:

realm -

group -

preRemove

default void preRemove(RealmModel realm,
                       RoleModel role)

Callback when a role is removed. Allows you to do things like remove a user role mapping in your external store if appropriate

Parameters:

realm -

role -