public interface ClientModel extends ClientScopeModel, RoleContainerModel, ProtocolMapperContainerModel, ScopeContainerModel
OrderedModel.OrderedModelComparator<OM extends OrderedModel>
RoleContainerModel.RoleRemovedEvent
Modifier and Type | Field and Description |
---|---|
static String |
PRIVATE_KEY |
static String |
PUBLIC_KEY |
static String |
X509CERTIFICATE |
CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, GUI_ORDER, INCLUDE_IN_TOKEN_SCOPE
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,
boolean filterByProtocol)
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() |
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) |
getGuiOrder, isIncludeInTokenScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInTokenScope
addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMappers, removeProtocolMapper, updateProtocolMapper
addScopeMapping, deleteScopeMapping, getRealmScopeMappings, getScopeMappings, getScopeMappingsStream, hasScope
addDefaultRole, addRole, addRole, getDefaultRoles, getRole, getRoles, getRoles, removeDefaultRoles, removeRole, searchForRoles, updateDefaultRoles
static final String PRIVATE_KEY
static final String PUBLIC_KEY
static final String X509CERTIFICATE
void updateClient()
String getId()
getId
in interface ClientScopeModel
getId
in interface RoleContainerModel
String getClientId()
void setClientId(String clientId)
String getName()
getName
in interface ClientScopeModel
void setName(String name)
setName
in interface ClientScopeModel
String getDescription()
getDescription
in interface ClientScopeModel
void setDescription(String description)
setDescription
in interface ClientScopeModel
boolean isEnabled()
void setEnabled(boolean enabled)
boolean isAlwaysDisplayInConsole()
void setAlwaysDisplayInConsole(boolean alwaysDisplayInConsole)
boolean isSurrogateAuthRequired()
void setSurrogateAuthRequired(boolean surrogateAuthRequired)
void addWebOrigin(String webOrigin)
void removeWebOrigin(String webOrigin)
void addRedirectUri(String redirectUri)
void removeRedirectUri(String redirectUri)
String getManagementUrl()
void setManagementUrl(String url)
String getRootUrl()
void setRootUrl(String url)
String getBaseUrl()
void setBaseUrl(String url)
boolean isBearerOnly()
void setBearerOnly(boolean only)
int getNodeReRegistrationTimeout()
void setNodeReRegistrationTimeout(int timeout)
String getClientAuthenticatorType()
void setClientAuthenticatorType(String clientAuthenticatorType)
boolean validateSecret(String secret)
String getSecret()
void setSecret(String secret)
String getRegistrationToken()
void setRegistrationToken(String registrationToken)
String getProtocol()
getProtocol
in interface ClientScopeModel
void setProtocol(String protocol)
setProtocol
in interface ClientScopeModel
void setAttribute(String name, String value)
setAttribute
in interface ClientScopeModel
void removeAttribute(String name)
removeAttribute
in interface ClientScopeModel
String getAttribute(String name)
getAttribute
in interface ClientScopeModel
Map<String,String> getAttributes()
getAttributes
in interface ClientScopeModel
String getAuthenticationFlowBindingOverride(String binding)
binding
- examples are "browser", "direct_grant"void removeAuthenticationFlowBindingOverride(String binding)
void setAuthenticationFlowBindingOverride(String binding, String flowId)
boolean isFrontchannelLogout()
void setFrontchannelLogout(boolean flag)
boolean isFullScopeAllowed()
void setFullScopeAllowed(boolean value)
boolean isPublicClient()
void setPublicClient(boolean flag)
boolean isConsentRequired()
void setConsentRequired(boolean consentRequired)
boolean isStandardFlowEnabled()
void setStandardFlowEnabled(boolean standardFlowEnabled)
boolean isImplicitFlowEnabled()
void setImplicitFlowEnabled(boolean implicitFlowEnabled)
boolean isDirectAccessGrantsEnabled()
void setDirectAccessGrantsEnabled(boolean directAccessGrantsEnabled)
boolean isServiceAccountsEnabled()
void setServiceAccountsEnabled(boolean serviceAccountsEnabled)
RealmModel getRealm()
getRealm
in interface ClientScopeModel
void addClientScope(ClientScopeModel clientScope, boolean defaultScope)
clientScope
- defaultScope
- void addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
clientScopes
- defaultScope
- void removeClientScope(ClientScopeModel clientScope)
Map<String,ClientScopeModel> getClientScopes(boolean defaultScope, boolean filterByProtocol)
defaultScope
- filterByProtocol
- if true, then just client scopes of same protocol like current client will be returneddefault 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)
.
scope
- the scope nameint getNotBefore()
void setNotBefore(int notBefore)
void registerNode(String nodeHost, int registrationTime)
nodeHost
- registrationTime
- void unregisterNode(String nodeHost)
default boolean isDisplayOnConsentScreen()
isDisplayOnConsentScreen
in interface ClientScopeModel
default String getConsentScreenText()
getConsentScreenText
in interface ClientScopeModel
Copyright © 2020 JBoss by Red Hat. All rights reserved.