Package org.keycloak.authorization.jpa.store

Class JPAAuthorizationStoreFactory

java.lang.Object

org.keycloak.authorization.jpa.store.JPAAuthorizationStoreFactory

All Implemented Interfaces:

AuthorizationStoreFactory, ProviderFactory<StoreFactory>

public class JPAAuthorizationStoreFactory
extends Object
implements AuthorizationStoreFactory

Author:

Pedro Igor

Field Summary

Fields

Modifier and Type	Field	Description
static final RealmModel	NULL_REALM	Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter.

Constructor Summary

Constructors

Constructor	Description
JPAAuthorizationStoreFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
StoreFactory	create(KeycloakSession session)
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
int	order()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authorization.store.AuthorizationStoreFactory

postInit, registerSynchronizationListeners

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata

Field Details

NULL_REALM

public static final RealmModel NULL_REALM

Legacy store doesn't store realm id for any entity and no method there is using new introduced RealmModel parameter. The parameter was introduced for usage only in the new storage. Therefore, in some cases we may break our rule specified in JavaDoc and use null value as parameter that otherwise cannot be null. We need to be careful and place such value only to a method call that cannot end up in the new store because it would end with NullPointerException. To mark all places where we do this, we use this variable so it is easily searchable.

Constructor Details

JPAAuthorizationStoreFactory

public JPAAuthorizationStoreFactory()

Method Details

create

public StoreFactory create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<StoreFactory>

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<StoreFactory>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<StoreFactory>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<StoreFactory>

order

public int order()

Specified by:

order in interface ProviderFactory<StoreFactory>