Package org.keycloak.models.map.storage.jpa.userSession.entity

Class JpaUserSessionEntity

java.lang.Object

org.keycloak.models.map.common.UpdatableEntity.Impl

org.keycloak.models.map.userSession.MapUserSessionEntity.AbstractUserSessionEntity

org.keycloak.models.map.storage.jpa.userSession.entity.JpaUserSessionEntity

All Implemented Interfaces:

Serializable, AbstractEntity, ExpirableEntity, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity, MapUserSessionEntity

@Entity
public class JpaUserSessionEntity
extends MapUserSessionEntity.AbstractUserSessionEntity
implements JpaRootVersionedEntity

There are some fields marked by @Column(insertable = false, updatable = false). Those fields are automatically generated by database from json field, therefore marked as non-insertable and non-updatable to instruct hibernate.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.userSession.MapUserSessionEntity

MapUserSessionEntity.AbstractUserSessionEntity

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

UpdatableEntity.Impl

Field Summary

Fields inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

updated

Constructor Summary

Constructors

Constructor	Description
JpaUserSessionEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaUserSessionEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addAuthenticatedClientSession(MapAuthenticatedClientSessionEntity clientSession)
void	clearAuthenticatedClientSessions()
boolean	equals(Object obj)
Optional<MapAuthenticatedClientSessionEntity>	getAuthenticatedClientSession(String clientUUID)
Set<MapAuthenticatedClientSessionEntity>	getAuthenticatedClientSessions()
String	getAuthMethod()
String	getBrokerSessionId()
String	getBrokerUserId()
Integer	getCurrentSchemaVersion()
Integer	getEntityVersion()
Long	getExpiration()	Returns a point in the time (timestamp in milliseconds since The Epoch) when this entity expires.
String	getId()
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()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
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	setEntityVersion(Integer entityVersion)
void	setExpiration(Long expiration)	Sets a point in the time (timestamp in milliseconds since The Epoch) when this entity expires.
void	setId(String id)
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 class org.keycloak.models.map.userSession.MapUserSessionEntity.AbstractUserSessionEntity

clearUpdatedFlag, isUpdated

Methods inherited from class org.keycloak.models.map.common.UpdatableEntity.Impl

markUpdatedFlag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.map.storage.jpa.JpaRootEntity

updateEntityVersion

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

markUpdatedFlag

Constructor Details

JpaUserSessionEntity

public JpaUserSessionEntity()

No-argument constructor, used by hibernate to instantiate entities.

JpaUserSessionEntity

public JpaUserSessionEntity(DeepCloner cloner)

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getEntityVersion

public Integer getEntityVersion()

Specified by:

getEntityVersion in interface JpaRootEntity

Returns:

current supported version of the JPA entity used for schema versioning.

setEntityVersion

public void setEntityVersion(Integer entityVersion)

Specified by:

setEntityVersion in interface JpaRootEntity

Parameters:

entityVersion - sets current supported version to JPA entity.

getCurrentSchemaVersion

public Integer getCurrentSchemaVersion()

Specified by:

getCurrentSchemaVersion in interface JpaRootEntity

getVersion

public int getVersion()

Description copied from interface: JpaRootVersionedEntity

Version of the JPA entity used for optimistic locking

Specified by:

getVersion in interface JpaRootVersionedEntity

getId

public String getId()

Specified by:

getId in interface AbstractEntity

Overrides:

getId in class MapUserSessionEntity.AbstractUserSessionEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapUserSessionEntity.AbstractUserSessionEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapUserSessionEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapUserSessionEntity

getUserId

public String getUserId()

Specified by:

getUserId in interface MapUserSessionEntity

setUserId

public void setUserId(String userId)

Specified by:

setUserId in interface MapUserSessionEntity

getLoginUsername

public String getLoginUsername()

Specified by:

getLoginUsername in interface MapUserSessionEntity

setLoginUsername

public void setLoginUsername(String loginUsername)

Specified by:

setLoginUsername in interface MapUserSessionEntity

getIpAddress

public String getIpAddress()

Specified by:

getIpAddress in interface MapUserSessionEntity

setIpAddress

public void setIpAddress(String ipAddress)

Specified by:

setIpAddress in interface MapUserSessionEntity

getAuthMethod

public String getAuthMethod()

Specified by:

getAuthMethod in interface MapUserSessionEntity

setAuthMethod

public void setAuthMethod(String authMethod)

Specified by:

setAuthMethod in interface MapUserSessionEntity

isOffline

public Boolean isOffline()

Specified by:

isOffline in interface MapUserSessionEntity

setOffline

