Package org.keycloak.models.map.userSession

Interface MapUserSessionEntity

All Superinterfaces:

AbstractEntity, ExpirableEntity, UpdatableEntity

All Known Implementing Classes:

HotRodUserSessionEntity.AbstractHotRodUserSessionEntityDelegate, HotRodUserSessionEntityDelegate, JpaUserSessionEntity, JpaUserSessionMetadata, MapUserSessionEntity.AbstractUserSessionEntity, MapUserSessionEntityDelegate, MapUserSessionEntityFieldDelegate, MapUserSessionEntityImpl, MapUserSessionEntityImpl.Empty

public interface MapUserSessionEntity
extends AbstractEntity, UpdatableEntity, ExpirableEntity

Author:

Martin Kanis

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MapUserSessionEntity.AbstractUserSessionEntity

Nested classes/interfaces inherited from interface org.keycloak.models.map.common.UpdatableEntity

UpdatableEntity.Impl

Method Summary

Modifier and Type	Method	Description
void	addAuthenticatedClientSession(MapAuthenticatedClientSessionEntity clientSession)
void	clearAuthenticatedClientSessions()
Optional<MapAuthenticatedClientSessionEntity>	getAuthenticatedClientSession(String clientUUID)
Set<MapAuthenticatedClientSessionEntity>	getAuthenticatedClientSessions()
String	getAuthMethod()
String	getBrokerSessionId()
String	getBrokerUserId()
String	getIpAddress()
Long	getLastSessionRefresh()	Returns a point in time (timestamp in milliseconds since The Epoch) when the user session entity was last refreshed.
String	getLoginUsername()
String	getNote(String name)
Map<String,String>	getNotes()
UserSessionModel.SessionPersistenceState	getPersistenceState()
String	getRealmId()
UserSessionModel.State	getState()
Long	getTimestamp()	Returns a point in time (timestamp in milliseconds since The Epoch) when the user session entity was created.
String	getUserId()
Boolean	isOffline()
Boolean	isRememberMe()
Boolean	removeAuthenticatedClientSession(String clientUUID)
Boolean	removeNote(String name)
void	setAuthMethod(String authMethod)
void	setBrokerSessionId(String brokerSessionId)
void	setBrokerUserId(String brokerUserId)
void	setIpAddress(String ipAddress)
void	setLastSessionRefresh(Long lastSessionRefresh)	Sets a point in the (timestamp in milliseconds since The Epoch) when the user session entity was last refreshed.
void	setLoginUsername(String loginUsername)
void	setNote(String name, String value)
void	setNotes(Map<String,String> notes)
void	setOffline(Boolean offline)
void	setPersistenceState(UserSessionModel.SessionPersistenceState persistenceState)
void	setRealmId(String realmId)
void	setRememberMe(Boolean rememberMe)
void	setState(UserSessionModel.State state)
void	setTimestamp(Long timestamp)	Sets a point in the (timestamp in milliseconds since The Epoch) when the user session entity was created.
void	setUserId(String userId)

Methods inherited from interface org.keycloak.models.map.common.AbstractEntity

getId, setId

Methods inherited from interface org.keycloak.models.map.common.ExpirableEntity

getExpiration, setExpiration

Methods inherited from interface org.keycloak.models.map.common.UpdatableEntity

clearUpdatedFlag, isUpdated

Method Detail

getRealmId

String getRealmId()

setRealmId

void setRealmId(String realmId)

getUserId

String getUserId()

setUserId

void setUserId(String userId)

getBrokerSessionId

String getBrokerSessionId()

setBrokerSessionId

void setBrokerSessionId(String brokerSessionId)

getBrokerUserId

String getBrokerUserId()

setBrokerUserId

void setBrokerUserId(String brokerUserId)

getLoginUsername

String getLoginUsername()

setLoginUsername

void setLoginUsername(String loginUsername)

getIpAddress

String getIpAddress()

setIpAddress

void setIpAddress(String ipAddress)

getAuthMethod

String getAuthMethod()

setAuthMethod

void setAuthMethod(String authMethod)

isRememberMe

Boolean isRememberMe()

setRememberMe

void setRememberMe(Boolean rememberMe)

getTimestamp

Long getTimestamp()

Returns a point in time (timestamp in milliseconds since The Epoch) when the user session entity was created.

Returns:

a timestamp in milliseconds since The Epoch or null when the time is unknown

setTimestamp

void setTimestamp(Long timestamp)

Sets a point in the (timestamp in milliseconds since The Epoch) when the user session entity was created.

Parameters:

timestamp - a timestamp in milliseconds since The Epoch or null when the time is unknown

getLastSessionRefresh

Long getLastSessionRefresh()

Returns a point in time (timestamp in milliseconds since The Epoch) when the user session entity was last refreshed.

Returns:

a timestamp in milliseconds since The Epoch or null when the time is unknown

setLastSessionRefresh

void setLastSessionRefresh(Long lastSessionRefresh)

Sets a point in the (timestamp in milliseconds since The Epoch) when the user session entity was last refreshed.

Parameters:

lastSessionRefresh - a timestamp in milliseconds since The Epoch or null when the time is unknown

getNotes

Map<String,String> getNotes()

getNote

String getNote(String name)

setNotes

void setNotes(Map<String,String> notes)

removeNote

Boolean removeNote(String name)

setNote

void setNote(String name,
             String value)

getState

UserSessionModel.State getState()

setState

void setState(UserSessionModel.State state)

getAuthenticatedClientSessions

Set<MapAuthenticatedClientSessionEntity> getAuthenticatedClientSessions()

getAuthenticatedClientSession

Optional<MapAuthenticatedClientSessionEntity> getAuthenticatedClientSession(String clientUUID)

addAuthenticatedClientSession

void addAuthenticatedClientSession(MapAuthenticatedClientSessionEntity clientSession)

removeAuthenticatedClientSession

Boolean removeAuthenticatedClientSession(String clientUUID)

clearAuthenticatedClientSessions

void clearAuthenticatedClientSessions()

isOffline

Boolean isOffline()

setOffline

void setOffline(Boolean offline)

getPersistenceState

UserSessionModel.SessionPersistenceState getPersistenceState()

setPersistenceState

void setPersistenceState(UserSessionModel.SessionPersistenceState persistenceState)