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
All Methods Instance Methods Concrete Methods 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 initializedboolean
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
-
-
-
-
Method Detail
-
create
public StickySessionEncoderProvider create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<StickySessionEncoderProvider>
-
encodeSessionId
public String encodeSessionId(String sessionId)
- Specified by:
encodeSessionId
in interfaceStickySessionEncoderProvider
- 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 interfaceStickySessionEncoderProvider
- 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 interfaceStickySessionEncoderProvider
- 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 interfaceProviderFactory<StickySessionEncoderProvider>
-
postInit
public void postInit(KeycloakSessionFactory factory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<StickySessionEncoderProvider>
-
close
public void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProvider
- Specified by:
close
in interfaceProviderFactory<StickySessionEncoderProvider>
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<StickySessionEncoderProvider>
-
isSupported
public boolean isSupported()
- Specified by:
isSupported
in interfaceEnvironmentDependentProviderFactory
- Returns:
true
if the provider is supported and should be available,false
otherwise
-
-