Package org.keycloak.adapters.spi
Interface SessionIdMapperUpdater
-
public interface SessionIdMapperUpdaterClasses implementing this interface represent a mechanism for updatingSessionIdMapperentries.- Author:
- hmlnarik
-
-
Field Summary
Fields Modifier and Type Field Description static SessionIdMapperUpdaterDIRECTSessionIdMapperentries are updated directly.static SessionIdMapperUpdaterEXTERNALOnly HTTP session is manipulated with,SessionIdMapperentries are not updated by this updater and they have to be updated by some other means, e.g.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclear(SessionIdMapper idMapper)Delegates toSessionIdMapper.clear()method..voidmap(SessionIdMapper idMapper, String sso, String principal, String session)Delegates toSessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String)method.booleanrefreshMapping(SessionIdMapper idMapper, String httpSessionId)Refreshes the mapping in theidMapperfrom the internal source of this mapped updater and maps it viaSessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String)method.voidremoveSession(SessionIdMapper idMapper, String session)Delegates toSessionIdMapper.removeSession(java.lang.String)method.
-
-
-
Field Detail
-
DIRECT
static final SessionIdMapperUpdater DIRECT
SessionIdMapperentries are updated directly.
-
EXTERNAL
static final SessionIdMapperUpdater EXTERNAL
Only HTTP session is manipulated with,SessionIdMapperentries are not updated by this updater and they have to be updated by some other means, e.g. by some listener of HTTP session changes.
-
-
Method Detail
-
clear
void clear(SessionIdMapper idMapper)
Delegates toSessionIdMapper.clear()method..
-
map
void map(SessionIdMapper idMapper, String sso, String principal, String session)
Delegates toSessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String)method.- Parameters:
idMapper- Mappersso- User session IDprincipal- Principalsession- HTTP session ID
-
removeSession
void removeSession(SessionIdMapper idMapper, String session)
Delegates toSessionIdMapper.removeSession(java.lang.String)method.- Parameters:
idMapper- Mappersession- HTTP session ID.
-
refreshMapping
boolean refreshMapping(SessionIdMapper idMapper, String httpSessionId)
Refreshes the mapping in theidMapperfrom the internal source of this mapped updater and maps it viaSessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String)method.- Parameters:
idMapper- Mappersession- HTTP session ID.- Returns:
trueif the mapping existed in the internal source of this mapped updater and has been refreshed,falseotherwise
-
-