Package org.keycloak.protocol.oidc.tokenexchange

Class SubjectImpersonationTokenExchangeProviderFactory

java.lang.Object

org.keycloak.protocol.oidc.tokenexchange.SubjectImpersonationTokenExchangeProviderFactory

All Implemented Interfaces:

TokenExchangeProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<TokenExchangeProvider>

public class SubjectImpersonationTokenExchangeProviderFactory
extends Object
implements TokenExchangeProviderFactory, EnvironmentDependentProviderFactory

Provider factory for token-exchange subject impersonation where subject of the token is changed. This is Keycloak proprietary and it is not related to standard token-exchange impersonation described in the specification https://datatracker.ietf.org/doc/html/rfc8693 where the subject in the tokens are not changed. That one is covered by StandardTokenExchangeProviderFactory

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor	Description
SubjectImpersonationTokenExchangeProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
TokenExchangeProvider	create(KeycloakSession session)
String	getId()
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.
int	order()
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

dependsOn, getConfigMetadata

Constructor Details

SubjectImpersonationTokenExchangeProviderFactory

public SubjectImpersonationTokenExchangeProviderFactory()

Method Details

create

public TokenExchangeProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<TokenExchangeProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<TokenExchangeProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<TokenExchangeProvider>

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

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

order

public int order()

Specified by:

order in interface ProviderFactory<TokenExchangeProvider>