org.keycloak.models

Interface ClientModel

All Superinterfaces:

ClientScopeModel, OrderedModel, ProtocolMapperContainerModel, RoleContainerModel, ScopeContainerModel

public interface ClientModel
extends ClientScopeModel, RoleContainerModel, ProtocolMapperContainerModel, ScopeContainerModel

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientModel.ClientCreationEvent
static interface	ClientModel.ClientProtocolUpdatedEvent
static interface	ClientModel.ClientRemovedEvent
static interface	ClientModel.ClientUpdatedEvent
static class	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 and Description
static String	LOGO_URI
static String	POLICY_URI
static String	PRIVATE_KEY
static String	PUBLIC_KEY
static String	TOS_URI
static String	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

Method Summary

Modifier and Type	Method and 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	addRedirectUri(String redirectUri)
void	addWebOrigin(String webOrigin)
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) Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
default String	getConsentScreenText()
String	getDescription()
default ClientScopeModel	getDynamicClientScope(String scope) Returns a ClientScopeModel associated with this client.
String	getId() Returns client internal ID (UUID).
String	getManagementUrl()
String	getName()
int	getNodeReRegistrationTimeout()
int	getNotBefore() Time in seconds since epoc
String	getProtocol()
RealmModel	getRealm()
Set<String>	getRedirectUris()
Map<String,Integer>	getRegisteredNodes()
String	getRegistrationToken()
String	getRootUrl()
String	getSecret()
Set<String>	getWebOrigins()
default boolean	hasDirectScope(RoleModel role) Returns true, if this object has the given role directly in its scope.
boolean	isAlwaysDisplayInConsole()
boolean	isBearerOnly()
boolean	isConsentRequired()
boolean	isDirectAccessGrantsEnabled()
default boolean	isDisplayOnConsentScreen()
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 binding)
void	removeClientScope(ClientScopeModel clientScope)
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	unregisterNode(String nodeHost)
void	updateClient() Deprecated. Do not use, to be removed
boolean	validateSecret(String secret)

Methods inherited from interface org.keycloak.models.ClientScopeModel

getDynamicScopeRegexp, getGuiOrder, isDynamicScope, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope, setIsDynamicScope

Methods inherited from interface org.keycloak.models.ProtocolMapperContainerModel

addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMappers, getProtocolMappersStream, removeProtocolMapper, updateProtocolMapper

Methods inherited from interface org.keycloak.models.ScopeContainerModel

addScopeMapping, deleteScopeMapping, getRealmScopeMappings, getRealmScopeMappingsStream, getScopeMappings, getScopeMappingsStream, hasScope

Methods inherited from interface org.keycloak.models.RoleContainerModel

addDefaultRole, addRole, addRole, getDefaultRoles, getDefaultRolesStream, getRole, getRoles, getRoles, getRolesStream, getRolesStream, removeDefaultRoles, removeRole, searchForRoles, searchForRolesStream, updateDefaultRoles

Field Detail

PRIVATE_KEY

static final String PRIVATE_KEY

See Also:

Constant Field Values

PUBLIC_KEY

static final String PUBLIC_KEY

See Also:

Constant Field Values

X509CERTIFICATE

static final String X509CERTIFICATE

See Also:

Constant Field Values

LOGO_URI

static final String LOGO_URI

See Also:

Constant Field Values

POLICY_URI

static final String POLICY_URI

See Also:

Constant Field Values

TOS_URI

static final String TOS_URI

See Also:

Constant Field Values

Method Detail

updateClient

void updateClient()

Deprecated. Do not use, to be removed

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.

See Also:

ProviderEvent, ProviderEventManager, ClientModel.ClientUpdatedEvent

getId

String getId()

Returns client internal ID (UUID).

Specified by:

getId in interface ClientScopeModel

Specified by:

getId in interface RoleContainerModel

Returns:

getClientId

String getClientId()

Returns client ID as defined by the user.

Returns:

setClientId

void setClientId(String clientId)

getName

String getName()

Specified by:

getName in interface ClientScopeModel

setName

void setName(String name)

Specified by:

setName in interface ClientScopeModel

getDescription

String getDescription()

Specified by:

getDescription in interface ClientScopeModel

setDescription

void setDescription(String description)

Specified by:

setDescription in interface ClientScopeModel

isEnabled

boolean isEnabled()

setEnabled

void setEnabled(boolean enabled)

isAlwaysDisplayInConsole

boolean isAlwaysDisplayInConsole()

setAlwaysDisplayInConsole

void setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)

isSurrogateAuthRequired

boolean isSurrogateAuthRequired()

setSurrogateAuthRequired

void setSurrogateAuthRequired(boolean surrogateAuthRequired)

getWebOrigins

Set<String> getWebOrigins()

setWebOrigins

void setWebOrigins(Set<String> webOrigins)

addWebOrigin

void addWebOrigin(String webOrigin)

removeWebOrigin

void removeWebOrigin(String webOrigin)

getRedirectUris

Set<String> getRedirectUris()

setRedirectUris

void setRedirectUris(Set<String> redirectUris)

addRedirectUri

void addRedirectUri(String redirectUri)

removeRedirectUri

void removeRedirectUri(String redirectUri)

getManagementUrl

String getManagementUrl()

setManagementUrl

void setManagementUrl(String url)

getRootUrl

String getRootUrl()

setRootUrl

void setRootUrl(String url)

getBaseUrl

