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

Class JpaClientEntity

java.lang.Object

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

org.keycloak.models.map.client.MapClientEntity.AbstractClientEntity

org.keycloak.models.map.storage.jpa.client.entity.JpaClientEntity

All Implemented Interfaces:

Serializable, MapClientEntity, AbstractEntity, EntityWithAttributes, UpdatableEntity, JpaRootEntity, JpaRootVersionedEntity

@Entity
public class JpaClientEntity
extends MapClientEntity.AbstractClientEntity
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.client.MapClientEntity

MapClientEntity.AbstractClientEntity

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
JpaClientEntity()	No-argument constructor, used by hibernate to instantiate entities.
JpaClientEntity(UUID id, int version, Integer entityVersion, String realmId, String clientId, String protocol, Boolean enabled)	Used by hibernate when calling cb.construct from read(QueryParameters) method.
JpaClientEntity(DeepCloner cloner)

Method Summary

Modifier and Type	Method	Description
void	addProtocolMapper(MapProtocolMapperEntity mapping)
void	addRedirectUri(String redirectUri)
void	addScopeMapping(String id)
void	addWebOrigin(String webOrigin)
boolean	equals(Object obj)
List<String>	getAttribute(String name)
Map<String,List<String>>	getAttributes()
String	getAuthenticationFlowBindingOverride(String binding)
Map<String,String>	getAuthenticationFlowBindingOverrides()
String	getBaseUrl()
String	getClientAuthenticatorType()
String	getClientId()
Map<String,Boolean>	getClientScopes()
Integer	getCurrentSchemaVersion()
String	getDescription()
Integer	getEntityVersion()
String	getId()
String	getManagementUrl()
String	getName()
Integer	getNodeReRegistrationTimeout()
Long	getNotBefore()
String	getProtocol()
Optional<MapProtocolMapperEntity>	getProtocolMapper(String id)
Set<MapProtocolMapperEntity>	getProtocolMappers()
String	getRealmId()
Set<String>	getRedirectUris()
String	getRegistrationToken()
String	getRootUrl()
Set<String>	getScope()
Collection<String>	getScopeMappings()
String	getSecret()
int	getVersion()	Version of the JPA entity used for optimistic locking
Set<String>	getWebOrigins()
int	hashCode()
Boolean	isAlwaysDisplayInConsole()
Boolean	isBearerOnly()
Boolean	isConsentRequired()
Boolean	isDirectAccessGrantsEnabled()
Boolean	isEnabled()
Boolean	isFrontchannelLogout()
Boolean	isFullScopeAllowed()
Boolean	isImplicitFlowEnabled()
boolean	isMetadataInitialized()
Boolean	isPublicClient()
Boolean	isServiceAccountsEnabled()
Boolean	isStandardFlowEnabled()
Boolean	isSurrogateAuthRequired()
void	removeAttribute(String name)
void	removeAuthenticationFlowBindingOverride(String binding)
void	removeClientScope(String id)
void	removeProtocolMapper(String id)
void	removeRedirectUri(String redirectUri)
void	removeScopeMapping(String id)
void	removeWebOrigin(String webOrigin)
void	setAlwaysDisplayInConsole(Boolean alwaysDisplayInConsole)
void	setAttribute(String name, List<String> values)
void	setAttributes(Map<String,List<String>> attributes)
void	setAuthenticationFlowBindingOverride(String binding, String flowId)
void	setBaseUrl(String baseUrl)
void	setBearerOnly(Boolean bearerOnly)
void	setClientAuthenticatorType(String clientAuthenticatorType)
void	setClientId(String clientId)
void	setClientScope(String id, Boolean defaultScope)
void	setConsentRequired(Boolean consentRequired)
void	setDescription(String description)
void	setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)
void	setEnabled(Boolean enabled)
void	setEntityVersion(Integer entityVersion)
void	setFrontchannelLogout(Boolean frontchannelLogout)
void	setFullScopeAllowed(Boolean fullScopeAllowed)
void	setId(String id)
void	setImplicitFlowEnabled(Boolean implicitFlowEnabled)
void	setManagementUrl(String managementUrl)
void	setName(String name)
void	setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)
void	setNotBefore(Long notBefore)
void	setProtocol(String protocol)
void	setPublicClient(Boolean publicClient)
void	setRealmId(String realmId)
void	setRedirectUris(Set<String> redirectUris)
void	setRegistrationToken(String registrationToken)
void	setRootUrl(String rootUrl)
void	setScope(Set<String> scope)
void	setSecret(String secret)
void	setServiceAccountsEnabled(Boolean serviceAccountsEnabled)
void	setStandardFlowEnabled(Boolean standardFlowEnabled)
void	setSurrogateAuthRequired(Boolean surrogateAuthRequired)
void	setWebOrigins(Set<String> webOrigins)

