Package org.keycloak.protocol.oidc.tokenexchange

Class V1TokenExchangeProviderFactory

java.lang.Object

org.keycloak.protocol.oidc.tokenexchange.V1TokenExchangeProviderFactory

All Implemented Interfaces:

TokenExchangeProviderFactory, EnvironmentDependentProviderFactory, ProviderFactory<TokenExchangeProvider>

public class V1TokenExchangeProviderFactory
extends Object
implements TokenExchangeProviderFactory, EnvironmentDependentProviderFactory

V1 token exchange provider factory. Supports all token exchange types (standard, federated, subject impersonation)

Author:

Dmitry Telegin

Constructor Summary

Constructors

Constructor	Description
V1TokenExchangeProviderFactory()

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.
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, order

Constructor Details

V1TokenExchangeProviderFactory

public V1TokenExchangeProviderFactory()

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.