Package org.keycloak.models.map.storage.file

Class FileMapStorageProviderFactory

java.lang.Object

org.keycloak.models.map.storage.file.FileMapStorageProviderFactory

All Implemented Interfaces:

AmphibianProviderFactory<MapStorageProvider>, ComponentFactory<MapStorageProvider,MapStorageProvider>, MapStorageProviderFactory, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<MapStorageProvider>

public class FileMapStorageProviderFactory
extends Object
implements AmphibianProviderFactory<MapStorageProvider>, MapStorageProviderFactory, EnvironmentDependentProviderFactory

A MapStorageProviderFactory that creates file-based MapStorageProviders.

Author:

Stefan Guilhen

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.storage.MapStorageProviderFactory

MapStorageProviderFactory.Flag

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROVIDER_ID
protected static Map<Class<?>,Function<?,String[]>>	UNIQUE_HUMAN_READABLE_NAME_FIELD

Constructor Summary

Constructors

Constructor	Description
FileMapStorageProviderFactory()

Method Summary

Modifier and Type	Method	Description
MapStorageProvider	create(KeycloakSession session)
Function<String,Path>	getDataDirectoryFunc(String areaName)
String	getHelpText()
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.component.AmphibianProviderFactory

close, create, getConfigProperties, onUpdate, preRemove

Methods inherited from interface org.keycloak.component.ComponentFactory

getCommonProviderConfigProperties, getTypeMetadata, onCreate, validateConfiguration

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.EnvironmentDependentProviderFactory

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Detail

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

UNIQUE_HUMAN_READABLE_NAME_FIELD

protected static final Map<Class<?>,Function<?,String[]>> UNIQUE_HUMAN_READABLE_NAME_FIELD

Constructor Detail

FileMapStorageProviderFactory

public FileMapStorageProviderFactory()

Method Detail

create

public MapStorageProvider create(KeycloakSession session)

Specified by:

create in interface AmphibianProviderFactory<MapStorageProvider>

Specified by:

create in interface ComponentFactory<MapStorageProvider,MapStorageProvider>

Specified by:

create in interface ProviderFactory<MapStorageProvider>

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise

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

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<MapStorageProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<MapStorageProvider>

getDataDirectoryFunc

public Function<String,Path> getDataDirectoryFunc(String areaName)