Methods inherited from class org.keycloak.models.map.client.MapClientEntity.AbstractClientEntity

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

JpaClientEntity

public JpaClientEntity()

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

JpaClientEntity

public JpaClientEntity(DeepCloner cloner)

JpaClientEntity

public JpaClientEntity(UUID id,
 int version,
 Integer entityVersion,
 String realmId,
 String clientId,
 String protocol,
 Boolean enabled)

Used by hibernate when calling cb.construct from read(QueryParameters) method. It is used to select client 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 MapClientEntity.AbstractClientEntity

setId

public void setId(String id)

Specified by:

setId in interface AbstractEntity

Overrides:

setId in class MapClientEntity.AbstractClientEntity

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface MapClientEntity

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface MapClientEntity

getClientId

public String getClientId()

Specified by:

getClientId in interface MapClientEntity

setClientId

public void setClientId(String clientId)

Specified by:

setClientId in interface MapClientEntity

setEnabled

public void setEnabled(Boolean enabled)

Specified by:

setEnabled in interface MapClientEntity

isEnabled

public Boolean isEnabled()

Specified by:

isEnabled in interface MapClientEntity

getClientScopes

public Map<String,Boolean> getClientScopes()

Specified by:

getClientScopes in interface MapClientEntity

setClientScope

public void setClientScope(String id,
 Boolean defaultScope)

Specified by:

setClientScope in interface MapClientEntity

removeClientScope

public void removeClientScope(String id)

Specified by:

removeClientScope in interface MapClientEntity

getProtocolMappers

public Set<MapProtocolMapperEntity> getProtocolMappers()

Specified by:

getProtocolMappers in interface MapClientEntity

getProtocolMapper

public Optional<MapProtocolMapperEntity> getProtocolMapper(String id)

Specified by:

getProtocolMapper in interface MapClientEntity

addProtocolMapper

public void addProtocolMapper(MapProtocolMapperEntity mapping)

Specified by:

addProtocolMapper in interface MapClientEntity

removeProtocolMapper

public void removeProtocolMapper(String id)

Specified by:

removeProtocolMapper in interface MapClientEntity

addRedirectUri

public void addRedirectUri(String redirectUri)

Specified by:

addRedirectUri in interface MapClientEntity

getRedirectUris

public Set<String> getRedirectUris()

Specified by:

getRedirectUris in interface MapClientEntity

removeRedirectUri

public void removeRedirectUri(String redirectUri)

Specified by:

removeRedirectUri in interface MapClientEntity

setRedirectUris

public void setRedirectUris(Set<String> redirectUris)

Specified by:

setRedirectUris in interface MapClientEntity

addScopeMapping

public void addScopeMapping(String id)

Specified by:

addScopeMapping in interface MapClientEntity

removeScopeMapping

public void removeScopeMapping(String id)

Specified by:

removeScopeMapping in interface MapClientEntity

getScopeMappings

public Collection<String> getScopeMappings()

Specified by:

