ClientAdapter (Keycloak Model Infinispan 4.2.0.Final API)

java.lang.Object
- org.keycloak.models.cache.infinispan.ClientAdapter

All Implemented Interfaces:

CachedObject, ClientModel, ClientScopeModel, ProtocolMapperContainerModel, RoleContainerModel, ScopeContainerModel
```
public class ClientAdapter
extends Object
implements ClientModel, CachedObject
```
Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary
- Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel
  RoleContainerModel.RoleRemovedEvent

Field Summary

Fields
Modifier and Type	Field and Description
`protected CachedClient`	`cached`
`protected RealmModel`	`cachedRealm`
`protected RealmCacheSession`	`cacheSession`
`protected boolean`	`invalidated`
`protected ClientModel`	`updated`

Fields inherited from interface org.keycloak.models.ClientModel
PRIVATE_KEY, PUBLIC_KEY, X509CERTIFICATE

Fields inherited from interface org.keycloak.models.ClientScopeModel
CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN

Constructor Summary

Constructors
Constructor and Description

ClientAdapter(RealmModel cachedRealm, CachedClient cached, RealmCacheSession cacheSession)

Constructors
Constructor and Description
`ClientAdapter(RealmModel cachedRealm, CachedClient cached, RealmCacheSession cacheSession)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientScope(ClientScopeModel clientScope, boolean defaultScope)`
`void`	`addDefaultRole(String name)`
`ProtocolMapperModel`	`addProtocolMapper(ProtocolMapperModel model)`
`void`	`addRedirectUri(String redirectUri)`
`RoleModel`	`addRole(String name)`
`RoleModel`	`addRole(String id, String name)`
`void`	`addScopeMapping(RoleModel role)`
`void`	`addWebOrigin(String webOrigin)`
`void`	`deleteScopeMapping(RoleModel role)`
`boolean`	`equals(Object o)`
`String`	`getAttribute(String name)`
`Map<String,String>`	`getAttributes()`
`String`	`getAuthenticationFlowBindingOverride(String name)`
`Map<String,String>`	`getAuthenticationFlowBindingOverrides()`
`String`	`getBaseUrl()`
`long`	`getCacheTimestamp()`
`String`	`getClientAuthenticatorType()`
`String`	`getClientId()`
`Map<String,ClientScopeModel>`	`getClientScopes(boolean defaultScope, boolean filterByProtocol)`
`List<String>`	`getDefaultRoles()`
`String`	`getDescription()`
`String`	`getId()`
`String`	`getManagementUrl()`
`String`	`getName()`
`int`	`getNodeReRegistrationTimeout()`
`int`	`getNotBefore()`
`String`	`getProtocol()`
`ProtocolMapperModel`	`getProtocolMapperById(String id)`
`ProtocolMapperModel`	`getProtocolMapperByName(String protocol, String name)`
`Set<ProtocolMapperModel>`	`getProtocolMappers()`
`RealmModel`	`getRealm()`
`Set<RoleModel>`	`getRealmScopeMappings()`
`Set<String>`	`getRedirectUris()`
`Map<String,Integer>`	`getRegisteredNodes()`
`String`	`getRegistrationToken()`
`RoleModel`	`getRole(String name)`
`Set<RoleModel>`	`getRoles()`
`String`	`getRootUrl()`
`Set<RoleModel>`	`getScopeMappings()`
`String`	`getSecret()`
`Set<String>`	`getWebOrigins()`
`int`	`hashCode()`
`boolean`	`hasScope(RoleModel role)`
`void`	`invalidate()`
`boolean`	`isBearerOnly()`
`boolean`	`isConsentRequired()`
`boolean`	`isDirectAccessGrantsEnabled()`
`boolean`	`isEnabled()`
`boolean`	`isFrontchannelLogout()`
`boolean`	`isFullScopeAllowed()`
`boolean`	`isImplicitFlowEnabled()`
`boolean`	`isPublicClient()`
`boolean`	`isServiceAccountsEnabled()`
`boolean`	`isStandardFlowEnabled()`
`boolean`	`isSurrogateAuthRequired()`
`protected boolean`	`isUpdated()`
`void`	`registerNode(String nodeHost, int registrationTime)`
`void`	`removeAttribute(String name)`
`void`	`removeAuthenticationFlowBindingOverride(String name)`
`void`	`removeClientScope(ClientScopeModel clientScope)`
`void`	`removeDefaultRoles(String... defaultRoles)`
`void`	`removeProtocolMapper(ProtocolMapperModel mapping)`
`void`	`removeRedirectUri(String redirectUri)`
`boolean`	`removeRole(RoleModel role)`
`void`	`removeWebOrigin(String webOrigin)`
`void`	`setAttribute(String name, String value)`
`void`	`setAuthenticationFlowBindingOverride(String name, String value)`
`void`	`setBaseUrl(String url)`
`void`	`setBearerOnly(boolean only)`
`void`	`setClientAuthenticatorType(String clientAuthenticatorType)`
`void`	`setClientId(String clientId)`
`void`	`setConsentRequired(boolean consentRequired)`
`void`	`setDescription(String description)`
`void`	`setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)`
`void`	`setEnabled(boolean enabled)`
`void`	`setFrontchannelLogout(boolean flag)`
`void`	`setFullScopeAllowed(boolean value)`
`void`	`setImplicitFlowEnabled(boolean implicitFlowEnabled)`
`void`	`setManagementUrl(String url)`
`void`	`setName(String name)`
`void`	`setNodeReRegistrationTimeout(int timeout)`
`void`	`setNotBefore(int notBefore)`
`void`	`setProtocol(String protocol)`
`void`	`setPublicClient(boolean flag)`
`void`	`setRedirectUris(Set<String> redirectUris)`
`void`	`setRegistrationToken(String registrationToken)`
`void`	`setRootUrl(String url)`
`void`	`setSecret(String secret)`
`void`	`setServiceAccountsEnabled(boolean serviceAccountsEnabled)`
`void`	`setStandardFlowEnabled(boolean standardFlowEnabled)`
`void`	`setSurrogateAuthRequired(boolean surrogateAuthRequired)`
`void`	`setWebOrigins(Set<String> webOrigins)`
`void`	`unregisterNode(String nodeHost)`
`void`	`updateClient()`
`void`	`updateDefaultRoles(String... defaultRoles)`
`void`	`updateProtocolMapper(ProtocolMapperModel mapping)`
`boolean`	`validateSecret(String secret)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientModel
getConsentScreenText, isDisplayOnConsentScreen

Methods inherited from interface org.keycloak.models.ClientScopeModel
setConsentScreenText, setDisplayOnConsentScreen

- Field Detail
  - cacheSession
```
protected RealmCacheSession cacheSession
```
  - cachedRealm
```
protected RealmModel cachedRealm
```
  - updated
```
protected ClientModel updated
```
  - cached
```
protected CachedClient cached
```
  - invalidated
```
protected boolean invalidated
```
- Constructor Detail
  - ClientAdapter
```
public ClientAdapter(RealmModel cachedRealm,
                     CachedClient cached,
                     RealmCacheSession cacheSession)
