public class ClientAdapter extends Object implements ClientModel, CachedObject
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 CachedClient |
cached |
protected RealmModel |
cachedRealm |
protected RealmCacheSession |
cacheSession |
protected boolean |
invalidated |
protected ClientModel |
updated |
PRIVATE_KEY, PUBLIC_KEY, X509CERTIFICATE
CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE
Constructor and Description |
---|
ClientAdapter(RealmModel cachedRealm,
CachedClient cached,
RealmCacheSession cacheSession) |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getConsentScreenText, getDynamicClientScope, isDisplayOnConsentScreen
getGuiOrder, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope
getProtocolMappers
getRealmScopeMappings, getScopeMappings
getDefaultRoles, getRoles, getRoles, searchForRoles, updateDefaultRoles
protected RealmCacheSession cacheSession
protected RealmModel cachedRealm
protected ClientModel updated
protected CachedClient cached
protected boolean invalidated
public ClientAdapter(RealmModel cachedRealm, CachedClient cached, RealmCacheSession cacheSession)
public void invalidate()
protected boolean isUpdated()
public long getCacheTimestamp()
getCacheTimestamp
in interface CachedObject
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 ClientModel
ProviderEvent
,
ProviderEventManager
,
ClientModel.ClientUpdatedEvent
public String getId()
ClientModel
getId
in interface ClientModel
getId
in interface ClientScopeModel
getId
in interface RoleContainerModel
public Set<String> getWebOrigins()
getWebOrigins
in interface ClientModel
public void setWebOrigins(Set<String> webOrigins)
setWebOrigins
in interface ClientModel
public void addClientScope(ClientScopeModel clientScope, boolean defaultScope)
ClientModel
addClientScope
in interface ClientModel
public void addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
ClientModel
addClientScopes
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 void addWebOrigin(String webOrigin)
addWebOrigin
in interface ClientModel
public void removeWebOrigin(String webOrigin)
removeWebOrigin
in interface ClientModel
public Set<String> getRedirectUris()
getRedirectUris
in interface ClientModel
public void setRedirectUris(Set<String> redirectUris)
setRedirectUris
in interface ClientModel
public void addRedirectUri(String redirectUri)
addRedirectUri
in interface ClientModel
public void removeRedirectUri(String redirectUri)
removeRedirectUri
in interface ClientModel
public boolean isEnabled()
isEnabled
in interface ClientModel
public void setEnabled(boolean enabled)
setEnabled
in interface ClientModel
public boolean isAlwaysDisplayInConsole()
isAlwaysDisplayInConsole
in interface ClientModel
public void setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)
setAlwaysDisplayInConsole
in interface ClientModel
public String getClientAuthenticatorType()
getClientAuthenticatorType
in interface ClientModel
public void setClientAuthenticatorType(String clientAuthenticatorType)
setClientAuthenticatorType
in interface ClientModel
public boolean validateSecret(String secret)
validateSecret
in interface ClientModel
public String getSecret()
getSecret
in interface ClientModel
public void setSecret(String secret)
setSecret
in interface ClientModel
public String getRegistrationToken()
getRegistrationToken
in interface ClientModel
public void setRegistrationToken(String registrationToken)
setRegistrationToken
in interface ClientModel
public boolean isPublicClient()
isPublicClient
in interface ClientModel
public void setPublicClient(boolean flag)
setPublicClient
in interface ClientModel
public boolean isFrontchannelLogout()
isFrontchannelLogout
in interface ClientModel
public void setFrontchannelLogout(boolean flag)
setFrontchannelLogout
in interface ClientModel
public boolean isFullScopeAllowed()
isFullScopeAllowed
in interface ClientModel
public void setFullScopeAllowed(boolean value)
setFullScopeAllowed
in interface ClientModel
public Stream<RoleModel> getScopeMappingsStream()
ScopeContainerModel
getScopeMappingsStream
in interface ScopeContainerModel
RoleModel
. Never returns null
.public void addScopeMapping(RoleModel role)
addScopeMapping
in interface ScopeContainerModel
public void deleteScopeMapping(RoleModel role)
deleteScopeMapping
in interface ScopeContainerModel
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 RealmModel getRealm()
getRealm
in interface ClientModel
getRealm
in interface ClientScopeModel
public int getNotBefore()
ClientModel
getNotBefore
in interface ClientModel
public void setNotBefore(int notBefore)
setNotBefore
in interface ClientModel
public String getProtocol()
getProtocol
in interface ClientModel
getProtocol
in interface ClientScopeModel
public void setProtocol(String protocol)
setProtocol
in interface ClientModel
setProtocol
in interface ClientScopeModel
public void setAttribute(String name, String value)
setAttribute
in interface ClientModel
setAttribute
in interface ClientScopeModel
public void removeAttribute(String name)
removeAttribute
in interface ClientModel
removeAttribute
in interface ClientScopeModel
public String getAttribute(String name)
getAttribute
in interface ClientModel
getAttribute
in interface ClientScopeModel
public Map<String,String> getAttributes()
getAttributes
in interface ClientModel
getAttributes
in interface ClientScopeModel
public void setAuthenticationFlowBindingOverride(String name, String value)
setAuthenticationFlowBindingOverride
in interface ClientModel
public void removeAuthenticationFlowBindingOverride(String name)
removeAuthenticationFlowBindingOverride
in interface ClientModel
public String getAuthenticationFlowBindingOverride(String name)
ClientModel
getAuthenticationFlowBindingOverride
in interface ClientModel
name
- examples are "browser", "direct_grant"public Map<String,String> getAuthenticationFlowBindingOverrides()
getAuthenticationFlowBindingOverrides
in interface ClientModel
public Stream<ProtocolMapperModel> getProtocolMappersStream()
ProtocolMapperContainerModel
getProtocolMappersStream
in interface ProtocolMapperContainerModel
null
.public ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)
addProtocolMapper
in interface ProtocolMapperContainerModel
public void removeProtocolMapper(ProtocolMapperModel mapping)
removeProtocolMapper
in interface ProtocolMapperContainerModel
public void updateProtocolMapper(ProtocolMapperModel mapping)
updateProtocolMapper
in interface ProtocolMapperContainerModel
public ProtocolMapperModel getProtocolMapperById(String id)
getProtocolMapperById
in interface ProtocolMapperContainerModel
public ProtocolMapperModel getProtocolMapperByName(String protocol, String name)
getProtocolMapperByName
in interface ProtocolMapperContainerModel
public String getClientId()
ClientModel
getClientId
in interface ClientModel
public void setClientId(String clientId)
setClientId
in interface ClientModel
public String getName()
getName
in interface ClientModel
getName
in interface ClientScopeModel
public void setName(String name)
setName
in interface ClientModel
setName
in interface ClientScopeModel
public String getDescription()
getDescription
in interface ClientModel
getDescription
in interface ClientScopeModel
public void setDescription(String description)
setDescription
in interface ClientModel
setDescription
in interface ClientScopeModel
public boolean isSurrogateAuthRequired()
isSurrogateAuthRequired
in interface ClientModel
public void setSurrogateAuthRequired(boolean surrogateAuthRequired)
setSurrogateAuthRequired
in interface ClientModel
public String getManagementUrl()
getManagementUrl
in interface ClientModel
public void setManagementUrl(String url)
setManagementUrl
in interface ClientModel
public String getRootUrl()
getRootUrl
in interface ClientModel
public void setRootUrl(String url)
setRootUrl
in interface ClientModel
public String getBaseUrl()
getBaseUrl
in interface ClientModel
public void setBaseUrl(String url)
setBaseUrl
in interface ClientModel
@Deprecated public Stream<String> getDefaultRolesStream()
getDefaultRolesStream
in interface RoleContainerModel
@Deprecated public void addDefaultRole(String name)
addDefaultRole
in interface RoleContainerModel
@Deprecated public void removeDefaultRoles(String... defaultRoles)
removeDefaultRoles
in interface RoleContainerModel
public boolean isBearerOnly()
isBearerOnly
in interface ClientModel
public void setBearerOnly(boolean only)
setBearerOnly
in interface ClientModel
public boolean isConsentRequired()
isConsentRequired
in interface ClientModel
public void setConsentRequired(boolean consentRequired)
setConsentRequired
in interface ClientModel
public boolean isStandardFlowEnabled()
isStandardFlowEnabled
in interface ClientModel
public void setStandardFlowEnabled(boolean standardFlowEnabled)
setStandardFlowEnabled
in interface ClientModel
public boolean isImplicitFlowEnabled()
isImplicitFlowEnabled
in interface ClientModel
public void setImplicitFlowEnabled(boolean implicitFlowEnabled)
setImplicitFlowEnabled
in interface ClientModel
public boolean isDirectAccessGrantsEnabled()
isDirectAccessGrantsEnabled
in interface ClientModel
public void setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)
setDirectAccessGrantsEnabled
in interface ClientModel
public boolean isServiceAccountsEnabled()
isServiceAccountsEnabled
in interface ClientModel
public void setServiceAccountsEnabled(boolean serviceAccountsEnabled)
setServiceAccountsEnabled
in interface ClientModel
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 first, Integer max)
RoleContainerModel
getRolesStream
in interface RoleContainerModel
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
.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
.public int getNodeReRegistrationTimeout()
getNodeReRegistrationTimeout
in interface ClientModel
public void setNodeReRegistrationTimeout(int timeout)
setNodeReRegistrationTimeout
in interface ClientModel
public Map<String,Integer> getRegisteredNodes()
getRegisteredNodes
in interface ClientModel
public void registerNode(String nodeHost, int registrationTime)
ClientModel
registerNode
in interface ClientModel
public void unregisterNode(String nodeHost)
unregisterNode
in interface ClientModel
public boolean hasScope(RoleModel role)
hasScope
in interface ScopeContainerModel
Copyright © 2021 JBoss by Red Hat. All rights reserved.