public class MapAuthenticationSessionAdapter extends Object implements AuthenticationSessionModel
CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus| Constructor and Description |
|---|
MapAuthenticationSessionAdapter(KeycloakSession session,
MapRootAuthenticationSessionAdapter parent,
String tabId,
MapAuthenticationSessionEntity entity) |
| Modifier and Type | Method and 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.
|
public MapAuthenticationSessionAdapter(KeycloakSession session, MapRootAuthenticationSessionAdapter parent, String tabId, MapAuthenticationSessionEntity entity)
public String getTabId()
getTabId in interface AuthenticationSessionModel#getParentSession().getId()public RootAuthenticationSessionModel getParentSession()
AuthenticationSessionModelgetParentSession in interface AuthenticationSessionModelRootAuthenticationSessionModelpublic Map<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatus()
AuthenticationSessionModelgetExecutionStatus in interface AuthenticationSessionModelMap<String, ExecutionStatus> Never returns null.public void setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
AuthenticationSessionModelsetExecutionStatus in interface AuthenticationSessionModelauthenticator - String Can't be null.status - ExecutionStatus Can't be null.public void clearExecutionStatus()
AuthenticationSessionModelclearExecutionStatus in interface AuthenticationSessionModelpublic UserModel getAuthenticatedUser()
AuthenticationSessionModelgetAuthenticatedUser in interface AuthenticationSessionModelUserModel or null if there's no authenticated user.public void setAuthenticatedUser(UserModel user)
AuthenticationSessionModelsetAuthenticatedUser in interface AuthenticationSessionModeluser - UserModel If null then null will be set to the authenticated user.public Set<String> getRequiredActions()
AuthenticationSessionModelgetRequiredActions in interface AuthenticationSessionModelSet<String> Never returns null.public void addRequiredAction(String action)
AuthenticationSessionModeladdRequiredAction in interface AuthenticationSessionModelaction - String Can't be null.public void removeRequiredAction(String action)
AuthenticationSessionModelremoveRequiredAction in interface AuthenticationSessionModelaction - String Can't be null.public void addRequiredAction(UserModel.RequiredAction action)
AuthenticationSessionModeladdRequiredAction in interface AuthenticationSessionModelaction - UserModel.RequiredAction Can't be null.public void removeRequiredAction(UserModel.RequiredAction action)
AuthenticationSessionModelremoveRequiredAction in interface AuthenticationSessionModelaction - UserModel.RequiredAction Can't be null.public void setUserSessionNote(String name, String value)
AuthenticationSessionModelsetUserSessionNote in interface AuthenticationSessionModelname - String If null is provided the method won't have an effect.value - String If null is provided the method won't have an effect.public Map<String,String> getUserSessionNotes()
AuthenticationSessionModelgetUserSessionNotes in interface AuthenticationSessionModelMap<String, String> never returns nullpublic void clearUserSessionNotes()
AuthenticationSessionModelclearUserSessionNotes in interface AuthenticationSessionModelpublic String getAuthNote(String name)
AuthenticationSessionModelgetAuthNote in interface AuthenticationSessionModelname - String If null if provided then the method will return null.String or null if no authentication note is set.public void setAuthNote(String name, String value)
AuthenticationSessionModelsetAuthNote in interface AuthenticationSessionModelname - String If null is provided the method won't have an effect.value - String If null is provided the method won't have an effect.public void removeAuthNote(String name)
AuthenticationSessionModelremoveAuthNote in interface AuthenticationSessionModelname - String If null is provided the method won't have an effect.public void clearAuthNotes()
AuthenticationSessionModelclearAuthNotes in interface AuthenticationSessionModelpublic String getClientNote(String name)
AuthenticationSessionModelgetClientNote in interface AuthenticationSessionModelname - String If null if provided then the method will return null.String or null if no client's note is set.public void setClientNote(String name, String value)
AuthenticationSessionModelsetClientNote in interface AuthenticationSessionModelname - String If null is provided the method won't have an effect.value - String If null is provided the method won't have an effect.public void removeClientNote(String name)
AuthenticationSessionModelremoveClientNote in interface AuthenticationSessionModelname - String If null is provided the method won't have an effect.public Map<String,String> getClientNotes()
AuthenticationSessionModelgetClientNotes in interface AuthenticationSessionModelMap<String, String> never returns null.public void clearClientNotes()
AuthenticationSessionModelclearClientNotes in interface AuthenticationSessionModelpublic Set<String> getClientScopes()
AuthenticationSessionModelgetClientScopes in interface AuthenticationSessionModelSet<String> never returns null.public void setClientScopes(Set<String> clientScopes)
AuthenticationSessionModelsetClientScopes in interface AuthenticationSessionModelclientScopes - Set<String> Can't be null.public String getRedirectUri()
getRedirectUri in interface CommonClientSessionModelpublic void setRedirectUri(String uri)
setRedirectUri in interface CommonClientSessionModelpublic RealmModel getRealm()
getRealm in interface CommonClientSessionModelpublic ClientModel getClient()
getClient in interface CommonClientSessionModelpublic String getAction()
getAction in interface CommonClientSessionModelpublic void setAction(String action)
setAction in interface CommonClientSessionModelpublic String getProtocol()
getProtocol in interface CommonClientSessionModelpublic void setProtocol(String method)
setProtocol in interface CommonClientSessionModelCopyright © 2021 JBoss by Red Hat. All rights reserved.