String getBaseUrl()

setBaseUrl

void setBaseUrl(String url)

isBearerOnly

boolean isBearerOnly()

setBearerOnly

void setBearerOnly(boolean only)

getNodeReRegistrationTimeout

int getNodeReRegistrationTimeout()

setNodeReRegistrationTimeout

void setNodeReRegistrationTimeout(int timeout)

getClientAuthenticatorType

String getClientAuthenticatorType()

setClientAuthenticatorType

void setClientAuthenticatorType(String clientAuthenticatorType)

validateSecret

boolean validateSecret(String secret)

getSecret

String getSecret()

setSecret

void setSecret(String secret)

getRegistrationToken

String getRegistrationToken()

setRegistrationToken

void setRegistrationToken(String registrationToken)

getProtocol

String getProtocol()

Specified by:

getProtocol in interface ClientScopeModel

setProtocol

void setProtocol(String protocol)

Specified by:

setProtocol in interface ClientScopeModel

setAttribute

void setAttribute(String name,
                  String value)

Specified by:

setAttribute in interface ClientScopeModel

removeAttribute

void removeAttribute(String name)

Specified by:

removeAttribute in interface ClientScopeModel

getAttribute

String getAttribute(String name)

Specified by:

getAttribute in interface ClientScopeModel

getAttributes

Map<String,String> getAttributes()

Specified by:

getAttributes in interface ClientScopeModel

getAuthenticationFlowBindingOverride

String getAuthenticationFlowBindingOverride(String binding)

Get authentication flow binding override for this client. Allows client to override an authentication flow binding.

Parameters:

binding - examples are "browser", "direct_grant"

Returns:

getAuthenticationFlowBindingOverrides

Map<String,String> getAuthenticationFlowBindingOverrides()

removeAuthenticationFlowBindingOverride

void removeAuthenticationFlowBindingOverride(String binding)

setAuthenticationFlowBindingOverride

void setAuthenticationFlowBindingOverride(String binding,
                                          String flowId)

isFrontchannelLogout

boolean isFrontchannelLogout()

setFrontchannelLogout

void setFrontchannelLogout(boolean flag)

isFullScopeAllowed

boolean isFullScopeAllowed()

setFullScopeAllowed

void setFullScopeAllowed(boolean value)

hasDirectScope

default boolean hasDirectScope(RoleModel role)

Description copied from interface: ScopeContainerModel

Returns true, if this object has the given role directly in its scope.

Specified by:

hasDirectScope in interface ScopeContainerModel

Parameters:

role - the role

Returns:

see description

See Also:

if you want to check whether this object has the given role directly or indirectly in its scope

isPublicClient

boolean isPublicClient()

setPublicClient

void setPublicClient(boolean flag)

isConsentRequired

boolean isConsentRequired()

setConsentRequired

void setConsentRequired(boolean consentRequired)

isStandardFlowEnabled

boolean isStandardFlowEnabled()

setStandardFlowEnabled

void setStandardFlowEnabled(boolean standardFlowEnabled)

isImplicitFlowEnabled

boolean isImplicitFlowEnabled()

setImplicitFlowEnabled

void setImplicitFlowEnabled(boolean implicitFlowEnabled)

isDirectAccessGrantsEnabled

boolean isDirectAccessGrantsEnabled()

setDirectAccessGrantsEnabled

void setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)

isServiceAccountsEnabled

boolean isServiceAccountsEnabled()

setServiceAccountsEnabled

void setServiceAccountsEnabled(boolean serviceAccountsEnabled)

getRealm

RealmModel getRealm()

Specified by:

getRealm in interface ClientScopeModel

addClientScope

void addClientScope(ClientScopeModel clientScope,
                    boolean defaultScope)

Add clientScope with this client. Add it as default scope (if parameter 'defaultScope' is true) or optional scope (if parameter 'defaultScope' is false)

Parameters:

clientScope -

defaultScope -

addClientScopes

void addClientScopes(Set<ClientScopeModel> clientScopes,
                     boolean defaultScope)

Add clientScopes with this client. Add as default scopes (if parameter 'defaultScope' is true) or optional scopes (if parameter 'defaultScope' is false)

Parameters:

clientScopes -

defaultScope -

removeClientScope

void removeClientScope(ClientScopeModel clientScope)

getClientScopes

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

Parameters:

defaultScope -

Returns:

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

getDynamicClientScope

default ClientScopeModel getDynamicClientScope(String scope)

Returns a ClientScopeModel associated with this client.

This method is used as a fallback in order to let clients to resolve a scope dynamically which is not listed as default or optional scope when calling #getClientScopes(boolean, boolean).

Parameters:

scope - the scope name

Returns:

the client scope

getNotBefore

int getNotBefore()

Time in seconds since epoc

Returns:

setNotBefore

void setNotBefore(int notBefore)

getRegisteredNodes

Map<String,Integer> getRegisteredNodes()

registerNode

void registerNode(String nodeHost,
                  int registrationTime)

Register node or just update the 'lastReRegistration' time if this node is already registered

Parameters:

nodeHost -

registrationTime -

unregisterNode

void unregisterNode(String nodeHost)

isDisplayOnConsentScreen

default boolean isDisplayOnConsentScreen()

Specified by:

isDisplayOnConsentScreen in interface ClientScopeModel

getConsentScreenText

default String getConsentScreenText()

Specified by:

getConsentScreenText in interface ClientScopeModel