Package org.keycloak.protocol.oidc.grants.ciba

Class CibaGrantTypeFactory

java.lang.Object

org.keycloak.protocol.oidc.grants.ciba.CibaGrantTypeFactory

All Implemented Interfaces:

OAuth2GrantTypeFactory, EnvironmentDependentProviderFactory, ProviderFactory<OAuth2GrantType>

public class CibaGrantTypeFactory
extends Object
implements OAuth2GrantTypeFactory, EnvironmentDependentProviderFactory

Factory for OpenID Connect Client-Initiated Backchannel Authentication Flow

Author:

Dmitry Telegin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GRANT_SHORTCUT

Constructor Summary

Constructors

Constructor	Description
CibaGrantTypeFactory()

Method Summary

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

Field Details

GRANT_SHORTCUT

public static final String GRANT_SHORTCUT

See Also:

• Constant Field Values

Constructor Details

CibaGrantTypeFactory

public CibaGrantTypeFactory()

Method Details

getId

public String getId()

Specified by:

getId in interface ProviderFactory<OAuth2GrantType>

getShortcut

public String getShortcut()

Specified by:

getShortcut in interface OAuth2GrantTypeFactory

Returns:

usually like 3-letters shortcut of specific grants. It can be useful for example in the tokens when the amount of characters should be limited and hence using full grant name is not ideal. Shortcut should be unique across grants.

create

public OAuth2GrantType create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<OAuth2GrantType>

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.

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<OAuth2GrantType>