public class ClientAdapter extends Object implements ClientModel, JpaModel<ClientEntity>
ClientModel.ClientCreationEvent, ClientModel.ClientRemovedEvent, ClientModel.ClientUpdatedEventOrderedModel.OrderedModelComparator<OM extends OrderedModel>RoleContainerModel.RoleRemovedEvent| Modifier and Type | Field and Description |
|---|---|
protected javax.persistence.EntityManager |
em |
protected ClientEntity |
entity |
protected RealmModel |
realm |
protected KeycloakSession |
session |
PRIVATE_KEY, PUBLIC_KEY, X509CERTIFICATECONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE| Constructor and Description |
|---|
ClientAdapter(RealmModel realm,
javax.persistence.EntityManager em,
KeycloakSession session,
ClientEntity entity) |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitgetConsentScreenText, getDynamicClientScope, isDisplayOnConsentScreengetGuiOrder, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScopegetProtocolMappersgetRealmScopeMappings, getScopeMappingsgetDefaultRoles, getRoles, getRoles, searchForRolesprotected KeycloakSession session
protected RealmModel realm
protected javax.persistence.EntityManager em
protected ClientEntity entity
public ClientAdapter(RealmModel realm, javax.persistence.EntityManager em, KeycloakSession session, ClientEntity entity)
public ClientEntity getEntity()
getEntity in interface JpaModel<ClientEntity>public String getId()
ClientModelgetId in interface ClientModelgetId in interface ClientScopeModelgetId in interface RoleContainerModelpublic RealmModel getRealm()
getRealm in interface ClientModelgetRealm in interface ClientScopeModelpublic String getName()
getName in interface ClientModelgetName in interface ClientScopeModelpublic void setName(String name)
setName in interface ClientModelsetName in interface ClientScopeModelpublic String getDescription()
getDescription in interface ClientModelgetDescription in interface ClientScopeModelpublic void setDescription(String description)
setDescription in interface ClientModelsetDescription in interface ClientScopeModelpublic boolean isEnabled()
isEnabled in interface ClientModelpublic void setEnabled(boolean enabled)
setEnabled in interface ClientModelpublic boolean isAlwaysDisplayInConsole()
isAlwaysDisplayInConsole in interface ClientModelpublic void setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)
setAlwaysDisplayInConsole in interface ClientModelpublic boolean isPublicClient()
isPublicClient in interface ClientModelpublic void setPublicClient(boolean flag)
setPublicClient in interface ClientModelpublic boolean isFrontchannelLogout()
isFrontchannelLogout in interface ClientModelpublic void setFrontchannelLogout(boolean flag)
setFrontchannelLogout in interface ClientModelpublic boolean isFullScopeAllowed()
isFullScopeAllowed in interface ClientModelpublic void setFullScopeAllowed(boolean value)
setFullScopeAllowed in interface ClientModelpublic Set<String> getWebOrigins()
getWebOrigins in interface ClientModelpublic void setWebOrigins(Set<String> webOrigins)
setWebOrigins in interface ClientModelpublic void addWebOrigin(String webOrigin)
addWebOrigin in interface ClientModelpublic void removeWebOrigin(String webOrigin)
removeWebOrigin in interface ClientModelpublic Set<String> getRedirectUris()
getRedirectUris in interface ClientModelpublic void setRedirectUris(Set<String> redirectUris)
setRedirectUris in interface ClientModelpublic void addRedirectUri(String redirectUri)
addRedirectUri in interface ClientModelpublic void removeRedirectUri(String redirectUri)
removeRedirectUri in interface ClientModelpublic String getClientAuthenticatorType()
getClientAuthenticatorType in interface ClientModelpublic void setClientAuthenticatorType(String clientAuthenticatorType)
setClientAuthenticatorType in interface ClientModelpublic String getSecret()
getSecret in interface ClientModelpublic void setSecret(String secret)
setSecret in interface ClientModelpublic String getRegistrationToken()
getRegistrationToken in interface ClientModelpublic void setRegistrationToken(String registrationToken)
setRegistrationToken in interface ClientModelpublic boolean validateSecret(String secret)
validateSecret in interface ClientModelpublic int getNotBefore()
ClientModelgetNotBefore in interface ClientModelpublic void setNotBefore(int notBefore)
setNotBefore in interface ClientModelpublic Stream<RoleModel> getRealmScopeMappingsStream()
ScopeContainerModelScopeContainerModel.getScopeMappingsStream() ()} returns only those
that belong to the realm that owns this scope container.getRealmScopeMappingsStream in interface ScopeContainerModelRoleModelpublic Stream<RoleModel> getScopeMappingsStream()
getScopeMappingsStream in interface ScopeContainerModelpublic void addScopeMapping(RoleModel role)
addScopeMapping in interface ScopeContainerModelpublic void deleteScopeMapping(RoleModel role)
deleteScopeMapping in interface ScopeContainerModelpublic String getProtocol()
getProtocol in interface ClientModelgetProtocol in interface ClientScopeModelpublic void setProtocol(String protocol)
setProtocol in interface ClientModelsetProtocol in interface ClientScopeModelpublic void setAuthenticationFlowBindingOverride(String name, String value)
setAuthenticationFlowBindingOverride in interface ClientModelpublic void removeAuthenticationFlowBindingOverride(String name)
removeAuthenticationFlowBindingOverride in interface ClientModelpublic String getAuthenticationFlowBindingOverride(String name)
ClientModelgetAuthenticationFlowBindingOverride in interface ClientModelname - examples are "browser", "direct_grant"public Map<String,String> getAuthenticationFlowBindingOverrides()
getAuthenticationFlowBindingOverrides in interface ClientModelpublic void setAttribute(String name, String value)
setAttribute in interface ClientModelsetAttribute in interface ClientScopeModelpublic void removeAttribute(String name)
removeAttribute in interface ClientModelremoveAttribute in interface ClientScopeModelpublic String getAttribute(String name)
getAttribute in interface ClientModelgetAttribute in interface ClientScopeModelpublic Map<String,String> getAttributes()
getAttributes in interface ClientModelgetAttributes in interface ClientScopeModelpublic void addClientScope(ClientScopeModel clientScope, boolean defaultScope)
ClientModeladdClientScope in interface ClientModelpublic void addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
ClientModeladdClientScopes in interface ClientModelpublic void removeClientScope(ClientScopeModel clientScope)
removeClientScope in interface ClientModelpublic Map<String,ClientScopeModel> getClientScopes(boolean defaultScope, boolean filterByProtocol)
ClientModelgetClientScopes in interface ClientModelfilterByProtocol - if true, then just client scopes of same protocol like current client will be returnedpublic Stream<ProtocolMapperModel> getProtocolMappersStream()
ProtocolMapperContainerModelgetProtocolMappersStream in interface ProtocolMapperContainerModelpublic ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)
addProtocolMapper in interface ProtocolMapperContainerModelprotected ProtocolMapperEntity getProtocolMapperEntity(String id)
protected ProtocolMapperEntity getProtocolMapperEntityByName(String protocol, String name)
public void removeProtocolMapper(ProtocolMapperModel mapping)
removeProtocolMapper in interface ProtocolMapperContainerModelpublic void updateProtocolMapper(ProtocolMapperModel mapping)
updateProtocolMapper in interface ProtocolMapperContainerModelpublic ProtocolMapperModel getProtocolMapperById(String id)
getProtocolMapperById in interface ProtocolMapperContainerModelpublic ProtocolMapperModel getProtocolMapperByName(String protocol, String name)
getProtocolMapperByName in interface ProtocolMapperContainerModelprotected ProtocolMapperModel entityToModel(ProtocolMapperEntity entity)
public void updateClient()
ClientModel
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.
updateClient in interface ClientModelProviderEvent,
ProviderEventManager,
ClientModel.ClientUpdatedEventpublic String getClientId()
ClientModelgetClientId in interface ClientModelpublic void setClientId(String clientId)
setClientId in interface ClientModelpublic boolean isSurrogateAuthRequired()
isSurrogateAuthRequired in interface ClientModelpublic void setSurrogateAuthRequired(boolean surrogateAuthRequired)
setSurrogateAuthRequired in interface ClientModelpublic String getManagementUrl()
getManagementUrl in interface ClientModelpublic void setManagementUrl(String url)
setManagementUrl in interface ClientModelpublic String getRootUrl()
getRootUrl in interface ClientModelpublic void setRootUrl(String url)
setRootUrl in interface ClientModelpublic String getBaseUrl()
getBaseUrl in interface ClientModelpublic void setBaseUrl(String url)
setBaseUrl in interface ClientModelpublic boolean isBearerOnly()
isBearerOnly in interface ClientModelpublic void setBearerOnly(boolean only)
setBearerOnly in interface ClientModelpublic boolean isConsentRequired()
isConsentRequired in interface ClientModelpublic void setConsentRequired(boolean consentRequired)
setConsentRequired in interface ClientModelpublic boolean isStandardFlowEnabled()
isStandardFlowEnabled in interface ClientModelpublic void setStandardFlowEnabled(boolean standardFlowEnabled)
setStandardFlowEnabled in interface ClientModelpublic boolean isImplicitFlowEnabled()
isImplicitFlowEnabled in interface ClientModelpublic void setImplicitFlowEnabled(boolean implicitFlowEnabled)
setImplicitFlowEnabled in interface ClientModelpublic boolean isDirectAccessGrantsEnabled()
isDirectAccessGrantsEnabled in interface ClientModelpublic void setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)
setDirectAccessGrantsEnabled in interface ClientModelpublic boolean isServiceAccountsEnabled()
isServiceAccountsEnabled in interface ClientModelpublic void setServiceAccountsEnabled(boolean serviceAccountsEnabled)
setServiceAccountsEnabled in interface ClientModelpublic RoleModel getRole(String name)
getRole in interface RoleContainerModelpublic RoleModel addRole(String name)
addRole in interface RoleContainerModelpublic RoleModel addRole(String id, String name)
addRole in interface RoleContainerModelpublic boolean removeRole(RoleModel roleModel)
removeRole in interface RoleContainerModelpublic Stream<RoleModel> getRolesStream()
getRolesStream in interface RoleContainerModelpublic Stream<RoleModel> getRolesStream(Integer first, Integer max)
getRolesStream in interface RoleContainerModelpublic Stream<RoleModel> searchForRolesStream(String search, Integer first, Integer max)
searchForRolesStream in interface RoleContainerModelpublic boolean hasScope(RoleModel role)
hasScope in interface ScopeContainerModelpublic Stream<String> getDefaultRolesStream()
RoleContainerModelgetDefaultRolesStream in interface RoleContainerModelnull.public void addDefaultRole(String name)
RoleContainerModeladdDefaultRole in interface RoleContainerModelname - of the role to be (created and ) addedpublic void updateDefaultRoles(String... defaultRoles)
RoleContainerModeldefaultRoles and adds all which weren't
present in original default roles. In other words it's the same as calling
Set.retainAll and Set.addAll.updateDefaultRoles in interface RoleContainerModeldefaultRoles - Array of realm roles to be updatedpublic void removeDefaultRoles(String... defaultRoles)
RoleContainerModeldefaultRoles.removeDefaultRoles in interface RoleContainerModeldefaultRoles - Role names to be removed from default roles of this object.public int getNodeReRegistrationTimeout()
getNodeReRegistrationTimeout in interface ClientModelpublic void setNodeReRegistrationTimeout(int timeout)
setNodeReRegistrationTimeout in interface ClientModelpublic Map<String,Integer> getRegisteredNodes()
getRegisteredNodes in interface ClientModelpublic void registerNode(String nodeHost, int registrationTime)
ClientModelregisterNode in interface ClientModelpublic void unregisterNode(String nodeHost)
unregisterNode in interface ClientModelCopyright © 2021 JBoss by Red Hat. All rights reserved.