```
- Method Detail
  - invalidate
```
public void invalidate()
```
  - isUpdated
```
protected boolean isUpdated()
```
  - getCacheTimestamp
```
public long getCacheTimestamp()
```
    Specified by:
    
    getCacheTimestamp in interface CachedObject
  - updateClient
```
public void updateClient()
```
    Specified by:
    
    updateClient in interface ClientModel
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface ClientModel
    
    Specified by:
    
    getId in interface ClientScopeModel
    
    Specified by:
    
    getId in interface RoleContainerModel
  - getWebOrigins
```
public Set<String> getWebOrigins()
```
    Specified by:
    
    getWebOrigins in interface ClientModel
  - setWebOrigins
```
public void setWebOrigins(Set<String> webOrigins)
```
    Specified by:
    
    setWebOrigins in interface ClientModel
  - addClientScope
```
public void addClientScope(ClientScopeModel clientScope,
                           boolean defaultScope)
```
    Specified by:
    
    addClientScope in interface ClientModel
  - removeClientScope
```
public void removeClientScope(ClientScopeModel clientScope)
```
    Specified by:
    
    removeClientScope in interface ClientModel
  - getClientScopes
```
public Map<String,ClientScopeModel> getClientScopes(boolean defaultScope,
                                                    boolean filterByProtocol)
