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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
create
(KeycloakSession session) decodeSessionId
(String encodedSessionId) encodeSessionId
(String sessionId) getId()
void
init
(Config.Scope config) boolean
void
postInit
(KeycloakSessionFactory factory) boolean
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
- Specified by:
create
in interfaceProviderFactory<StickySessionEncoderProvider>
-
encodeSessionId
- Specified by:
encodeSessionId
in interfaceStickySessionEncoderProvider
- Returns:
- Encoded value to be used as the value of sticky session cookie (AUTH_SESSION_ID cookie)
-
decodeSessionId
- 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
- Specified by:
init
in interfaceProviderFactory<StickySessionEncoderProvider>
-
postInit
- Specified by:
postInit
in interfaceProviderFactory<StickySessionEncoderProvider>
-
close
public void close()- Specified by:
close
in interfaceProvider
- Specified by:
close
in interfaceProviderFactory<StickySessionEncoderProvider>
-
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
-