java.lang.Object
- org.keycloak.models.jpa.ClientAdapter

All Implemented Interfaces:

ClientModel, ClientScopeModel, JpaModel<ClientEntity>, OrderedModel, ProtocolMapperContainerModel, RoleContainerModel, ScopeContainerModel
```
public class ClientAdapter
extends Object
implements ClientModel, JpaModel<ClientEntity>
```
Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary
- Nested classes/interfaces inherited from interface org.keycloak.models.ClientModel
  ClientModel.ClientCreationEvent, ClientModel.ClientIdChangeEvent, ClientModel.ClientProtocolUpdatedEvent, ClientModel.ClientRemovedEvent, ClientModel.ClientUpdatedEvent, ClientModel.SearchableFields
- Nested classes/interfaces inherited from interface org.keycloak.models.ClientScopeModel
  ClientScopeModel.ClientScopeRemovedEvent
- Nested classes/interfaces inherited from interface org.keycloak.models.OrderedModel
  OrderedModel.OrderedModelComparator<OM extends OrderedModel>
- Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel
  RoleContainerModel.RoleRemovedEvent

Field Summary

Fields
Modifier and Type	Field	Description
`protected javax.persistence.EntityManager`	`em`
`protected ClientEntity`	`entity`
`protected RealmModel`	`realm`
`protected KeycloakSession`	`session`

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

Fields inherited from interface org.keycloak.models.ClientScopeModel
CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, DYNAMIC_SCOPE_REGEXP, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE, IS_DYNAMIC_SCOPE

Constructor Summary

Constructors
Constructor	Description
`ClientAdapter(RealmModel realm, javax.persistence.EntityManager em, KeycloakSession session, ClientEntity entity)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addClientScope(ClientScopeModel clientScope, boolean defaultScope)`	Add clientScope with this client.
`void`	`addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)`	Add clientScopes with this client.
`void`	`addDefaultRole(String name)`	Deprecated.
`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)`
`static boolean`	`contains(String str, String[] array)`
`void`	`deleteScopeMapping(RoleModel role)`
`protected ProtocolMapperModel`	`entityToModel(ProtocolMapperEntity entity)`
`boolean`	`equals(Object o)`
`String`	`getAttribute(String name)`
`Map<String,String>`	`getAttributes()`
`String`	`getAuthenticationFlowBindingOverride(String name)`	Get authentication flow binding override for this client.
`Map<String,String>`	`getAuthenticationFlowBindingOverrides()`
`String`	`getBaseUrl()`
`String`	`getClientAuthenticatorType()`
`String`	`getClientId()`	Returns client ID as defined by the user.
`Map<String,ClientScopeModel>`	`getClientScopes(boolean defaultScope)`	Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
`Stream<String>`	`getDefaultRolesStream()`	Deprecated.
`String`	`getDescription()`
`ClientEntity`	`getEntity()`
`String`	`getId()`	Returns client internal ID (UUID).
`String`	`getManagementUrl()`
`String`	`getName()`
`int`	`getNodeReRegistrationTimeout()`
`int`	`getNotBefore()`	Time in seconds since epoc
`String`	`getProtocol()`
`ProtocolMapperModel`	`getProtocolMapperById(String id)`
`ProtocolMapperModel`	`getProtocolMapperByName(String protocol, String name)`
`protected ProtocolMapperEntity`	`getProtocolMapperEntity(String id)`
`protected ProtocolMapperEntity`	`getProtocolMapperEntityByName(String protocol, String name)`
`Stream<ProtocolMapperModel>`	`getProtocolMappersStream()`	Returns protocol mappers as a stream.
`RealmModel`	`getRealm()`
`Stream<RoleModel>`	`getRealmScopeMappingsStream()`	From the scope mappings returned by `ScopeContainerModel.getScopeMappingsStream()` returns only those that belong to the realm that owns this scope container.
`Set<String>`	`getRedirectUris()`
`Map<String,Integer>`	`getRegisteredNodes()`
`String`	`getRegistrationToken()`
`RoleModel`	`getRole(String name)`
`Stream<RoleModel>`	`getRolesStream()`	Returns available roles as a stream.
`Stream<RoleModel>`	`getRolesStream(Integer first, Integer max)`	Returns available roles as a stream.
`String`	`getRootUrl()`
`Stream<RoleModel>`	`getScopeMappingsStream()`	Returns scope mappings for this scope container as a stream.
`String`	`getSecret()`
`Set<String>`	`getWebOrigins()`
`int`	`hashCode()`
`boolean`	`hasScope(RoleModel role)`	Returns `true`, if this object has the given role directly or indirectly in its scope, `false` otherwise.
`boolean`	`isAlwaysDisplayInConsole()`
`boolean`	`isBearerOnly()`
`boolean`	`isConsentRequired()`
`boolean`	`isDirectAccessGrantsEnabled()`
`boolean`	`isEnabled()`
`boolean`	`isFrontchannelLogout()`
`boolean`	`isFullScopeAllowed()`
`boolean`	`isImplicitFlowEnabled()`
`boolean`	`isPublicClient()`
`boolean`	`isServiceAccountsEnabled()`
`boolean`	`isStandardFlowEnabled()`
`boolean`	`isSurrogateAuthRequired()`
`void`	`registerNode(String nodeHost, int registrationTime)`	Register node or just update the 'lastReRegistration' time if this node is already registered
`void`	`removeAttribute(String name)`
`void`	`removeAuthenticationFlowBindingOverride(String name)`
`void`	`removeClientScope(ClientScopeModel clientScope)`
`void`	`removeDefaultRoles(String... defaultRoles)`	Deprecated.
`void`	`removeProtocolMapper(ProtocolMapperModel mapping)`
`void`	`removeRedirectUri(String redirectUri)`
`boolean`	`removeRole(RoleModel roleModel)`
`void`	`removeWebOrigin(String webOrigin)`
`Stream<RoleModel>`	`searchForRolesStream(String search, Integer first, Integer max)`	Searches roles by the given name.
`void`	`setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)`
`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)`
`String`	`toString()`
`void`	`unregisterNode(String nodeHost)`
`void`	`updateClient()`	Notifies other providers that this client has been updated.
`void`	`updateProtocolMapper(ProtocolMapperModel mapping)`
`boolean`	`validateSecret(String secret)`

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

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

