Package org.keycloak.models.session
Class PersistentUserSessionAdapter
- java.lang.Object
-
- org.keycloak.models.session.PersistentUserSessionAdapter
-
- All Implemented Interfaces:
OfflineUserSessionModel
,UserSessionModel
public class PersistentUserSessionAdapter extends Object implements OfflineUserSessionModel
- Author:
- Marek Posolda
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
PersistentUserSessionAdapter.PersistentUserSessionData
-
Nested classes/interfaces inherited from interface org.keycloak.models.UserSessionModel
UserSessionModel.SearchableFields, UserSessionModel.SessionPersistenceState, UserSessionModel.State
-
-
Field Summary
-
Fields inherited from interface org.keycloak.models.UserSessionModel
CORRESPONDING_SESSION_ID
-
-
Constructor Summary
Constructors Constructor Description PersistentUserSessionAdapter(KeycloakSession session, PersistentUserSessionModel model, RealmModel realm, String userId, Map<String,AuthenticatedClientSessionModel> clientSessions)
PersistentUserSessionAdapter(UserSessionModel other)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Map<String,AuthenticatedClientSessionModel>
getAuthenticatedClientSessions()
Returns map where key is ID of the client (its UUID) and value is ID respectiveAuthenticatedClientSessionModel
object.String
getAuthMethod()
String
getBrokerSessionId()
If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSessionString
getBrokerUserId()
String
getId()
String
getIpAddress()
int
getLastSessionRefresh()
String
getLoginUsername()
String
getNote(String name)
Map<String,String>
getNotes()
RealmModel
getRealm()
int
getStarted()
UserSessionModel.State
getState()
PersistentUserSessionModel
getUpdatedModel()
UserModel
getUser()
String
getUserId()
int
hashCode()
boolean
isOffline()
boolean
isRememberMe()
void
removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)
Removes authenticated client sessions for all clients whose UUID is present inremovedClientUUIDS
parameter.void
removeNote(String name)
void
restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void
setLastSessionRefresh(int seconds)
void
setNote(String name, String value)
void
setState(UserSessionModel.State state)
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.models.UserSessionModel
getAuthenticatedClientSessionByClient
-
-
-
-
Constructor Detail
-
PersistentUserSessionAdapter
public PersistentUserSessionAdapter(UserSessionModel other)
-
PersistentUserSessionAdapter
public PersistentUserSessionAdapter(KeycloakSession session, PersistentUserSessionModel model, RealmModel realm, String userId, Map<String,AuthenticatedClientSessionModel> clientSessions)
-
-
Method Detail
-
getUpdatedModel
public PersistentUserSessionModel getUpdatedModel()
-
getId
public String getId()
- Specified by:
getId
in interfaceUserSessionModel
-
getBrokerSessionId
public String getBrokerSessionId()
Description copied from interface:UserSessionModel
If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession- Specified by:
getBrokerSessionId
in interfaceUserSessionModel
- Returns:
-
getBrokerUserId
public String getBrokerUserId()
- Specified by:
getBrokerUserId
in interfaceUserSessionModel
-
getUser
public UserModel getUser()
- Specified by:
getUser
in interfaceUserSessionModel
-
getUserId
public String getUserId()
- Specified by:
getUserId
in interfaceOfflineUserSessionModel
-
getRealm
public RealmModel getRealm()
- Specified by:
getRealm
in interfaceUserSessionModel
-
getLoginUsername
public String getLoginUsername()
- Specified by:
getLoginUsername
in interfaceUserSessionModel
-
getIpAddress
public String getIpAddress()
- Specified by:
getIpAddress
in interfaceUserSessionModel
-
getAuthMethod
public String getAuthMethod()
- Specified by:
getAuthMethod
in interfaceUserSessionModel
-
isRememberMe
public boolean isRememberMe()
- Specified by:
isRememberMe
in interfaceUserSessionModel
-
getStarted
public int getStarted()
- Specified by:
getStarted
in interfaceUserSessionModel
-
getLastSessionRefresh
public int getLastSessionRefresh()
- Specified by:
getLastSessionRefresh
in interfaceUserSessionModel
-
setLastSessionRefresh
public void setLastSessionRefresh(int seconds)
- Specified by:
setLastSessionRefresh
in interfaceUserSessionModel
-
isOffline
public boolean isOffline()
- Specified by:
isOffline
in interfaceUserSessionModel
-
getAuthenticatedClientSessions
public Map<String,AuthenticatedClientSessionModel> getAuthenticatedClientSessions()
Description copied from interface:UserSessionModel
Returns map where key is ID of the client (its UUID) and value is ID respectiveAuthenticatedClientSessionModel
object.- Specified by:
getAuthenticatedClientSessions
in interfaceUserSessionModel
- Returns:
-
removeAuthenticatedClientSessions
public void removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)
Description copied from interface:UserSessionModel
Removes authenticated client sessions for all clients whose UUID is present inremovedClientUUIDS
parameter.- Specified by:
removeAuthenticatedClientSessions
in interfaceUserSessionModel
-
getNote
public String getNote(String name)
- Specified by:
getNote
in interfaceUserSessionModel
-
setNote
public void setNote(String name, String value)
- Specified by:
setNote
in interfaceUserSessionModel
-
removeNote
public void removeNote(String name)
- Specified by:
removeNote
in interfaceUserSessionModel
-
getNotes
public Map<String,String> getNotes()
- Specified by:
getNotes
in interfaceUserSessionModel
-
getState
public UserSessionModel.State getState()
- Specified by:
getState
in interfaceUserSessionModel
-
setState
public void setState(UserSessionModel.State state)
- Specified by:
setState
in interfaceUserSessionModel
-
restartSession
public void restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
- Specified by:
restartSession
in interfaceUserSessionModel
-
-