public interface AuthenticationSessionModel extends CommonClientSessionModel
RootAuthenticationSessionModelCommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus| 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.
|
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.
|
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.
|
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 |
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 |
setUserSessionNote(String name,
String value)
Sets the given user session note to the given value.
|
getAction, getClient, getProtocol, getRealm, getRedirectUri, setAction, setProtocol, setRedirectUriString getTabId()
#getParentSession().getId()RootAuthenticationSessionModel getParentSession()
RootAuthenticationSessionModelMap<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatus()
Map<String, ExecutionStatus> Never returns null.void setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
authenticator - String Can't be null.status - ExecutionStatus Can't be null.void clearExecutionStatus()
UserModel getAuthenticatedUser()
UserModel or null if there's no authenticated user.void setAuthenticatedUser(UserModel user)
user - UserModel If null then null will be set to the authenticated user.Set<String> getRequiredActions()
Set<String> Never returns null.void addRequiredAction(String action)
action - String Can't be null.void removeRequiredAction(String action)
action - String Can't be null.void addRequiredAction(UserModel.RequiredAction action)
action - UserModel.RequiredAction Can't be null.void removeRequiredAction(UserModel.RequiredAction action)
action - UserModel.RequiredAction Can't be null.void setUserSessionNote(String name, String value)
name - 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.Map<String,String> getUserSessionNotes()
Map<String, String> never returns nullvoid clearUserSessionNotes()
String getAuthNote(String name)
name - String If null if provided then the method will return null.String or null if no authentication note is set.void setAuthNote(String name, String value)
name - 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.void removeAuthNote(String name)
name - String If null is provided the method won't have an effect.void clearAuthNotes()
String getClientNote(String name)
name - String If null if provided then the method will return null.String or null if no client's note is set.void setClientNote(String name, String value)
name - 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.void removeClientNote(String name)
name - String If null is provided the method won't have an effect.Map<String,String> getClientNotes()
Map<String, String> never returns null.void clearClientNotes()
Set<String> getClientScopes()
Set<String> never returns null.Copyright © 2021 JBoss by Red Hat. All rights reserved.