Methods inherited from interface org.keycloak.models.ClientScopeModel
getDynamicScopeRegexp, getGuiOrder, isDynamicScope, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope, setIsDynamicScope

Methods inherited from interface org.keycloak.models.RoleContainerModel
getDefaultRoles, updateDefaultRoles

- Field Detail
  - session
```
protected KeycloakSession session
```
  - realm
```
protected RealmModel realm
```
  - em
```
protected javax.persistence.EntityManager em
```
  - entity
```
protected ClientEntity entity
```
- Constructor Detail
  - ClientAdapter
```
public ClientAdapter(RealmModel realm,
                     javax.persistence.EntityManager em,
                     KeycloakSession session,
                     ClientEntity entity)
```
- Method Detail
  - getEntity
```
public ClientEntity getEntity()
```
    Specified by:
    
    getEntity in interface JpaModel<ClientEntity>
  - getId
```
public String getId()
```
    Description copied from interface: ClientModel
    
    Returns client internal ID (UUID).
    
    Specified by:
    
    getId in interface ClientModel
    
    Specified by:
    
    getId in interface ClientScopeModel
    
    Specified by:
    
    getId in interface RoleContainerModel
  - getRealm
```
public RealmModel getRealm()
```
    Specified by:
    
    getRealm in interface ClientModel
    
    Specified by:
    
    getRealm in interface ClientScopeModel
  - 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
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface ClientModel
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Specified by:
    
    setEnabled in interface ClientModel
  - isAlwaysDisplayInConsole
```
public boolean isAlwaysDisplayInConsole()
```
    Specified by:
    
    isAlwaysDisplayInConsole in interface ClientModel
  - setAlwaysDisplayInConsole
```
public void setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)
```
    Specified by:
    
    setAlwaysDisplayInConsole 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
  - getWebOrigins
```
public Set<String> getWebOrigins()
```
    Specified by:
    
    getWebOrigins in interface ClientModel
  - setWebOrigins
```
public void setWebOrigins(Set<String> webOrigins)
```
    Specified by:
    
    setWebOrigins 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
  - getClientAuthenticatorType
```
public String getClientAuthenticatorType()
```
    Specified by:
    
    getClientAuthenticatorType in interface ClientModel
  - setClientAuthenticatorType
```
public void setClientAuthenticatorType(String clientAuthenticatorType)
```
    Specified by:
    
    setClientAuthenticatorType 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
  - validateSecret
```
public boolean validateSecret(String secret)
```
    Specified by:
    
    validateSecret in interface ClientModel
  - getNotBefore
```
public int getNotBefore()
```
    Description copied from interface: ClientModel
    
    Time in seconds since epoc
    
    Specified by:
    
    getNotBefore in interface ClientModel
    
    Returns:
  - setNotBefore
```
public void setNotBefore(int notBefore)
```
    Specified by:
    
    setNotBefore in interface ClientModel
  - getRealmScopeMappingsStream
