Package org.keycloak.exportimport.singlefile

Class SingleFileExportProviderFactory

java.lang.Object

org.keycloak.exportimport.singlefile.SingleFileExportProviderFactory

All Implemented Interfaces:

ExportProviderFactory, ProviderFactory<ExportProvider>

public class SingleFileExportProviderFactory
extends Object
implements ExportProviderFactory

Construct a SingleFileExportProvider to be used to export one or more realms. For the sake of testing in the legacy testing setup, configurations can be overwritten via system properties.

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE
static final String	PROVIDER_ID
static final String	REALM_NAME

Constructor Summary

Constructors

Constructor	Description
SingleFileExportProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
ExportProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
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.provider.ProviderFactory

order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

FILE

public static final String FILE

See Also:

• Constant Field Values

REALM_NAME

public static final String REALM_NAME

See Also:

• Constant Field Values

Constructor Details

SingleFileExportProviderFactory

public SingleFileExportProviderFactory()

Method Details

create

public ExportProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<ExportProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<ExportProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ExportProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<ExportProvider>

Returns:

a list with the metadata for each configuration property supported by this factory