getScopeMappings in interface MapClientEntity

addWebOrigin

public void addWebOrigin(String webOrigin)

Specified by:

addWebOrigin in interface MapClientEntity

getWebOrigins

public Set<String> getWebOrigins()

Specified by:

getWebOrigins in interface MapClientEntity

removeWebOrigin

public void removeWebOrigin(String webOrigin)

Specified by:

removeWebOrigin in interface MapClientEntity

setWebOrigins

public void setWebOrigins(Set<String> webOrigins)

Specified by:

setWebOrigins in interface MapClientEntity

getAuthenticationFlowBindingOverride

public String getAuthenticationFlowBindingOverride(String binding)

Specified by:

getAuthenticationFlowBindingOverride in interface MapClientEntity

getAuthenticationFlowBindingOverrides

public Map<String,String> getAuthenticationFlowBindingOverrides()

Specified by:

getAuthenticationFlowBindingOverrides in interface MapClientEntity

removeAuthenticationFlowBindingOverride

public void removeAuthenticationFlowBindingOverride(String binding)

Specified by:

removeAuthenticationFlowBindingOverride in interface MapClientEntity

setAuthenticationFlowBindingOverride

public void setAuthenticationFlowBindingOverride(String binding,
 String flowId)

Specified by:

setAuthenticationFlowBindingOverride in interface MapClientEntity

getBaseUrl

public String getBaseUrl()

Specified by:

getBaseUrl in interface MapClientEntity

setBaseUrl

public void setBaseUrl(String baseUrl)

Specified by:

setBaseUrl in interface MapClientEntity

getClientAuthenticatorType

public String getClientAuthenticatorType()

Specified by:

getClientAuthenticatorType in interface MapClientEntity

setClientAuthenticatorType

public void setClientAuthenticatorType(String clientAuthenticatorType)

Specified by:

setClientAuthenticatorType in interface MapClientEntity

getDescription

public String getDescription()

Specified by:

getDescription in interface MapClientEntity

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MapClientEntity

getManagementUrl

public String getManagementUrl()

Specified by:

getManagementUrl in interface MapClientEntity

setManagementUrl

public void setManagementUrl(String managementUrl)

Specified by:

setManagementUrl in interface MapClientEntity

getName

public String getName()

Specified by:

getName in interface MapClientEntity

setName

public void setName(String name)

Specified by:

setName in interface MapClientEntity

getNodeReRegistrationTimeout

public Integer getNodeReRegistrationTimeout()

Specified by:

getNodeReRegistrationTimeout in interface MapClientEntity

setNodeReRegistrationTimeout

public void setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)

Specified by:

setNodeReRegistrationTimeout in interface MapClientEntity

getNotBefore

public Long getNotBefore()

Specified by:

getNotBefore in interface MapClientEntity

setNotBefore

public void setNotBefore(Long notBefore)

Specified by:

setNotBefore in interface MapClientEntity

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface MapClientEntity

setProtocol

public void setProtocol(String protocol)

Specified by:

setProtocol in interface MapClientEntity

getRegistrationToken

public String getRegistrationToken()

Specified by:

getRegistrationToken in interface MapClientEntity

setRegistrationToken

public void setRegistrationToken(String registrationToken)

Specified by:

setRegistrationToken in interface MapClientEntity

getRootUrl

public String getRootUrl()

Specified by:

getRootUrl in interface MapClientEntity

setRootUrl

public void setRootUrl(String rootUrl)

Specified by:

setRootUrl in interface MapClientEntity

getScope

public Set<String> getScope()

Specified by:

getScope in interface MapClientEntity

setScope

public void setScope(Set<String> scope)

Specified by:

setScope in interface MapClientEntity

getSecret

public String getSecret()

Specified by:

getSecret in interface MapClientEntity

setSecret

public void setSecret(String secret)

Specified by:

setSecret in interface MapClientEntity