public void setOffline(Boolean offline)

Specified by:

setOffline in interface MapUserSessionEntity

isRememberMe

public Boolean isRememberMe()

Specified by:

isRememberMe in interface MapUserSessionEntity

setRememberMe

public void setRememberMe(Boolean rememberMe)

Specified by:

setRememberMe in interface MapUserSessionEntity

getTimestamp

public Long getTimestamp()

Description copied from interface: MapUserSessionEntity

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

Specified by:

getTimestamp in interface MapUserSessionEntity

Returns:

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

setTimestamp

public void setTimestamp(Long timestamp)

Description copied from interface: MapUserSessionEntity

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

Specified by:

setTimestamp in interface MapUserSessionEntity

Parameters:

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

getLastSessionRefresh

public Long getLastSessionRefresh()

Description copied from interface: MapUserSessionEntity

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

Specified by:

getLastSessionRefresh in interface MapUserSessionEntity

Returns:

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

setLastSessionRefresh

public void setLastSessionRefresh(Long lastSessionRefresh)

Description copied from interface: MapUserSessionEntity

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

Specified by:

setLastSessionRefresh in interface MapUserSessionEntity

Parameters:

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

getExpiration

public Long getExpiration()

Description copied from interface: ExpirableEntity

Returns a point in the time (timestamp in milliseconds since The Epoch) when this entity expires.

Specified by:

getExpiration in interface ExpirableEntity

Returns:

a timestamp in milliseconds since The Epoch or null if this entity never expires or expiration is not known.

setExpiration

public void setExpiration(Long expiration)

Description copied from interface: ExpirableEntity

Sets a point in the time (timestamp in milliseconds since The Epoch) when this entity expires.

Specified by:

setExpiration in interface ExpirableEntity

Parameters:

expiration - a timestamp in milliseconds since The Epoch or null if this entity never expires.

getState

public UserSessionModel.State getState()

Specified by:

getState in interface MapUserSessionEntity

setState

public void setState(UserSessionModel.State state)

Specified by:

setState in interface MapUserSessionEntity

getPersistenceState

public UserSessionModel.SessionPersistenceState getPersistenceState()

Specified by:

getPersistenceState in interface MapUserSessionEntity

setPersistenceState

public void setPersistenceState(UserSessionModel.SessionPersistenceState persistenceState)

Specified by:

setPersistenceState in interface MapUserSessionEntity

getNotes

public Map<String,String> getNotes()

Specified by:

getNotes in interface MapUserSessionEntity

getNote

public String getNote(String name)

Specified by:

getNote in interface MapUserSessionEntity

setNotes

public void setNotes(Map<String,String> notes)

Specified by:

setNotes in interface MapUserSessionEntity

removeNote

public Boolean removeNote(String name)

Specified by:

removeNote in interface MapUserSessionEntity

setNote

public void setNote(String name,
 String value)

Specified by:

setNote in interface MapUserSessionEntity

getBrokerSessionId

public String getBrokerSessionId()

Specified by:

getBrokerSessionId in interface MapUserSessionEntity

setBrokerSessionId

public void setBrokerSessionId(String brokerSessionId)

Specified by:

setBrokerSessionId in interface MapUserSessionEntity

getBrokerUserId

public String getBrokerUserId()

Specified by:

getBrokerUserId in interface MapUserSessionEntity

setBrokerUserId

public void setBrokerUserId(String brokerUserId)

Specified by:

setBrokerUserId in interface MapUserSessionEntity

getAuthenticatedClientSessions

public Set<MapAuthenticatedClientSessionEntity> getAuthenticatedClientSessions()

Specified by:

getAuthenticatedClientSessions in interface MapUserSessionEntity

addAuthenticatedClientSession

public void addAuthenticatedClientSession(MapAuthenticatedClientSessionEntity clientSession)

Specified by:

addAuthenticatedClientSession in interface MapUserSessionEntity

getAuthenticatedClientSession

public Optional<MapAuthenticatedClientSessionEntity> getAuthenticatedClientSession(String clientUUID)

Specified by:

getAuthenticatedClientSession in interface MapUserSessionEntity

removeAuthenticatedClientSession

public Boolean removeAuthenticatedClientSession(String clientUUID)

Specified by:

removeAuthenticatedClientSession in interface MapUserSessionEntity

clearAuthenticatedClientSessions

public void clearAuthenticatedClientSessions()

Specified by:

clearAuthenticatedClientSessions in interface MapUserSessionEntity

Overrides:

clearAuthenticatedClientSessions in class MapUserSessionEntity.AbstractUserSessionEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object