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

Class JpaAuthenticationSessionEntity

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, MapAuthenticationSessionEntity, AbstractEntity, UpdatableEntity, JpaChildEntity<JpaRootAuthenticationSessionEntity>, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaAuthenticationSessionEntity
extends UpdatableEntity.Impl
implements MapAuthenticationSessionEntity, JpaRootVersionedEntity, JpaChildEntity<JpaRootAuthenticationSessionEntity>

Entity represents individual authentication session.

See Also:

• Serialized Form

Nested Class Summary

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
JpaAuthenticationSessionEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaAuthenticationSessionEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addRequiredAction(String requiredAction)
boolean	equals(Object obj)
String	getAction()
Map<String,String>	getAuthNotes()
String	getAuthUserId()
Map<String,String>	getClientNotes()
Set<String>	getClientScopes()
String	getClientUUID()
Integer	getCurrentSchemaVersion()
Integer	getEntityVersion()
Map<String,CommonClientSessionModel.ExecutionStatus>	getExecutionStatuses()
String	getId()
JpaRootAuthenticationSessionEntity	getParent()	Parent entity that should get its optimistic locking version updated upon changes in the child
String	getProtocol()
String	getRedirectUri()
Set<String>	getRequiredActions()
String	getTabId()
Long	getTimestamp()	Returns a point in time (timestamp in milliseconds since The Epoch) when the authentication session entity was created.
Map<String,String>	getUserSessionNotes()
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
void	removeAuthNote(String name)
void	removeClientNote(String name)
void	removeRequiredAction(String action)
void	setAction(String action)
void	setAuthNote(String name, String value)
void	setAuthNotes(Map<String,String> authNotes)
void	setAuthUserId(String authUserId)
void	setClientNote(String name, String value)
void	setClientNotes(Map<String,String> clientNotes)
void	setClientScopes(Set<String> clientScopes)
void	setClientUUID(String clientUUID)
void	setEntityVersion(Integer version)
void	setExecutionStatus(String authenticator, CommonClientSessionModel.ExecutionStatus status)
void	setExecutionStatuses(Map<String,CommonClientSessionModel.ExecutionStatus> executionStatus)
void	setId(String id)
void	setParent(JpaRootAuthenticationSessionEntity root)
void	setProtocol(String protocol)
void	setRedirectUri(String redirectUri)
void	setRequiredActions(Set<String> requiredActions)
void	setTabId(String tabId)
void	setTimestamp(Long timestamp)	Sets a point in the (timestamp in milliseconds since The Epoch) when the authentication session entity was created.
void	setUserSessionNote(String name, String value)
void	setUserSessionNotes(Map<String,String> userSessionNotes)

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

clearUpdatedFlag, isUpdated, 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

clearUpdatedFlag, isUpdated, markUpdatedFlag

Field Details

TABLE_NAME

public static final String TABLE_NAME

See Also:

• Constant Field Values

Constructor Details

JpaAuthenticationSessionEntity

public JpaAuthenticationSessionEntity()

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

JpaAuthenticationSessionEntity

public JpaAuthenticationSessionEntity(DeepCloner cloner)

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getParent

public JpaRootAuthenticationSessionEntity getParent()

Description copied from interface: JpaChildEntity

Parent entity that should get its optimistic locking version updated upon changes in the child

Specified by:

getParent in interface JpaChildEntity<JpaRootAuthenticationSessionEntity>

setParent

public void setParent(JpaRootAuthenticationSessionEntity root)

getId

public String getId()

Specified by:

getId in interface AbstractEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

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 version)

Specified by:

setEntityVersion in interface JpaRootEntity

Parameters:

version - 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

getTabId

public String getTabId()

Specified by:

getTabId in interface MapAuthenticationSessionEntity

setTabId

public void setTabId(String tabId)

Specified by:

setTabId in interface MapAuthenticationSessionEntity

getUserSessionNotes

public Map<String,String> getUserSessionNotes()

Specified by:

getUserSessionNotes in interface MapAuthenticationSessionEntity

setUserSessionNotes

public void setUserSessionNotes(Map<String,String> userSessionNotes)

Specified by:

setUserSessionNotes in interface MapAuthenticationSessionEntity