isAlwaysDisplayInConsole

public Boolean isAlwaysDisplayInConsole()

Specified by:

isAlwaysDisplayInConsole in interface MapClientEntity

setAlwaysDisplayInConsole

public void setAlwaysDisplayInConsole(Boolean alwaysDisplayInConsole)

Specified by:

setAlwaysDisplayInConsole in interface MapClientEntity

isBearerOnly

public Boolean isBearerOnly()

Specified by:

isBearerOnly in interface MapClientEntity

setBearerOnly

public void setBearerOnly(Boolean bearerOnly)

Specified by:

setBearerOnly in interface MapClientEntity

isConsentRequired

public Boolean isConsentRequired()

Specified by:

isConsentRequired in interface MapClientEntity

setConsentRequired

public void setConsentRequired(Boolean consentRequired)

Specified by:

setConsentRequired in interface MapClientEntity

isDirectAccessGrantsEnabled

public Boolean isDirectAccessGrantsEnabled()

Specified by:

isDirectAccessGrantsEnabled in interface MapClientEntity

setDirectAccessGrantsEnabled

public void setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)

Specified by:

setDirectAccessGrantsEnabled in interface MapClientEntity

isFrontchannelLogout

public Boolean isFrontchannelLogout()

Specified by:

isFrontchannelLogout in interface MapClientEntity

setFrontchannelLogout

public void setFrontchannelLogout(Boolean frontchannelLogout)

Specified by:

setFrontchannelLogout in interface MapClientEntity

isFullScopeAllowed

public Boolean isFullScopeAllowed()

Specified by:

isFullScopeAllowed in interface MapClientEntity

setFullScopeAllowed

public void setFullScopeAllowed(Boolean fullScopeAllowed)

Specified by:

setFullScopeAllowed in interface MapClientEntity

isImplicitFlowEnabled

public Boolean isImplicitFlowEnabled()

Specified by:

isImplicitFlowEnabled in interface MapClientEntity

setImplicitFlowEnabled

public void setImplicitFlowEnabled(Boolean implicitFlowEnabled)

Specified by:

setImplicitFlowEnabled in interface MapClientEntity

isPublicClient

public Boolean isPublicClient()

Specified by:

isPublicClient in interface MapClientEntity

setPublicClient

public void setPublicClient(Boolean publicClient)

Specified by:

setPublicClient in interface MapClientEntity

isServiceAccountsEnabled

public Boolean isServiceAccountsEnabled()

Specified by:

isServiceAccountsEnabled in interface MapClientEntity

setServiceAccountsEnabled

public void setServiceAccountsEnabled(Boolean serviceAccountsEnabled)

Specified by:

setServiceAccountsEnabled in interface MapClientEntity

isStandardFlowEnabled

public Boolean isStandardFlowEnabled()

Specified by:

isStandardFlowEnabled in interface MapClientEntity

setStandardFlowEnabled

public void setStandardFlowEnabled(Boolean standardFlowEnabled)

Specified by:

setStandardFlowEnabled in interface MapClientEntity

isSurrogateAuthRequired

public Boolean isSurrogateAuthRequired()

Specified by:

isSurrogateAuthRequired in interface MapClientEntity

setSurrogateAuthRequired

public void setSurrogateAuthRequired(Boolean surrogateAuthRequired)

Specified by:

setSurrogateAuthRequired in interface MapClientEntity

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface EntityWithAttributes

setAttribute

public void setAttribute(String name,
 List<String> values)

Specified by:

setAttribute in interface EntityWithAttributes

getAttribute

public List<String> getAttribute(String name)

Specified by:

getAttribute in interface EntityWithAttributes

getAttributes

public Map<String,List<String>> getAttributes()

Specified by:

getAttributes in interface EntityWithAttributes

setAttributes

public void setAttributes(Map<String,List<String>> attributes)

Specified by:

setAttributes in interface EntityWithAttributes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object