Package org.keycloak.protocol.oidc.mappers

Class DeployedScriptOIDCProtocolMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.DeployedScriptOIDCProtocolMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCAccessTokenResponseMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, UserInfoTokenMapper, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class DeployedScriptOIDCProtocolMapper
extends ScriptBasedOIDCProtocolMapper

Field Summary

Fields

Modifier and Type	Field	Description
protected ScriptProviderMetadata	metadata

Fields inherited from class org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper

PROVIDER_ID, SCRIPT

Fields inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
DeployedScriptOIDCProtocolMapper()
DeployedScriptOIDCProtocolMapper(ScriptProviderMetadata metadata)

Method Summary

Modifier and Type	Method	Description
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayType()
String	getHelpText()
String	getId()
ScriptProviderMetadata	getMetadata()
protected String	getScriptCode(ProtocolMapperModel mapperModel)
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	setMetadata(ScriptProviderMetadata metadata)

Methods inherited from class org.keycloak.protocol.oidc.mappers.ScriptBasedOIDCProtocolMapper

create, getDisplayCategory, getPriority, setClaim, setClaim, validateConfig

Methods inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

close, create, getEffectiveModel, getProtocol, postInit, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformIntrospectionToken, transformUserInfoToken

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.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper

transformAccessToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCAccessTokenResponseMapper

transformAccessTokenResponse

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper

transformIDToken

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Methods inherited from interface org.keycloak.protocol.oidc.mappers.TokenIntrospectionTokenMapper

transformIntrospectionToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper

transformUserInfoToken

Field Details

metadata

protected ScriptProviderMetadata metadata

Constructor Details

DeployedScriptOIDCProtocolMapper

public DeployedScriptOIDCProtocolMapper(ScriptProviderMetadata metadata)

DeployedScriptOIDCProtocolMapper

public DeployedScriptOIDCProtocolMapper()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ProtocolMapper>

Overrides:

getId in class ScriptBasedOIDCProtocolMapper

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

Overrides:

getDisplayType in class ScriptBasedOIDCProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

Overrides:

getHelpText in class ScriptBasedOIDCProtocolMapper

getScriptCode

protected String getScriptCode(ProtocolMapperModel mapperModel)

Overrides:

getScriptCode in class ScriptBasedOIDCProtocolMapper

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

Overrides:

init in class AbstractOIDCProtocolMapper

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

Overrides:

getConfigProperties in class ScriptBasedOIDCProtocolMapper

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Overrides:

isSupported in class ScriptBasedOIDCProtocolMapper

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

setMetadata

public void setMetadata(ScriptProviderMetadata metadata)

getMetadata

public ScriptProviderMetadata getMetadata()