Package org.keycloak.models.sessions.infinispan.remote

Class RemoteStickySessionEncoderProviderFactory

java.lang.Object

org.keycloak.models.sessions.infinispan.remote.RemoteStickySessionEncoderProviderFactory

All Implemented Interfaces:

EnvironmentDependentProviderFactory, ProviderFactory<StickySessionEncoderProvider>, StickySessionEncoderProviderFactory

public class RemoteStickySessionEncoderProviderFactory
extends Object
implements StickySessionEncoderProviderFactory, EnvironmentDependentProviderFactory

Constructor Summary

Constructors

Constructor	Description
RemoteStickySessionEncoderProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
StickySessionEncoderProvider	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
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
void	setShouldAttachRoute(boolean shouldAttachRoute)	For testing purpose only

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

Constructor Details

RemoteStickySessionEncoderProviderFactory

public RemoteStickySessionEncoderProviderFactory()

Method Details

create

public StickySessionEncoderProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<StickySessionEncoderProvider>

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

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

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<StickySessionEncoderProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<StickySessionEncoderProvider>

order

public int order()

Specified by:

order in interface ProviderFactory<StickySessionEncoderProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<StickySessionEncoderProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

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.

setShouldAttachRoute

public void setShouldAttachRoute(boolean shouldAttachRoute)

Description copied from interface: StickySessionEncoderProviderFactory

For testing purpose only

Specified by:

setShouldAttachRoute in interface StickySessionEncoderProviderFactory