```
    Specified by:
    
    getClientScopes in interface ClientModel
  - addWebOrigin
```
public void addWebOrigin(String webOrigin)
```
    Specified by:
    
    addWebOrigin in interface ClientModel
  - removeWebOrigin
```
public void removeWebOrigin(String webOrigin)
```
    Specified by:
    
    removeWebOrigin in interface ClientModel
  - getRedirectUris
```
public Set<String> getRedirectUris()
```
    Specified by:
    
    getRedirectUris in interface ClientModel
  - setRedirectUris
```
public void setRedirectUris(Set<String> redirectUris)
```
    Specified by:
    
    setRedirectUris in interface ClientModel
  - addRedirectUri
```
public void addRedirectUri(String redirectUri)
```
    Specified by:
    
    addRedirectUri in interface ClientModel
  - removeRedirectUri
```
public void removeRedirectUri(String redirectUri)
```
    Specified by:
    
    removeRedirectUri in interface ClientModel
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface ClientModel
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Specified by:
    
    setEnabled in interface ClientModel
  - getClientAuthenticatorType
```
public String getClientAuthenticatorType()
```
    Specified by:
    
    getClientAuthenticatorType in interface ClientModel
  - setClientAuthenticatorType
```
public void setClientAuthenticatorType(String clientAuthenticatorType)
```
    Specified by:
    
    setClientAuthenticatorType in interface ClientModel
  - validateSecret
```
public boolean validateSecret(String secret)
```
    Specified by:
    
    validateSecret in interface ClientModel
  - getSecret
```
public String getSecret()
```
    Specified by:
    
    getSecret in interface ClientModel
  - setSecret
```
public void setSecret(String secret)
```
    Specified by:
    
    setSecret in interface ClientModel
  - getRegistrationToken
```
public String getRegistrationToken()
```
    Specified by:
    
    getRegistrationToken in interface ClientModel
  - setRegistrationToken
```
public void setRegistrationToken(String registrationToken)
```
    Specified by:
    
    setRegistrationToken in interface ClientModel
  - isPublicClient
```
public boolean isPublicClient()
```
    Specified by:
    
    isPublicClient in interface ClientModel
  - setPublicClient
```
public void setPublicClient(boolean flag)
```
    Specified by:
    
    setPublicClient in interface ClientModel
  - isFrontchannelLogout
```
public boolean isFrontchannelLogout()
```
    Specified by:
    
    isFrontchannelLogout in interface ClientModel
  - setFrontchannelLogout
```
public void setFrontchannelLogout(boolean flag)
```
    Specified by:
    
    setFrontchannelLogout in interface ClientModel
  - isFullScopeAllowed
```
public boolean isFullScopeAllowed()
```
    Specified by:
    
    isFullScopeAllowed in interface ClientModel
  - setFullScopeAllowed
```
public void setFullScopeAllowed(boolean value)
```
    Specified by:
    
    setFullScopeAllowed in interface ClientModel
  - getScopeMappings
```
public Set<RoleModel> getScopeMappings()
```
    Specified by:
    
    getScopeMappings in interface ScopeContainerModel
  - addScopeMapping
```
public void addScopeMapping(RoleModel role)
```
    Specified by:
    
    addScopeMapping in interface ScopeContainerModel
  - deleteScopeMapping
```
public void deleteScopeMapping(RoleModel role)
```
    Specified by:
    
    deleteScopeMapping in interface ScopeContainerModel
  - getRealmScopeMappings
```
public Set<RoleModel> getRealmScopeMappings()
```
    Specified by:
    
    getRealmScopeMappings in interface ScopeContainerModel
  - getRealm
```
public RealmModel getRealm()
```
    Specified by:
    
    getRealm in interface ClientModel
    
    Specified by:
    
    getRealm in interface ClientScopeModel
  - getNotBefore
```
public int getNotBefore()
```
    Specified by:
    
    getNotBefore in interface ClientModel
  - setNotBefore
```
public void setNotBefore(int notBefore)
```
    Specified by:
    
    setNotBefore in interface ClientModel
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface ClientModel
    
    Specified by:
    
    getProtocol in interface ClientScopeModel
  - setProtocol
```
public void setProtocol(String protocol)
```
    Specified by:
    
    setProtocol in interface ClientModel
    
    Specified by:
    
    setProtocol in interface ClientScopeModel
  - setAttribute
```
public void setAttribute(String name,
                         String value)
```
    Specified by:
    
    setAttribute in interface ClientModel
    
    Specified by:
    
    setAttribute in interface ClientScopeModel
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface ClientModel
    
    Specified by:
    
    removeAttribute in interface ClientScopeModel
  - getAttribute
```
public String getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface ClientModel
    
    Specified by:
    
    getAttribute in interface ClientScopeModel
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface ClientModel
    
    Specified by:
    
    getAttributes in interface ClientScopeModel
  - setAuthenticationFlowBindingOverride
```
public void setAuthenticationFlowBindingOverride(String name,
                                                 String value)
```
    Specified by:
    
    setAuthenticationFlowBindingOverride in interface ClientModel
  - removeAuthenticationFlowBindingOverride
```
public void removeAuthenticationFlowBindingOverride(String name)
```
    Specified by:
    
    removeAuthenticationFlowBindingOverride in interface ClientModel
  - getAuthenticationFlowBindingOverride
