Package org.keycloak.sessions

Class DisabledStickySessionEncoderProvider

java.lang.Object

org.keycloak.sessions.DisabledStickySessionEncoderProvider

All Implemented Interfaces:

EnvironmentDependentProviderFactory, Provider, ProviderFactory<StickySessionEncoderProvider>, StickySessionEncoderProvider, StickySessionEncoderProviderFactory

public class DisabledStickySessionEncoderProvider
extends Object
implements StickySessionEncoderProviderFactory, StickySessionEncoderProvider, EnvironmentDependentProviderFactory

Constructor Summary

Constructors

Constructor	Description
DisabledStickySessionEncoderProvider()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
StickySessionEncoderProvider	create(KeycloakSession session)
String	decodeSessionId(String encodedSessionId)
String	encodeSessionId(String sessionId)
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported()
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
boolean	shouldAttachRoute()

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

isSupported

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Constructor Details

DisabledStickySessionEncoderProvider

public DisabledStickySessionEncoderProvider()

Method Details

create

public StickySessionEncoderProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<StickySessionEncoderProvider>

encodeSessionId

public String encodeSessionId(String sessionId)

Specified by:

encodeSessionId in interface StickySessionEncoderProvider

Returns:

Encoded value to be used as the value of sticky session cookie (AUTH_SESSION_ID cookie)

decodeSessionId

public String decodeSessionId(String encodedSessionId)

Specified by:

decodeSessionId in interface StickySessionEncoderProvider

Parameters:

encodedSessionId - value of the sticky session cookie

Returns:

decoded value, which represents the actual ID of the AuthenticationSessionModel

shouldAttachRoute

public boolean shouldAttachRoute()

Specified by:

shouldAttachRoute in interface StickySessionEncoderProvider

Returns:

true if information about route should be attached to the sticky session cookie by Keycloak. Otherwise it may be attached by loadbalancer.

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 Provider

Specified by:

close in interface ProviderFactory<StickySessionEncoderProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<StickySessionEncoderProvider>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Returns:

true if the provider is supported and should be available, false otherwise