public class AuthenticationSessionAdapter extends Object implements AuthenticationSessionModel
CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus
Constructor and Description |
---|
AuthenticationSessionAdapter(KeycloakSession session,
RootAuthenticationSessionAdapter parent,
String tabId,
AuthenticationSessionEntity entity) |
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.
|
String |
getAction() |
UserModel |
getAuthenticatedUser() |
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()
Get client scope IDs
|
Map<String,CommonClientSessionModel.ExecutionStatus> |
getExecutionStatus() |
RootAuthenticationSessionModel |
getParentSession() |
String |
getProtocol() |
RealmModel |
getRealm() |
String |
getRedirectUri() |
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 |
setAction(String 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 |
setProtocol(String protocol) |
void |
setRedirectUri(String uri) |
void |
setUserSessionNote(String name,
String value)
Sets the given user session note to the given value.
|
public AuthenticationSessionAdapter(KeycloakSession session, RootAuthenticationSessionAdapter parent, String tabId, AuthenticationSessionEntity entity)
public String getTabId()
getTabId
in interface AuthenticationSessionModel
#getParentSession().getId()
public RootAuthenticationSessionModel getParentSession()
getParentSession
in interface AuthenticationSessionModel
public RealmModel getRealm()
getRealm
in interface CommonClientSessionModel
public ClientModel getClient()
getClient
in interface CommonClientSessionModel
public String getRedirectUri()
getRedirectUri
in interface CommonClientSessionModel
public void setRedirectUri(String uri)
setRedirectUri
in interface CommonClientSessionModel
public String getAction()
getAction
in interface CommonClientSessionModel
public void setAction(String action)
setAction
in interface CommonClientSessionModel
public Set<String> getClientScopes()
AuthenticationSessionModel
getClientScopes
in interface AuthenticationSessionModel
public void setClientScopes(Set<String> clientScopes)
AuthenticationSessionModel
setClientScopes
in interface AuthenticationSessionModel
public String getProtocol()
getProtocol
in interface CommonClientSessionModel
public void setProtocol(String protocol)
setProtocol
in interface CommonClientSessionModel
public String getClientNote(String name)
AuthenticationSessionModel
getClientNote
in interface AuthenticationSessionModel
public void setClientNote(String name, String value)
AuthenticationSessionModel
setClientNote
in interface AuthenticationSessionModel
public void removeClientNote(String name)
AuthenticationSessionModel
removeClientNote
in interface AuthenticationSessionModel
public Map<String,String> getClientNotes()
AuthenticationSessionModel
getClientNotes
in interface AuthenticationSessionModel
public void clearClientNotes()
AuthenticationSessionModel
clearClientNotes
in interface AuthenticationSessionModel
public String getAuthNote(String name)
AuthenticationSessionModel
getAuthNote
in interface AuthenticationSessionModel
public void setAuthNote(String name, String value)
AuthenticationSessionModel
setAuthNote
in interface AuthenticationSessionModel
public void removeAuthNote(String name)
AuthenticationSessionModel
removeAuthNote
in interface AuthenticationSessionModel
public void clearAuthNotes()
AuthenticationSessionModel
clearAuthNotes
in interface AuthenticationSessionModel
public void setUserSessionNote(String name, String value)
AuthenticationSessionModel
setUserSessionNote
in interface AuthenticationSessionModel
public Map<String,String> getUserSessionNotes()
AuthenticationSessionModel
getUserSessionNotes
in interface AuthenticationSessionModel
public void clearUserSessionNotes()
AuthenticationSessionModel
clearUserSessionNotes
in interface AuthenticationSessionModel
public Set<String> getRequiredActions()
AuthenticationSessionModel
getRequiredActions
in interface AuthenticationSessionModel
public void addRequiredAction(String action)
addRequiredAction
in interface AuthenticationSessionModel
public void removeRequiredAction(String action)
removeRequiredAction
in interface AuthenticationSessionModel
public void addRequiredAction(UserModel.RequiredAction action)
addRequiredAction
in interface AuthenticationSessionModel
public void removeRequiredAction(UserModel.RequiredAction action)
removeRequiredAction
in interface AuthenticationSessionModel
public Map<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatus()
getExecutionStatus
in interface AuthenticationSessionModel
public void setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
setExecutionStatus
in interface AuthenticationSessionModel
public void clearExecutionStatus()
clearExecutionStatus
in interface AuthenticationSessionModel
public UserModel getAuthenticatedUser()
getAuthenticatedUser
in interface AuthenticationSessionModel
public void setAuthenticatedUser(UserModel user)
setAuthenticatedUser
in interface AuthenticationSessionModel
Copyright © 2020 JBoss by Red Hat. All rights reserved.