org.keycloak.adapters.spi

Interface SessionIdMapper

All Known Implementing Classes:

InMemorySessionIdMapper

public interface SessionIdMapper

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all mappings from this mapper.
String	getSessionFromSSO(String sso) Returns HTTP session ID from the given user session ID.
Set<String>	getUserSessions(String principal) Returns set of HTTP session IDs for the given principal.
boolean	hasSession(String id) Returns true if the mapper contains mapping for the given HTTP session ID.
void	map(String sso, String principal, String session) Establishes mapping between user session ID, principal and HTTP session ID.
void	removeSession(String session) Removes mappings for the given HTTP session ID.

Method Detail

hasSession

boolean hasSession(String id)

Returns true if the mapper contains mapping for the given HTTP session ID.

Parameters:

id -

Returns:

clear

void clear()

Clears all mappings from this mapper.

getUserSessions

Set<String> getUserSessions(String principal)

Returns set of HTTP session IDs for the given principal.

Parameters:

principal - Principal

Returns:

getSessionFromSSO

String getSessionFromSSO(String sso)

Returns HTTP session ID from the given user session ID.

Parameters:

sso - User session ID

Returns:

map

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

Establishes mapping between user session ID, principal and HTTP session ID.

Parameters:

sso - User session ID

principal - Principal

session - HTTP session ID

removeSession

void removeSession(String session)

Removes mappings for the given HTTP session ID.

Parameters:

session - HTTP session ID.