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

Class JpaRootAuthenticationSessionEntity

java.lang.Object

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

org.keycloak.models.map.authSession.MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity

org.keycloak.models.map.storage.jpa.authSession.entity.JpaRootAuthenticationSessionEntity

All Implemented Interfaces:

Serializable, MapRootAuthenticationSessionEntity, AbstractEntity, ExpirableEntity, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaRootAuthenticationSessionEntity
extends MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity
implements JpaRootVersionedEntity

Entity represents root authentication session. 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.authSession.MapRootAuthenticationSessionEntity

MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity

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

UpdatableEntity.Impl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TABLE_NAME

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

updated

Constructor Summary

Constructors

Constructor	Description
JpaRootAuthenticationSessionEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaRootAuthenticationSessionEntity(UUID id, int version, Integer entityVersion, String realmId, Long timestamp, Long expiration)	Used by hibernate when calling cb.construct from read(QueryParameters) method.
JpaRootAuthenticationSessionEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addAuthenticationSession(MapAuthenticationSessionEntity authenticationSession)
boolean	equals(Object obj)
Optional<MapAuthenticationSessionEntity>	getAuthenticationSession(String tabId)
Set<MapAuthenticationSessionEntity>	getAuthenticationSessions()
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	getRealmId()
Long	getTimestamp()	Returns a point in time (timestamp in milliseconds since The Epoch) when the root authentication session entity was created or updated during an authentication process.
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
Boolean	removeAuthenticationSession(String tabId)
void	setAuthenticationSessions(Set<MapAuthenticationSessionEntity> authenticationSessions)
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	setRealmId(String realmId)
void	setTimestamp(Long timestamp)	Sets a point in the (timestamp in milliseconds since The Epoch) when the root authentication session entity was created or updated during an authentication process.

Methods inherited from class org.keycloak.models.map.authSession.MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity

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

Field Details

TABLE_NAME

public static final String TABLE_NAME

See Also:

• Constant Field Values

Constructor Details

JpaRootAuthenticationSessionEntity

public JpaRootAuthenticationSessionEntity()

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

JpaRootAuthenticationSessionEntity

public JpaRootAuthenticationSessionEntity(DeepCloner cloner)

JpaRootAuthenticationSessionEntity

public JpaRootAuthenticationSessionEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 Long timestamp,
 Long expiration)

Used by hibernate when calling cb.construct from read(QueryParameters) method. It is used to select root auth session without metadata(json) field.

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 MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapRootAuthenticationSessionEntity.AbstractRootAuthenticationSessionEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapRootAuthenticationSessionEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapRootAuthenticationSessionEntity

getTimestamp

public Long getTimestamp()

Description copied from interface: MapRootAuthenticationSessionEntity

Returns a point in time (timestamp in milliseconds since The Epoch) when the root authentication session entity was created or updated during an authentication process.

Specified by:

getTimestamp in interface MapRootAuthenticationSessionEntity

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: MapRootAuthenticationSessionEntity

Sets a point in the (timestamp in milliseconds since The Epoch) when the root authentication session entity was created or updated during an authentication process.

Specified by:

setTimestamp in interface MapRootAuthenticationSessionEntity

Parameters:

timestamp - 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.

getAuthenticationSessions

public Set<MapAuthenticationSessionEntity> getAuthenticationSessions()

Specified by:

getAuthenticationSessions in interface MapRootAuthenticationSessionEntity

setAuthenticationSessions

public void setAuthenticationSessions(Set<MapAuthenticationSessionEntity> authenticationSessions)

Specified by:

setAuthenticationSessions in interface MapRootAuthenticationSessionEntity

addAuthenticationSession

public void addAuthenticationSession(MapAuthenticationSessionEntity authenticationSession)

Specified by:

addAuthenticationSession in interface MapRootAuthenticationSessionEntity

getAuthenticationSession

public Optional<MapAuthenticationSessionEntity> getAuthenticationSession(String tabId)

Specified by:

getAuthenticationSession in interface MapRootAuthenticationSessionEntity

removeAuthenticationSession

public Boolean removeAuthenticationSession(String tabId)

Specified by:

removeAuthenticationSession in interface MapRootAuthenticationSessionEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object