```
public String getAuthenticationFlowBindingOverride(String name)
```
    Specified by:
    
    getAuthenticationFlowBindingOverride in interface ClientModel
  - getAuthenticationFlowBindingOverrides
```
public Map<String,String> getAuthenticationFlowBindingOverrides()
```
    Specified by:
    
    getAuthenticationFlowBindingOverrides in interface ClientModel
  - getProtocolMappers
```
public Set<ProtocolMapperModel> getProtocolMappers()
```
    Specified by:
    
    getProtocolMappers in interface ProtocolMapperContainerModel
  - addProtocolMapper
```
public ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)
```
    Specified by:
    
    addProtocolMapper in interface ProtocolMapperContainerModel
  - removeProtocolMapper
```
public void removeProtocolMapper(ProtocolMapperModel mapping)
```
    Specified by:
    
    removeProtocolMapper in interface ProtocolMapperContainerModel
  - updateProtocolMapper
```
public void updateProtocolMapper(ProtocolMapperModel mapping)
```
    Specified by:
    
    updateProtocolMapper in interface ProtocolMapperContainerModel
  - getProtocolMapperById
```
public ProtocolMapperModel getProtocolMapperById(String id)
```
    Specified by:
    
    getProtocolMapperById in interface ProtocolMapperContainerModel
  - getProtocolMapperByName
```
public ProtocolMapperModel getProtocolMapperByName(String protocol,
                                                   String name)
```
    Specified by:
    
    getProtocolMapperByName in interface ProtocolMapperContainerModel
  - getClientId
```
public String getClientId()
```
    Specified by:
    
    getClientId in interface ClientModel
  - setClientId
```
public void setClientId(String clientId)
```
    Specified by:
    
    setClientId in interface ClientModel
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ClientModel
    
    Specified by:
    
    getName in interface ClientScopeModel
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface ClientModel
    
    Specified by:
    
    setName in interface ClientScopeModel
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface ClientModel
    
    Specified by:
    
    getDescription in interface ClientScopeModel
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface ClientModel
    
    Specified by:
    
    setDescription in interface ClientScopeModel
  - isSurrogateAuthRequired
```
public boolean isSurrogateAuthRequired()
```
    Specified by:
    
    isSurrogateAuthRequired in interface ClientModel
  - setSurrogateAuthRequired
```
public void setSurrogateAuthRequired(boolean surrogateAuthRequired)
```
    Specified by:
    
    setSurrogateAuthRequired in interface ClientModel
  - getManagementUrl
```
public String getManagementUrl()
```
    Specified by:
    
    getManagementUrl in interface ClientModel
  - setManagementUrl
```
public void setManagementUrl(String url)
```
    Specified by:
    
    setManagementUrl in interface ClientModel
  - getRootUrl
```
public String getRootUrl()
```
    Specified by:
    
    getRootUrl in interface ClientModel
  - setRootUrl
```
public void setRootUrl(String url)
```
    Specified by:
    
    setRootUrl in interface ClientModel
  - getBaseUrl
```
public String getBaseUrl()
```
    Specified by:
    
    getBaseUrl in interface ClientModel
  - setBaseUrl
```
public void setBaseUrl(String url)
```
    Specified by:
    
    setBaseUrl in interface ClientModel
  - getDefaultRoles
```
public List<String> getDefaultRoles()
```
    Specified by:
    
    getDefaultRoles in interface RoleContainerModel
  - addDefaultRole
```
public void addDefaultRole(String name)
```
    Specified by:
    
    addDefaultRole in interface RoleContainerModel
  - updateDefaultRoles
```
public void updateDefaultRoles(String... defaultRoles)
```
    Specified by:
    
    updateDefaultRoles in interface RoleContainerModel
  - removeDefaultRoles
```
public void removeDefaultRoles(String... defaultRoles)
```
    Specified by:
    
    removeDefaultRoles in interface RoleContainerModel
  - isBearerOnly
```
public boolean isBearerOnly()
```
    Specified by:
    
    isBearerOnly in interface ClientModel
  - setBearerOnly
```
public void setBearerOnly(boolean only)
```
    Specified by:
    
    setBearerOnly in interface ClientModel
  - isConsentRequired
```
public boolean isConsentRequired()
```
    Specified by:
    
    isConsentRequired in interface ClientModel
  - setConsentRequired
```
public void setConsentRequired(boolean consentRequired)
```
    Specified by:
    
    setConsentRequired in interface ClientModel
  - isStandardFlowEnabled
