org.keycloak.models.map.client

Class MapClientAdapter

java.lang.Object

org.keycloak.models.map.client.AbstractClientModel<MapClientEntity>

org.keycloak.models.map.client.MapClientAdapter

All Implemented Interfaces:

ClientModel, ClientScopeModel, OrderedModel, ProtocolMapperContainerModel, RoleContainerModel, ScopeContainerModel

public abstract class MapClientAdapter
extends AbstractClientModel<MapClientEntity>
implements ClientModel

Author:

hmlnarik

Nested Class Summary

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 inherited from class org.keycloak.models.map.client.AbstractClientModel

entity, realm, session

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, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE

Constructor Summary

Constructors

Constructor and Description
MapClientAdapter(KeycloakSession session, RealmModel realm, MapClientEntity entity)

Method Summary

Modifier and Type	Method and Description
void	addClientScope(ClientScopeModel clientScope, boolean defaultScope) Client scopes
void	addDefaultRole(String name)
ProtocolMapperModel	addProtocolMapper(ProtocolMapperModel model)
void	addRedirectUri(String redirectUri)
void	addScopeMapping(RoleModel role)
void	addWebOrigin(String webOrigin)
void	deleteScopeMapping(RoleModel role)
String	getAttribute(String name)
Map<String,String>	getAttributes()
String	getAuthenticationFlowBindingOverride(String binding) 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, boolean filterByProtocol) Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
List<String>	getDefaultRoles() Default roles
String	getDescription()
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)
Set<ProtocolMapperModel>	getProtocolMappers() Protocol mappers
RealmModel	getRealm()
Set<String>	getRedirectUris()
String	getRegistrationToken()
String	getRootUrl()
Stream<RoleModel>	getScopeMappingsStream() Scopes mappings
String	getSecret()
Set<String>	getWebOrigins()
boolean	hasScope(RoleModel role)
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	removeAttribute(String name)
void	removeAuthenticationFlowBindingOverride(String binding)
void	removeClientScope(ClientScopeModel clientScope)
void	removeDefaultRoles(String... defaultRoles)
void	removeProtocolMapper(ProtocolMapperModel mapping)
void	removeRedirectUri(String redirectUri)
void	removeWebOrigin(String webOrigin)
void	setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)
void	setAttribute(String name, String value)
void	setAuthenticationFlowBindingOverride(String binding, String flowId)
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	updateProtocolMapper(ProtocolMapperModel mapping)
boolean	validateSecret(String secret)

Methods inherited from class org.keycloak.models.map.client.AbstractClientModel

addClientScopes, addRole, addRole, equals, getRealmScopeMappings, getRole, getRoles, getRoles, hashCode, removeRole, searchForRoles

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.ClientModel

addClientScopes, getConsentScreenText, getDynamicClientScope, getRegisteredNodes, isDisplayOnConsentScreen, registerNode, unregisterNode, updateClient

Methods inherited from interface org.keycloak.models.ClientScopeModel

getGuiOrder, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope

Methods inherited from interface org.keycloak.models.ScopeContainerModel

getRealmScopeMappings, getScopeMappings

Methods inherited from interface org.keycloak.models.RoleContainerModel

addRole, addRole, getRole, getRoles, getRoles, removeRole, searchForRoles, updateDefaultRoles

Constructor Detail

MapClientAdapter

public MapClientAdapter(KeycloakSession session,
                        RealmModel realm,
                        MapClientEntity entity)

Method Detail

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

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

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

isSurrogateAuthRequired

public boolean isSurrogateAuthRequired()

Specified by:

isSurrogateAuthRequired in interface ClientModel

setSurrogateAuthRequired

public void setSurrogateAuthRequired(boolean surrogateAuthRequired)

Specified by:

setSurrogateAuthRequired 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

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

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

getNodeReRegistrationTimeout

public int getNodeReRegistrationTimeout()

Specified by:

getNodeReRegistrationTimeout in interface ClientModel

setNodeReRegistrationTimeout

public void setNodeReRegistrationTimeout(int timeout)

Specified by:

setNodeReRegistrationTimeout 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

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

getAuthenticationFlowBindingOverride

public String getAuthenticationFlowBindingOverride(String binding)

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:

binding - examples are "browser", "direct_grant"

Returns:

getAuthenticationFlowBindingOverrides

public Map<String,String> getAuthenticationFlowBindingOverrides()

Specified by:

getAuthenticationFlowBindingOverrides in interface ClientModel

removeAuthenticationFlowBindingOverride

public void removeAuthenticationFlowBindingOverride(String binding)

Specified by:

removeAuthenticationFlowBindingOverride in interface ClientModel

setAuthenticationFlowBindingOverride

public void setAuthenticationFlowBindingOverride(String binding,
                                                 String flowId)

Specified by:

setAuthenticationFlowBindingOverride 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

isPublicClient

public boolean isPublicClient()

Specified by:

isPublicClient in interface ClientModel

setPublicClient

public void setPublicClient(boolean flag)

Specified by:

setPublicClient 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

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface ClientModel

Specified by:

getRealm in interface ClientScopeModel

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

addClientScope

public void addClientScope(ClientScopeModel clientScope,
                           boolean defaultScope)

Client scopes

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)

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

filterByProtocol - if true, then just client scopes of same protocol like current client will be returned

Returns:

map where key is the name of the clientScope, value is particular clientScope. Returns empty map if no scopes linked (never returns null).

getScopeMappingsStream

public Stream<RoleModel> getScopeMappingsStream()

Scopes mappings

Specified by:

getScopeMappingsStream 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

hasScope

public boolean hasScope(RoleModel role)

Specified by:

hasScope in interface ScopeContainerModel

getDefaultRoles

public List<String> getDefaultRoles()

Default roles

Specified by:

getDefaultRoles in interface RoleContainerModel

addDefaultRole

public void addDefaultRole(String name)

Specified by:

addDefaultRole in interface RoleContainerModel

removeDefaultRoles

public void removeDefaultRoles(String... defaultRoles)

Specified by:

removeDefaultRoles in interface RoleContainerModel

getProtocolMappers

public Set<ProtocolMapperModel> getProtocolMappers()

Protocol mappers

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