org.keycloak.mappers

Interface UserFederationMapperFactory

All Superinterfaces:

ConfiguredProvider, ProviderFactory<UserFederationMapper>

public interface UserFederationMapperFactory
extends ProviderFactory<UserFederationMapper>, ConfiguredProvider

Author:

Marek Posolda

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayCategory()
String	getDisplayType()
String	getFederationProviderType() Refers to providerName (type) of the federation provider, which this mapper can be used for.
void	validateConfig(UserFederationMapperModel mapperModel) Called when instance of mapperModel is created for this factory through admin endpoint

Methods inherited from interface org.keycloak.provider.ProviderFactory

close, create, getId, init, postInit

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfigProperties, getHelpText

Method Detail

getFederationProviderType

String getFederationProviderType()

Refers to providerName (type) of the federation provider, which this mapper can be used for. For example "ldap" or "kerberos"

Returns:

providerName

getDisplayCategory

String getDisplayCategory()

getDisplayType

String getDisplayType()

validateConfig

void validateConfig(UserFederationMapperModel mapperModel)
                    throws MapperConfigValidationException

Called when instance of mapperModel is created for this factory through admin endpoint

Parameters:

mapperModel -

Throws:

MapperConfigValidationException - if configuration provided in mapperModel is not valid