org.keycloak.sessions

Interface AuthenticationSessionModel

All Superinterfaces:

CommonClientSessionModel

public interface AuthenticationSessionModel
extends CommonClientSessionModel

Represents the state of the authentication. If the login is requested from different tabs of same browser, every browser tab has it's own state of the authentication. So there is separate AuthenticationSessionModel for every tab. Whole browser is represented by RootAuthenticationSessionModel

Author:

Marek Posolda

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.sessions.CommonClientSessionModel

CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus

Method Summary

Modifier and Type	Method and Description
void	addRequiredAction(String action)
void	addRequiredAction(UserModel.RequiredAction action)
void	clearAuthNotes() Clears all authentication note.
void	clearClientNotes() Clears all client notes.
void	clearExecutionStatus()
void	clearUserSessionNotes() Clears all user session notes.
UserModel	getAuthenticatedUser()
String	getAuthNote(String name) Retrieves value of the given authentication note to the given value.
String	getClientNote(String name) Retrieves value of the given client note to the given value.
Map<String,String>	getClientNotes() Retrieves the (name, value) map of client notes.
Set<String>	getClientScopes() Get client scope IDs
Map<String,CommonClientSessionModel.ExecutionStatus>	getExecutionStatus()
RootAuthenticationSessionModel	getParentSession()
Set<String>	getRequiredActions() Required actions that are attached to this client session.
String	getTabId()
Map<String,String>	getUserSessionNotes() Retrieves value of given user session note.
void	removeAuthNote(String name) Removes the given authentication note.
void	removeClientNote(String name) Removes the given client note.
void	removeRequiredAction(String action)
void	removeRequiredAction(UserModel.RequiredAction action)
void	setAuthenticatedUser(UserModel user)
void	setAuthNote(String name, String value) Sets the given authentication note to the given value.
void	setClientNote(String name, String value) Sets the given client note to the given value.
void	setClientScopes(Set<String> clientScopes) Set client scope IDs
void	setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
void	setUserSessionNote(String name, String value) Sets the given user session note to the given value.

Methods inherited from interface org.keycloak.sessions.CommonClientSessionModel

getAction, getClient, getProtocol, getRealm, getRedirectUri, setAction, setProtocol, setRedirectUri

Method Detail

getTabId

String getTabId()

Returns:

ID of this subsession (in other words, usually browser tab). For lookup the AuthenticationSessionModel, you need: ID of rootSession (parent), client UUID and tabId. For lookup the ID of the parent, use #getParentSession().getId()

getParentSession

RootAuthenticationSessionModel getParentSession()

getExecutionStatus

Map<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatus()

setExecutionStatus

void setExecutionStatus(String authenticator,
                        CommonClientSessionModel.ExecutionStatus status)

clearExecutionStatus

void clearExecutionStatus()

getAuthenticatedUser

UserModel getAuthenticatedUser()

setAuthenticatedUser

void setAuthenticatedUser(UserModel user)

getRequiredActions

Set<String> getRequiredActions()

Required actions that are attached to this client session.

Returns:

addRequiredAction

void addRequiredAction(String action)

removeRequiredAction

void removeRequiredAction(String action)

addRequiredAction

void addRequiredAction(UserModel.RequiredAction action)

removeRequiredAction

void removeRequiredAction(UserModel.RequiredAction action)

setUserSessionNote

void setUserSessionNote(String name,
                        String value)

Sets the given user session note to the given value. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

getUserSessionNotes

Map<String,String> getUserSessionNotes()

Retrieves value of given user session note. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

clearUserSessionNotes

void clearUserSessionNotes()

Clears all user session notes. User session notes are notes you want be applied to the UserSessionModel when the client session is attached to it.

getAuthNote

String getAuthNote(String name)

Retrieves value of the given authentication note to the given value. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

setAuthNote

void setAuthNote(String name,
                 String value)

Sets the given authentication note to the given value. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

removeAuthNote

void removeAuthNote(String name)

Removes the given authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

clearAuthNotes

void clearAuthNotes()

Clears all authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted

getClientNote

String getClientNote(String name)

Retrieves value of the given client note to the given value. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

setClientNote

void setClientNote(String name,
                   String value)

Sets the given client note to the given value. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

removeClientNote

void removeClientNote(String name)

Removes the given client note. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

getClientNotes

Map<String,String> getClientNotes()

Retrieves the (name, value) map of client notes. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

clearClientNotes

void clearClientNotes()

Clears all client notes. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.

getClientScopes

Set<String> getClientScopes()

Get client scope IDs

setClientScopes

void setClientScopes(Set<String> clientScopes)

Set client scope IDs