public abstract class AbstractClientModel<E extends AbstractEntity> extends Object implements ClientModel
ClientModel.ClientCreationEvent, ClientModel.ClientProtocolUpdatedEvent, ClientModel.ClientRemovedEvent, ClientModel.ClientUpdatedEvent, ClientModel.SearchableFields
ClientScopeModel.ClientScopeRemovedEvent
OrderedModel.OrderedModelComparator<OM extends OrderedModel>
RoleContainerModel.RoleRemovedEvent
Modifier and Type | Field and Description |
---|---|
protected E |
entity |
protected RealmModel |
realm |
protected KeycloakSession |
session |
PRIVATE_KEY, PUBLIC_KEY, X509CERTIFICATE
CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE
Constructor and Description |
---|
AbstractClientModel(KeycloakSession session,
RealmModel realm,
E entity) |
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.
|
RoleModel |
addRole(String name) |
RoleModel |
addRole(String id,
String name) |
boolean |
equals(Object o) |
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<RoleModel> |
getRealmScopeMappingsStream()
From the scope mappings returned by
ScopeContainerModel.getScopeMappingsStream() returns only those
that belong to the realm that owns this scope container. |
RoleModel |
getRole(String name) |
Stream<RoleModel> |
getRolesStream()
Returns available roles as a stream.
|
Stream<RoleModel> |
getRolesStream(Integer firstResult,
Integer maxResults)
Returns available roles as a stream.
|
int |
hashCode() |
void |
removeClientScope(ClientScopeModel clientScope) |
boolean |
removeRole(RoleModel role) |
Stream<RoleModel> |
searchForRolesStream(String search,
Integer first,
Integer max)
Searches roles by the given name.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
addRedirectUri, addWebOrigin, getAttribute, getAttributes, getAuthenticationFlowBindingOverride, getAuthenticationFlowBindingOverrides, getBaseUrl, getClientAuthenticatorType, getClientId, getConsentScreenText, getDescription, getDynamicClientScope, getId, getManagementUrl, getName, getNodeReRegistrationTimeout, getNotBefore, getProtocol, getRealm, getRedirectUris, getRegisteredNodes, getRegistrationToken, getRootUrl, getSecret, getWebOrigins, isAlwaysDisplayInConsole, isBearerOnly, isConsentRequired, isDirectAccessGrantsEnabled, isDisplayOnConsentScreen, isEnabled, isFrontchannelLogout, isFullScopeAllowed, isImplicitFlowEnabled, isPublicClient, isServiceAccountsEnabled, isStandardFlowEnabled, isSurrogateAuthRequired, registerNode, removeAttribute, removeAuthenticationFlowBindingOverride, removeRedirectUri, removeWebOrigin, setAlwaysDisplayInConsole, setAttribute, setAuthenticationFlowBindingOverride, setBaseUrl, setBearerOnly, setClientAuthenticatorType, setClientId, setConsentRequired, setDescription, setDirectAccessGrantsEnabled, setEnabled, setFrontchannelLogout, setFullScopeAllowed, setImplicitFlowEnabled, setManagementUrl, setName, setNodeReRegistrationTimeout, setNotBefore, setProtocol, setPublicClient, setRedirectUris, setRegistrationToken, setRootUrl, setSecret, setServiceAccountsEnabled, setStandardFlowEnabled, setSurrogateAuthRequired, setWebOrigins, unregisterNode, updateClient, validateSecret
getGuiOrder, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope
addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMappers, getProtocolMappersStream, removeProtocolMapper, updateProtocolMapper
addScopeMapping, deleteScopeMapping, getRealmScopeMappings, getScopeMappings, getScopeMappingsStream, hasScope
addDefaultRole, getDefaultRoles, getDefaultRolesStream, getRoles, getRoles, removeDefaultRoles, searchForRoles, updateDefaultRoles
protected final KeycloakSession session
protected final RealmModel realm
protected final E extends AbstractEntity entity
public AbstractClientModel(KeycloakSession session, RealmModel realm, E entity)
public void addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
ClientModel
addClientScopes
in interface ClientModel
public void addClientScope(ClientScopeModel clientScope, boolean defaultScope)
ClientModel
addClientScope
in interface ClientModel
public void removeClientScope(ClientScopeModel clientScope)
removeClientScope
in interface ClientModel
public Map<String,ClientScopeModel> getClientScopes(boolean defaultScope)
ClientModel
getClientScopes
in interface ClientModel
public Stream<RoleModel> getRealmScopeMappingsStream()
ScopeContainerModel
ScopeContainerModel.getScopeMappingsStream()
returns only those
that belong to the realm that owns this scope container.getRealmScopeMappingsStream
in interface ScopeContainerModel
RoleModel
. Never returns null
.public RoleModel getRole(String name)
getRole
in interface RoleContainerModel
public RoleModel addRole(String name)
addRole
in interface RoleContainerModel
public RoleModel addRole(String id, String name)
addRole
in interface RoleContainerModel
public boolean removeRole(RoleModel role)
removeRole
in interface RoleContainerModel
public Stream<RoleModel> getRolesStream()
RoleContainerModel
getRolesStream
in interface RoleContainerModel
RoleModel
. Never returns null
.public Stream<RoleModel> getRolesStream(Integer firstResult, Integer maxResults)
RoleContainerModel
getRolesStream
in interface RoleContainerModel
firstResult
- Integer
Index of the first desired role. Ignored if negative or null
.maxResults
- Integer
Maximum number of returned roles. Ignored if negative or null
.RoleModel
. Never returns null
.public Stream<RoleModel> searchForRolesStream(String search, Integer first, Integer max)
RoleContainerModel
searchForRolesStream
in interface RoleContainerModel
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
.RoleModel
. Never returns null
.Copyright © 2021 JBoss by Red Hat. All rights reserved.