```
public Stream<RoleModel> getRealmScopeMappingsStream()
```
    Description copied from interface: ScopeContainerModel
    
    From the scope mappings returned by ScopeContainerModel.getScopeMappingsStream() returns only those that belong to the realm that owns this scope container.
    
    Specified by:
    
    getRealmScopeMappingsStream in interface ScopeContainerModel
    
    Returns:
    
    stream of RoleModel. Never returns null.
  - getScopeMappingsStream
```
public Stream<RoleModel> getScopeMappingsStream()
```
    Description copied from interface: ScopeContainerModel
    
    Returns scope mappings for this scope container as a stream.
    
    Specified by:
    
    getScopeMappingsStream in interface ScopeContainerModel
    
    Returns:
    
    Stream of RoleModel. Never returns null.
  - addScopeMapping
```
public void addScopeMapping(RoleModel role)
```
    Specified by:
    
    addScopeMapping in interface ScopeContainerModel
  - deleteScopeMapping
```
public void deleteScopeMapping(RoleModel role)
```
    Specified by:
    
    deleteScopeMapping in interface ScopeContainerModel
  - 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
  - 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)
```
    Description copied from interface: ClientModel
    
    Get authentication flow binding override for this client. Allows client to override an authentication flow binding.
    
    Specified by:
    
    getAuthenticationFlowBindingOverride in interface ClientModel
    
    Parameters:
    
    name - examples are "browser", "direct_grant"
    
    Returns:
  - getAuthenticationFlowBindingOverrides
```
public Map<String,String> getAuthenticationFlowBindingOverrides()
```
    Specified by:
    
    getAuthenticationFlowBindingOverrides in interface ClientModel
  - 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
  - addClientScope
```
public void addClientScope(ClientScopeModel clientScope,
                           boolean defaultScope)
```
    Description copied from interface: ClientModel
    
    Add clientScope with this client. Add it as default scope (if parameter 'defaultScope' is true) or optional scope (if parameter 'defaultScope' is false)
    
    Specified by:
    
    addClientScope in interface ClientModel
  - addClientScopes
```
public void addClientScopes(Set<ClientScopeModel> clientScopes,
                            boolean defaultScope)
```
    Description copied from interface: ClientModel
    
    Add clientScopes with this client. Add as default scopes (if parameter 'defaultScope' is true) or optional scopes (if parameter 'defaultScope' is false)
    
    Specified by:
    
    addClientScopes in interface ClientModel
  - removeClientScope
```
public void removeClientScope(ClientScopeModel clientScope)
```
    Specified by:
    
    removeClientScope in interface ClientModel
  - getClientScopes
```
public Map<String,ClientScopeModel> getClientScopes(boolean defaultScope)
```
    Description copied from interface: ClientModel
    
    Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
    
    Specified by:
    
    getClientScopes in interface ClientModel
    
    Returns:
    
    map where key is the name of the clientScope, value is particular clientScope. Returns empty map if no scopes linked (never returns null).
  - contains
```
public static boolean contains(String str,
                               String[] array)
```
  - getProtocolMappersStream
```
public Stream<ProtocolMapperModel> getProtocolMappersStream()
```
    Description copied from interface: ProtocolMapperContainerModel
    
    Returns protocol mappers as a stream.
    
    Specified by:
    
    getProtocolMappersStream in interface ProtocolMapperContainerModel
    
    Returns:
    
    Stream of protocol mapper. Never returns null.
  - addProtocolMapper
```
public ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)
```
    Specified by:
    
    addProtocolMapper in interface ProtocolMapperContainerModel
  - getProtocolMapperEntity
```
protected ProtocolMapperEntity getProtocolMapperEntity(String id)
```
  - getProtocolMapperEntityByName
```
protected ProtocolMapperEntity getProtocolMapperEntityByName(String protocol,
                                                             String name)
```
  - 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
  - entityToModel
```
protected ProtocolMapperModel entityToModel(ProtocolMapperEntity entity)
```
  - updateClient
```
public void updateClient()
```
    Description copied from interface: ClientModel
    
    Notifies other providers that this client has been updated.
    After a client is updated, providers can register for ClientModel.ClientUpdatedEvent. The setters in this model do not send an update for individual updates of the model. This method is here to allow for sending this event for this client, allowsing for to group multiple changes of a client and signal that all the changes in this client have been performed.
    
    Specified by:
    
    updateClient in interface ClientModel
    
    See Also:
    
    ProviderEvent, ProviderEventManager, ClientModel.ClientUpdatedEvent
  - getClientId
```
public String getClientId()
```
    Description copied from interface: ClientModel
    
    Returns client ID as defined by the user.
    
    Specified by:
    
    getClientId in interface ClientModel
    
    Returns:
  - setClientId
```
public void setClientId(String clientId)
```
    Specified by:
    
    setClientId in interface ClientModel
  - 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
  - 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 roleModel)
```
    Specified by:
    
    removeRole in interface RoleContainerModel
  - getRolesStream
