org.keycloak.sessions

Interface StickySessionEncoderProvider

All Superinterfaces:

Provider

All Known Implementing Classes:

InfinispanStickySessionEncoderProvider

public interface StickySessionEncoderProvider
extends Provider

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
String	decodeSessionId(String encodedSessionId)
String	encodeSessionId(String sessionId)
boolean	shouldAttachRoute()

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

encodeSessionId

String encodeSessionId(String sessionId)

Parameters:

sessionId -

Returns:

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

decodeSessionId

String decodeSessionId(String encodedSessionId)

Parameters:

encodedSessionId - value of the sticky session cookie

Returns:

decoded value, which represents the actual ID of the AuthenticationSessionModel

shouldAttachRoute

boolean shouldAttachRoute()

Returns:

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