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

Class RemoteStickySessionEncoderProviderFactory

java.lang.Object

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

All Implemented Interfaces:

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

public class RemoteStickySessionEncoderProviderFactory
extends Object
implements StickySessionEncoderProviderFactory, EnvironmentDependentProviderFactory, StickySessionEncoderProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.sessions.StickySessionEncoderProvider

StickySessionEncoderProvider.SessionIdAndRoute

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)
StickySessionEncoderProvider.SessionIdAndRoute	decodeSessionIdAndRoute(String encodedSessionId)	Decodes the encoded session ID to extract its components, the session ID and the route.
Set<Class<? extends Provider>>	dependsOn()	Optional method used to declare that a ProviderFactory has a dependency on one or more Providers.
String	encodeSessionId(String message, String ignored)	Encodes the route into the message.
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
String	sessionIdRoute(String ignored)
void	setShouldAttachRoute(boolean shouldAttachRoute)	For testing purpose only
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.sessions.StickySessionEncoderProvider

decodeSessionId, encodeSessionId

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.

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>

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.

dependsOn

public Set<Class<? extends Provider>> dependsOn()

Description copied from interface: ProviderFactory

Optional method used to declare that a ProviderFactory has a dependency on one or more Providers. If a Provider is declared here, it is guaranteed that the dependencies ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory) method will be executed before this ProviderFactory's ProviderFactory.postInit(org.keycloak.models.KeycloakSessionFactory). Similarly, it's guaranteed that ProviderFactory.close() will be called on this ProviderFactory before ProviderFactory.close() is called on any of the dependent ProviderFactory implementations.

Specified by:

dependsOn in interface ProviderFactory<StickySessionEncoderProvider>

setShouldAttachRoute

public void setShouldAttachRoute(boolean shouldAttachRoute)

Description copied from interface: StickySessionEncoderProviderFactory

For testing purpose only

Specified by:

setShouldAttachRoute in interface StickySessionEncoderProviderFactory

encodeSessionId

public String encodeSessionId(String message,
 String ignored)

Description copied from interface: StickySessionEncoderProvider

Encodes the route into the message.

The route is computed by the sessionId, i.e., the Keycloak instance where it is cached.

Specified by:

encodeSessionId in interface StickySessionEncoderProvider

Parameters:

message - The message to encode with the route.

ignored - The session ID stored in the cache.

Returns:

The encoded message with the route information.

decodeSessionIdAndRoute

public StickySessionEncoderProvider.SessionIdAndRoute decodeSessionIdAndRoute(String encodedSessionId)

Description copied from interface: StickySessionEncoderProvider

Decodes the encoded session ID to extract its components, the session ID and the route.

The route component may be null if the session ID is not correctly encoded, or the sticky session is disabled.

Specified by:

decodeSessionIdAndRoute in interface StickySessionEncoderProvider

Parameters:

encodedSessionId - The encoded session ID.

Returns:

The StickySessionEncoderProvider.SessionIdAndRoute with the session ID and the route component. The route may be null.

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 load balancer.

sessionIdRoute

public String sessionIdRoute(String ignored)

Specified by:

sessionIdRoute in interface StickySessionEncoderProvider

Parameters:

ignored - The session ID.

Returns:

The route for the session ID. It returns null if sticky session is disabled.