Class MapAuthenticationSessionAdapter
- java.lang.Object
-
- org.keycloak.models.map.authSession.MapAuthenticationSessionAdapter
-
- All Implemented Interfaces:
AuthenticationSessionModel
,CommonClientSessionModel
public class MapAuthenticationSessionAdapter extends Object implements AuthenticationSessionModel
- Author:
- Martin Kanis
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.keycloak.sessions.CommonClientSessionModel
CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus
-
-
Constructor Summary
Constructors Constructor Description MapAuthenticationSessionAdapter(KeycloakSession session, MapRootAuthenticationSessionAdapter parent, String tabId, MapAuthenticationSessionEntity entity)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRequiredAction(String action)
Adds a required action to the authentication session.void
addRequiredAction(UserModel.RequiredAction action)
Adds a required action to the authentication session.void
clearAuthNotes()
Clears all authentication note.void
clearClientNotes()
Clears all client notes.void
clearExecutionStatus()
Clears execution status of the authentication session.void
clearUserSessionNotes()
Clears all user session notes.String
getAction()
UserModel
getAuthenticatedUser()
Returns authenticated user that is associated to the authentication session.String
getAuthNote(String name)
Retrieves value of the given authentication note to the given value.ClientModel
getClient()
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()
Gets client scope IDs from the authentication session.Map<String,CommonClientSessionModel.ExecutionStatus>
getExecutionStatus()
Returns execution status of the authentication session.RootAuthenticationSessionModel
getParentSession()
Returns the root authentication session that is parent of this authentication session.String
getProtocol()
RealmModel
getRealm()
String
getRedirectUri()
Set<String>
getRequiredActions()
Returns 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)
Removes a required action from the authentication session.void
removeRequiredAction(UserModel.RequiredAction action)
Removes a required action from the authentication session.void
setAction(String action)
void
setAuthenticatedUser(UserModel user)
Sets authenticated user that is associated to the authentication session.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)
Sets client scope IDs to the authentication session.void
setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
Sets execution status of the authentication session.void
setProtocol(String method)
void
setRedirectUri(String uri)
void
setUserSessionNote(String name, String value)
Sets the given user session note to the given value.
-
-
-
Constructor Detail
-
MapAuthenticationSessionAdapter
public MapAuthenticationSessionAdapter(KeycloakSession session, MapRootAuthenticationSessionAdapter parent, String tabId, MapAuthenticationSessionEntity entity)
-
-
Method Detail
-
getTabId
public String getTabId()
- Specified by:
getTabId
in interfaceAuthenticationSessionModel
- 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 {@link #getParentSession().getId()}
-
getParentSession
public RootAuthenticationSessionModel getParentSession()
Description copied from interface:AuthenticationSessionModel
Returns the root authentication session that is parent of this authentication session.- Specified by:
getParentSession
in interfaceAuthenticationSessionModel
- Returns:
RootAuthenticationSessionModel
-
getExecutionStatus
public Map<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatus()
Description copied from interface:AuthenticationSessionModel
Returns execution status of the authentication session.- Specified by:
getExecutionStatus
in interfaceAuthenticationSessionModel
- Returns:
Map<String, ExecutionStatus>
Never returnsnull
.
-
setExecutionStatus
public void setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
Description copied from interface:AuthenticationSessionModel
Sets execution status of the authentication session.- Specified by:
setExecutionStatus
in interfaceAuthenticationSessionModel
- Parameters:
authenticator
-String
Can't benull
.status
-ExecutionStatus
Can't benull
.
-
clearExecutionStatus
public void clearExecutionStatus()
Description copied from interface:AuthenticationSessionModel
Clears execution status of the authentication session.- Specified by:
clearExecutionStatus
in interfaceAuthenticationSessionModel
-
getAuthenticatedUser
public UserModel getAuthenticatedUser()
Description copied from interface:AuthenticationSessionModel
Returns authenticated user that is associated to the authentication session.- Specified by:
getAuthenticatedUser
in interfaceAuthenticationSessionModel
- Returns:
UserModel
or null if there's no authenticated user.
-
setAuthenticatedUser
public void setAuthenticatedUser(UserModel user)
Description copied from interface:AuthenticationSessionModel
Sets authenticated user that is associated to the authentication session.- Specified by:
setAuthenticatedUser
in interfaceAuthenticationSessionModel
- Parameters:
user
-UserModel
Ifnull
thennull
will be set to the authenticated user.
-
getRequiredActions
public Set<String> getRequiredActions()
Description copied from interface:AuthenticationSessionModel
Returns required actions that are attached to this client session.- Specified by:
getRequiredActions
in interfaceAuthenticationSessionModel
- Returns:
Set<String>
Never returnsnull
.
-
addRequiredAction
public void addRequiredAction(String action)
Description copied from interface:AuthenticationSessionModel
Adds a required action to the authentication session.- Specified by:
addRequiredAction
in interfaceAuthenticationSessionModel
- Parameters:
action
-String
Can't benull
.
-
removeRequiredAction
public void removeRequiredAction(String action)
Description copied from interface:AuthenticationSessionModel
Removes a required action from the authentication session.- Specified by:
removeRequiredAction
in interfaceAuthenticationSessionModel
- Parameters:
action
-String
Can't benull
.
-
addRequiredAction
public void addRequiredAction(UserModel.RequiredAction action)
Description copied from interface:AuthenticationSessionModel
Adds a required action to the authentication session.- Specified by:
addRequiredAction
in interfaceAuthenticationSessionModel
- Parameters:
action
-UserModel.RequiredAction
Can't benull
.
-
removeRequiredAction
public void removeRequiredAction(UserModel.RequiredAction action)
Description copied from interface:AuthenticationSessionModel
Removes a required action from the authentication session.- Specified by:
removeRequiredAction
in interfaceAuthenticationSessionModel
- Parameters:
action
-UserModel.RequiredAction
Can't benull
.
-
setUserSessionNote
public void setUserSessionNote(String name, String value)
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
setUserSessionNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided the method won't have an effect.value
-String
Ifnull
is provided the method won't have an effect.
-
getUserSessionNotes
public Map<String,String> getUserSessionNotes()
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
getUserSessionNotes
in interfaceAuthenticationSessionModel
- Returns:
Map<String, String>
never returnsnull
-
clearUserSessionNotes
public void clearUserSessionNotes()
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
clearUserSessionNotes
in interfaceAuthenticationSessionModel
-
getAuthNote
public String getAuthNote(String name)
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
getAuthNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided then the method will returnnull
.- Returns:
String
ornull
if no authentication note is set.
-
setAuthNote
public void setAuthNote(String name, String value)
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
setAuthNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided the method won't have an effect.value
-String
Ifnull
is provided the method won't have an effect.
-
removeAuthNote
public void removeAuthNote(String name)
Description copied from interface:AuthenticationSessionModel
Removes the given authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted.- Specified by:
removeAuthNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided the method won't have an effect.
-
clearAuthNotes
public void clearAuthNotes()
Description copied from interface:AuthenticationSessionModel
Clears all authentication note. Authentication notes are notes used typically by authenticators and authentication flows. They are cleared when authentication session is restarted.- Specified by:
clearAuthNotes
in interfaceAuthenticationSessionModel
-
getClientNote
public String getClientNote(String name)
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
getClientNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
if provided then the method will returnnull
.- Returns:
String
ornull
if no client's note is set.
-
setClientNote
public void setClientNote(String name, String value)
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
setClientNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided the method won't have an effect.value
-String
Ifnull
is provided the method won't have an effect.
-
removeClientNote
public void removeClientNote(String name)
Description copied from interface:AuthenticationSessionModel
Removes the given client note. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.- Specified by:
removeClientNote
in interfaceAuthenticationSessionModel
- Parameters:
name
-String
Ifnull
is provided the method won't have an effect.
-
getClientNotes
public Map<String,String> getClientNotes()
Description copied from interface:AuthenticationSessionModel
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.- Specified by:
getClientNotes
in interfaceAuthenticationSessionModel
- Returns:
Map<String, String>
never returnsnull
.
-
clearClientNotes
public void clearClientNotes()
Description copied from interface:AuthenticationSessionModel
Clears all client notes. Client notes are notes specific to client protocol. They are NOT cleared when authentication session is restarted.- Specified by:
clearClientNotes
in interfaceAuthenticationSessionModel
-
getClientScopes
public Set<String> getClientScopes()
Description copied from interface:AuthenticationSessionModel
Gets client scope IDs from the authentication session.- Specified by:
getClientScopes
in interfaceAuthenticationSessionModel
- Returns:
Set<String>
never returnsnull
.
-
setClientScopes
public void setClientScopes(Set<String> clientScopes)
Description copied from interface:AuthenticationSessionModel
Sets client scope IDs to the authentication session.- Specified by:
setClientScopes
in interfaceAuthenticationSessionModel
- Parameters:
clientScopes
-Set<String>
Can't benull
.
-
getRedirectUri
public String getRedirectUri()
- Specified by:
getRedirectUri
in interfaceCommonClientSessionModel
-
setRedirectUri
public void setRedirectUri(String uri)
- Specified by:
setRedirectUri
in interfaceCommonClientSessionModel
-
getRealm
public RealmModel getRealm()
- Specified by:
getRealm
in interfaceCommonClientSessionModel
-
getClient
public ClientModel getClient()
- Specified by:
getClient
in interfaceCommonClientSessionModel
-
getAction
public String getAction()
- Specified by:
getAction
in interfaceCommonClientSessionModel
-
setAction
public void setAction(String action)
- Specified by:
setAction
in interfaceCommonClientSessionModel
-
getProtocol
public String getProtocol()
- Specified by:
getProtocol
in interfaceCommonClientSessionModel
-
setProtocol
public void setProtocol(String method)
- Specified by:
setProtocol
in interfaceCommonClientSessionModel
-
-