```
public boolean isStandardFlowEnabled()
```
    Specified by:
    
    isStandardFlowEnabled in interface ClientModel
  - setStandardFlowEnabled
```
public void setStandardFlowEnabled(boolean standardFlowEnabled)
```
    Specified by:
    
    setStandardFlowEnabled in interface ClientModel
  - isImplicitFlowEnabled
```
public boolean isImplicitFlowEnabled()
```
    Specified by:
    
    isImplicitFlowEnabled in interface ClientModel
  - setImplicitFlowEnabled
```
public void setImplicitFlowEnabled(boolean implicitFlowEnabled)
```
    Specified by:
    
    setImplicitFlowEnabled in interface ClientModel
  - isDirectAccessGrantsEnabled
```
public boolean isDirectAccessGrantsEnabled()
```
    Specified by:
    
    isDirectAccessGrantsEnabled in interface ClientModel
  - setDirectAccessGrantsEnabled
```
public void setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)
```
    Specified by:
    
    setDirectAccessGrantsEnabled in interface ClientModel
  - isServiceAccountsEnabled
```
public boolean isServiceAccountsEnabled()
```
    Specified by:
    
    isServiceAccountsEnabled in interface ClientModel
  - setServiceAccountsEnabled
```
public void setServiceAccountsEnabled(boolean serviceAccountsEnabled)
```
    Specified by:
    
    setServiceAccountsEnabled in interface ClientModel
  - getRole
```
public RoleModel getRole(String name)
```
    Specified by:
    
    getRole in interface RoleContainerModel
  - addRole
```
public RoleModel addRole(String name)
```
    Specified by:
    
    addRole in interface RoleContainerModel
  - addRole
```
public RoleModel addRole(String id,
                         String name)
```
    Specified by:
    
    addRole in interface RoleContainerModel
  - removeRole
```
public boolean removeRole(RoleModel role)
```
    Specified by:
    
    removeRole in interface RoleContainerModel
  - getRoles
```
public Set<RoleModel> getRoles()
```
    Specified by:
    
    getRoles in interface RoleContainerModel
  - getNodeReRegistrationTimeout
```
public int getNodeReRegistrationTimeout()
```
    Specified by:
    
    getNodeReRegistrationTimeout in interface ClientModel
  - setNodeReRegistrationTimeout
```
public void setNodeReRegistrationTimeout(int timeout)
```
    Specified by:
    
    setNodeReRegistrationTimeout in interface ClientModel
  - getRegisteredNodes
```
public Map<String,Integer> getRegisteredNodes()
```
    Specified by:
    
    getRegisteredNodes in interface ClientModel
  - registerNode
```
public void registerNode(String nodeHost,
                         int registrationTime)
```
    Specified by:
    
    registerNode in interface ClientModel
  - unregisterNode
```
public void unregisterNode(String nodeHost)
```
    Specified by:
    
    unregisterNode in interface ClientModel
  - hasScope
```
public boolean hasScope(RoleModel role)
```
    Specified by:
    
    hasScope in interface ScopeContainerModel
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ClientAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel

Field Summary

Fields inherited from interface org.keycloak.models.ClientModel

Fields inherited from interface org.keycloak.models.ClientScopeModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.keycloak.models.ClientModel

Methods inherited from interface org.keycloak.models.ClientScopeModel

Field Detail

cacheSession

cachedRealm

updated

cached

invalidated

Constructor Detail

ClientAdapter

Method Detail

invalidate

isUpdated

getCacheTimestamp

updateClient

getId

getWebOrigins

setWebOrigins

addClientScope

removeClientScope

getClientScopes

addWebOrigin

removeWebOrigin

getRedirectUris

setRedirectUris

addRedirectUri

removeRedirectUri

isEnabled

setEnabled

getClientAuthenticatorType

setClientAuthenticatorType

validateSecret

getSecret

setSecret

getRegistrationToken

setRegistrationToken

isPublicClient

setPublicClient

isFrontchannelLogout

setFrontchannelLogout

isFullScopeAllowed

setFullScopeAllowed

getScopeMappings

addScopeMapping

deleteScopeMapping

getRealmScopeMappings

getRealm

getNotBefore

setNotBefore

getProtocol

setProtocol

setAttribute

removeAttribute

getAttribute

getAttributes

setAuthenticationFlowBindingOverride

removeAuthenticationFlowBindingOverride

getAuthenticationFlowBindingOverride

getAuthenticationFlowBindingOverrides

getProtocolMappers

addProtocolMapper

removeProtocolMapper

updateProtocolMapper

getProtocolMapperById

getProtocolMapperByName

getClientId

setClientId

getName

setName

getDescription

setDescription