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

Class JpaClientSessionEntity

java.lang.Object

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

org.keycloak.models.map.userSession.MapAuthenticatedClientSessionEntity.AbstractAuthenticatedClientSessionEntity

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

All Implemented Interfaces:

Serializable, AbstractEntity, ExpirableEntity, UpdatableEntity, JpaChildEntity<JpaUserSessionEntity>, JpaRootEntity, JpaRootVersionedEntity, MapAuthenticatedClientSessionEntity

@Entity
public class JpaClientSessionEntity
extends MapAuthenticatedClientSessionEntity.AbstractAuthenticatedClientSessionEntity
implements JpaRootVersionedEntity, JpaChildEntity<JpaUserSessionEntity>

Entity represents authenticated client session.

See Also:

• Serialized Form

Nested Class Summary

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

MapAuthenticatedClientSessionEntity.AbstractAuthenticatedClientSessionEntity

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAction()
String	getAuthMethod()
String	getClientId()
String	getCurrentRefreshToken()
Integer	getCurrentRefreshTokenUseCount()
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	getNote(String name)
Map<String,String>	getNotes()
JpaUserSessionEntity	getParent()	Parent entity that should get its optimistic locking version updated upon changes in the child
String	getRealmId()
String	getRedirectUri()
Long	getTimestamp()	Returns a point in time (timestamp in milliseconds since The Epoch) when the client session entity was created or updated (refreshed).
int	getVersion()	Version of the JPA entity used for optimistic locking
int	hashCode()
boolean	isMetadataInitialized()
Boolean	isOffline()
Boolean	removeNote(String name)
void	setAction(String action)
void	setAuthMethod(String authMethod)
void	setClientId(String clientId)
void	setCurrentRefreshToken(String currentRefreshToken)
void	setCurrentRefreshTokenUseCount(Integer currentRefreshTokenUseCount)
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	setNote(String name, String value)
void	setNotes(Map<String,String> notes)
void	setOffline(Boolean offline)
void	setParent(JpaUserSessionEntity root)
void	setRealmId(String realmId)
void	setRedirectUri(String redirectUri)
void	setTimestamp(Long timestamp)	Sets a point in the (timestamp in milliseconds since The Epoch) when the client session entity was created or updated (refreshed).

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

Constructor Details

JpaClientSessionEntity

public JpaClientSessionEntity()

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

JpaClientSessionEntity

public JpaClientSessionEntity(DeepCloner cloner)

Method Details

isMetadataInitialized

public boolean isMetadataInitialized()

getParent

public JpaUserSessionEntity 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<JpaUserSessionEntity>

setParent

public void setParent(JpaUserSessionEntity root)

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 MapAuthenticatedClientSessionEntity.AbstractAuthenticatedClientSessionEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapAuthenticatedClientSessionEntity.AbstractAuthenticatedClientSessionEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapAuthenticatedClientSessionEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapAuthenticatedClientSessionEntity

getClientId

public String getClientId()

Specified by:

getClientId in interface MapAuthenticatedClientSessionEntity

setClientId

public void setClientId(String clientId)

Specified by:

setClientId in interface MapAuthenticatedClientSessionEntity

getAuthMethod

public String getAuthMethod()

Specified by:

getAuthMethod in interface MapAuthenticatedClientSessionEntity

setAuthMethod

public void setAuthMethod(String authMethod)

Specified by:

setAuthMethod in interface MapAuthenticatedClientSessionEntity

getRedirectUri

public String getRedirectUri()

Specified by:

getRedirectUri in interface MapAuthenticatedClientSessionEntity

setRedirectUri

public void setRedirectUri(String redirectUri)

Specified by:

setRedirectUri in interface MapAuthenticatedClientSessionEntity

getTimestamp

public Long getTimestamp()

Description copied from interface: MapAuthenticatedClientSessionEntity

Returns a point in time (timestamp in milliseconds since The Epoch) when the client session entity was created or updated (refreshed).

Specified by:

getTimestamp in interface MapAuthenticatedClientSessionEntity

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

Sets a point in the (timestamp in milliseconds since The Epoch) when the client session entity was created or updated (refreshed).

Specified by:

setTimestamp in interface MapAuthenticatedClientSessionEntity

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.

getAction

public String getAction()

Specified by:

getAction in interface MapAuthenticatedClientSessionEntity

setAction

public void setAction(String action)

Specified by:

setAction in interface MapAuthenticatedClientSessionEntity

getCurrentRefreshToken

public String getCurrentRefreshToken()

Specified by:

getCurrentRefreshToken in interface MapAuthenticatedClientSessionEntity

setCurrentRefreshToken

public void setCurrentRefreshToken(String currentRefreshToken)

Specified by:

setCurrentRefreshToken in interface MapAuthenticatedClientSessionEntity

getCurrentRefreshTokenUseCount

public Integer getCurrentRefreshTokenUseCount()

Specified by:

getCurrentRefreshTokenUseCount in interface MapAuthenticatedClientSessionEntity

setCurrentRefreshTokenUseCount

public void setCurrentRefreshTokenUseCount(Integer currentRefreshTokenUseCount)

Specified by:

setCurrentRefreshTokenUseCount in interface MapAuthenticatedClientSessionEntity

isOffline

public Boolean isOffline()

Specified by:

isOffline in interface MapAuthenticatedClientSessionEntity

setOffline

public void setOffline(Boolean offline)

Specified by:

setOffline in interface MapAuthenticatedClientSessionEntity

getNotes

public Map<String,String> getNotes()

Specified by:

getNotes in interface MapAuthenticatedClientSessionEntity

setNotes

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

Specified by:

setNotes in interface MapAuthenticatedClientSessionEntity

getNote

public String getNote(String name)

Specified by:

getNote in interface MapAuthenticatedClientSessionEntity

removeNote

public Boolean removeNote(String name)

Specified by:

removeNote in interface MapAuthenticatedClientSessionEntity

setNote

public void setNote(String name,
 String value)

Specified by:

setNote in interface MapAuthenticatedClientSessionEntity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object