```
public Stream<RoleModel> getRolesStream()
```
    Description copied from interface: RoleContainerModel
    
    Returns available roles as a stream.
    
    Specified by:
    
    getRolesStream in interface RoleContainerModel
    
    Returns:
    
    Stream of RoleModel. Never returns null.
  - getRolesStream
```
public Stream<RoleModel> getRolesStream(Integer first,
                                        Integer max)
```
    Description copied from interface: RoleContainerModel
    
    Returns available roles as a stream.
    
    Specified by:
    
    getRolesStream in interface RoleContainerModel
    
    Parameters:
    
    first - Integer Index of the first desired role. Ignored if negative or null.
    
    max - Integer Maximum number of returned roles. Ignored if negative or null.
    
    Returns:
    
    Stream of RoleModel. Never returns null.
  - searchForRolesStream
```
public Stream<RoleModel> searchForRolesStream(String search,
                                              Integer first,
                                              Integer max)
```
    Description copied from interface: RoleContainerModel
    
    Searches roles by the given name. Returns all roles that match the given filter.
    
    Specified by:
    
    searchForRolesStream in interface RoleContainerModel
    
    Parameters:
    
    search - String Name of the role to be used as a filter.
    
    first - Integer Index of the first desired role. Ignored if negative or null.
    
    max - Integer Maximum number of returned roles. Ignored if negative or null.
    
    Returns:
    
    Stream of RoleModel. Never returns null.
  - hasScope
```
public boolean hasScope(RoleModel role)
```
    Description copied from interface: ScopeContainerModel
    
    Returns true, if this object has the given role directly or indirectly in its scope, false otherwise.
    
    Specified by:
    
    hasScope in interface ScopeContainerModel
    
    Parameters:
    
    role - the role
    
    Returns:
    
    see description
    
    See Also:
    
    if you want to check if this object has the given role directly in its scope
  - getDefaultRolesStream
```
@Deprecated
public Stream<String> getDefaultRolesStream()
```
    Deprecated.
    
    Specified by:
    
    getDefaultRolesStream in interface RoleContainerModel
    
    Returns:
    
    Stream of default roles names or empty stream if there are none. Never returns null.
  - addDefaultRole
```
@Deprecated
public void addDefaultRole(String name)
```
    Deprecated.
    
    Specified by:
    
    addDefaultRole in interface RoleContainerModel
  - removeDefaultRoles
```
@Deprecated
public void removeDefaultRoles(String... defaultRoles)
```
    Deprecated.
    
    Specified by:
    
    removeDefaultRoles 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)
```
    Description copied from interface: ClientModel
    
    Register node or just update the 'lastReRegistration' time if this node is already registered
    
    Specified by:
    
    registerNode in interface ClientModel
  - unregisterNode
```
public void unregisterNode(String nodeHost)
```
    Specified by:
    
    unregisterNode in interface ClientModel
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClientAdapter

Nested Class Summary

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

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

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

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

Methods inherited from interface org.keycloak.models.RoleContainerModel

Field Detail

session

realm

em

entity

Constructor Detail

ClientAdapter

Method Detail

getEntity

getId

getRealm

getName

setName

getDescription

setDescription

isEnabled

setEnabled

isAlwaysDisplayInConsole

setAlwaysDisplayInConsole

isPublicClient

setPublicClient

isFrontchannelLogout

setFrontchannelLogout

isFullScopeAllowed

setFullScopeAllowed

getWebOrigins

setWebOrigins

addWebOrigin

removeWebOrigin

getRedirectUris

setRedirectUris

addRedirectUri

removeRedirectUri

getClientAuthenticatorType

setClientAuthenticatorType

getSecret

setSecret

getRegistrationToken

setRegistrationToken

validateSecret

getNotBefore

setNotBefore

getRealmScopeMappingsStream

getScopeMappingsStream

addScopeMapping

deleteScopeMapping

getProtocol

setProtocol

setAuthenticationFlowBindingOverride

removeAuthenticationFlowBindingOverride

getAuthenticationFlowBindingOverride

getAuthenticationFlowBindingOverrides

setAttribute

removeAttribute

getAttribute

getAttributes

addClientScope

addClientScopes

removeClientScope

getClientScopes

contains

getProtocolMappersStream

addProtocolMapper

getProtocolMapperEntity

getProtocolMapperEntityByName