Package org.keycloak.adapters.spi

Interface SessionIdMapperUpdater

public interface SessionIdMapperUpdater

Classes implementing this interface represent a mechanism for updating SessionIdMapper entries.

Author:

hmlnarik

Field Summary

Fields

Modifier and Type	Field	Description
static SessionIdMapperUpdater	DIRECT	SessionIdMapper entries are updated directly.
static SessionIdMapperUpdater	EXTERNAL	Only HTTP session is manipulated with, SessionIdMapper entries are not updated by this updater and they have to be updated by some other means, e.g.

Method Summary

Modifier and Type	Method	Description
void	clear(SessionIdMapper idMapper)	Delegates to SessionIdMapper.clear() method..
void	map(SessionIdMapper idMapper, String sso, String principal, String session)	Delegates to SessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String) method.
boolean	refreshMapping(SessionIdMapper idMapper, String httpSessionId)	Refreshes the mapping in the idMapper from the internal source of this mapped updater and maps it via SessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String) method.
void	removeSession(SessionIdMapper idMapper, String session)	Delegates to SessionIdMapper.removeSession(java.lang.String) method.

Field Detail

DIRECT

static final SessionIdMapperUpdater DIRECT

SessionIdMapper entries are updated directly.

EXTERNAL

static final SessionIdMapperUpdater EXTERNAL

Only HTTP session is manipulated with, SessionIdMapper entries 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 to SessionIdMapper.clear() method..

map

void map(SessionIdMapper idMapper,
         String sso,
         String principal,
         String session)

Delegates to SessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String) method.

Parameters:

idMapper - Mapper

sso - User session ID

principal - Principal

session - HTTP session ID

removeSession

void removeSession(SessionIdMapper idMapper,
                   String session)

Delegates to SessionIdMapper.removeSession(java.lang.String) method.

Parameters:

idMapper - Mapper

session - HTTP session ID.

refreshMapping

boolean refreshMapping(SessionIdMapper idMapper,
                       String httpSessionId)

Refreshes the mapping in the idMapper from the internal source of this mapped updater and maps it via SessionIdMapper.map(java.lang.String, java.lang.String, java.lang.String) method.

Parameters:

idMapper - Mapper

session - HTTP session ID.

Returns:

true if the mapping existed in the internal source of this mapped updater and has been refreshed, false otherwise