setUserSessionNote

public void setUserSessionNote(String name,
 String value)

Specified by:

setUserSessionNote in interface MapAuthenticationSessionEntity

getClientUUID

public String getClientUUID()

Specified by:

getClientUUID in interface MapAuthenticationSessionEntity

setClientUUID

public void setClientUUID(String clientUUID)

Specified by:

setClientUUID in interface MapAuthenticationSessionEntity

getAuthUserId

public String getAuthUserId()

Specified by:

getAuthUserId in interface MapAuthenticationSessionEntity

setAuthUserId

public void setAuthUserId(String authUserId)

Specified by:

setAuthUserId in interface MapAuthenticationSessionEntity

getTimestamp

public Long getTimestamp()

Description copied from interface: MapAuthenticationSessionEntity

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

Specified by:

getTimestamp in interface MapAuthenticationSessionEntity

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

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

Specified by:

setTimestamp in interface MapAuthenticationSessionEntity

Parameters:

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

getRedirectUri

public String getRedirectUri()

Specified by:

getRedirectUri in interface MapAuthenticationSessionEntity

setRedirectUri

public void setRedirectUri(String redirectUri)

Specified by:

setRedirectUri in interface MapAuthenticationSessionEntity

getAction

public String getAction()

Specified by:

getAction in interface MapAuthenticationSessionEntity

setAction

public void setAction(String action)

Specified by:

setAction in interface MapAuthenticationSessionEntity

getClientScopes

public Set<String> getClientScopes()

Specified by:

getClientScopes in interface MapAuthenticationSessionEntity

setClientScopes

public void setClientScopes(Set<String> clientScopes)

Specified by:

setClientScopes in interface MapAuthenticationSessionEntity

getRequiredActions

public Set<String> getRequiredActions()

Specified by:

getRequiredActions in interface MapAuthenticationSessionEntity

setRequiredActions

public void setRequiredActions(Set<String> requiredActions)

Specified by:

setRequiredActions in interface MapAuthenticationSessionEntity

addRequiredAction

public void addRequiredAction(String requiredAction)

Specified by:

addRequiredAction in interface MapAuthenticationSessionEntity

removeRequiredAction

public void removeRequiredAction(String action)

Specified by:

removeRequiredAction in interface MapAuthenticationSessionEntity

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface MapAuthenticationSessionEntity

setProtocol

public void setProtocol(String protocol)

Specified by:

setProtocol in interface MapAuthenticationSessionEntity

getClientNotes

public Map<String,String> getClientNotes()

Specified by:

getClientNotes in interface MapAuthenticationSessionEntity

setClientNotes

public void setClientNotes(Map<String,String> clientNotes)

Specified by:

setClientNotes in interface MapAuthenticationSessionEntity

setClientNote

public void setClientNote(String name,
 String value)

Specified by:

setClientNote in interface MapAuthenticationSessionEntity

removeClientNote

public void removeClientNote(String name)

Specified by:

removeClientNote in interface MapAuthenticationSessionEntity

getAuthNotes

public Map<String,String> getAuthNotes()

Specified by:

getAuthNotes in interface MapAuthenticationSessionEntity

setAuthNotes

public void setAuthNotes(Map<String,String> authNotes)

Specified by:

setAuthNotes in interface MapAuthenticationSessionEntity

setAuthNote

public void setAuthNote(String name,
 String value)

Specified by:

setAuthNote in interface MapAuthenticationSessionEntity

removeAuthNote

public void removeAuthNote(String name)

Specified by:

removeAuthNote in interface MapAuthenticationSessionEntity

getExecutionStatuses

public Map<String,CommonClientSessionModel.ExecutionStatus> getExecutionStatuses()

Specified by:

getExecutionStatuses in interface MapAuthenticationSessionEntity

setExecutionStatuses

public void setExecutionStatuses(Map<String,CommonClientSessionModel.ExecutionStatus> executionStatus)

Specified by:

setExecutionStatuses in interface MapAuthenticationSessionEntity

setExecutionStatus

public void setExecutionStatus(String authenticator,
 CommonClientSessionModel.ExecutionStatus status)

Specified by:

setExecutionStatus in interface MapAuthenticationSessionEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object