ClientModel (Keycloak Model API 1.3.1.Final API)

All Superinterfaces:

RoleContainerModel
```
public interface ClientModel
extends RoleContainerModel
```
Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields
Modifier and Type Field and Description

static String PRIVATE_KEY

static String PUBLIC_KEY

static String X509CERTIFICATE

Fields
Modifier and Type	Field and Description
`static String`	`PRIVATE_KEY`
`static String`	`PUBLIC_KEY`
`static String`	`X509CERTIFICATE`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDefaultRole(String name)`
`ProtocolMapperModel`	`addProtocolMapper(ProtocolMapperModel model)`
`void`	`addRedirectUri(String redirectUri)`
`void`	`addScopeMapping(RoleModel role)`
`void`	`addWebOrigin(String webOrigin)`
`void`	`deleteScopeMapping(RoleModel role)`
`String`	`getAttribute(String name)`
`Map<String,String>`	`getAttributes()`
`String`	`getBaseUrl()`
`String`	`getClientId()`
`Set<RoleModel>`	`getClientScopeMappings(ClientModel client)`
`List<String>`	`getDefaultRoles()`
`String`	`getId()`
`String`	`getManagementUrl()`
`String`	`getName()`
`int`	`getNodeReRegistrationTimeout()`
`int`	`getNotBefore()` Time in seconds since epoc
`String`	`getProtocol()`
`ProtocolMapperModel`	`getProtocolMapperById(String id)`
`ProtocolMapperModel`	`getProtocolMapperByName(String protocol, String name)`
`Set<ProtocolMapperModel>`	`getProtocolMappers()`
`RealmModel`	`getRealm()`
`Set<RoleModel>`	`getRealmScopeMappings()`
`Set<String>`	`getRedirectUris()`
`Map<String,Integer>`	`getRegisteredNodes()`
`Set<RoleModel>`	`getScopeMappings()`
`String`	`getSecret()`
`Set<String>`	`getWebOrigins()`
`boolean`	`hasScope(RoleModel role)`
`boolean`	`isBearerOnly()`
`boolean`	`isConsentRequired()`
`boolean`	`isDirectGrantsOnly()`
`boolean`	`isEnabled()`
`boolean`	`isFrontchannelLogout()`
`boolean`	`isFullScopeAllowed()`
`boolean`	`isPublicClient()`
`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`	`removeProtocolMapper(ProtocolMapperModel mapping)`
`void`	`removeRedirectUri(String redirectUri)`
`void`	`removeWebOrigin(String webOrigin)`
`void`	`setAttribute(String name, String value)`
`void`	`setBaseUrl(String url)`
`void`	`setBearerOnly(boolean only)`
`void`	`setClientId(String clientId)`
`void`	`setConsentRequired(boolean consentRequired)`
`void`	`setDirectGrantsOnly(boolean flag)`
`void`	`setEnabled(boolean enabled)`
`void`	`setFrontchannelLogout(boolean flag)`
`void`	`setFullScopeAllowed(boolean value)`
`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`	`setSecret(String secret)`
`void`	`setSurrogateAuthRequired(boolean surrogateAuthRequired)`
`void`	`setWebOrigins(Set<String> webOrigins)`
`void`	`unregisterNode(String nodeHost)`
`void`	`updateClient()`
`void`	`updateDefaultRoles(String[] defaultRoles)`
`void`	`updateProtocolMapper(ProtocolMapperModel mapping)`
`boolean`	`validateSecret(String secret)`

Methods inherited from interface org.keycloak.models.RoleContainerModel
addRole, addRole, getRole, getRoles, removeRole

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

Method Detail

updateClient
```
void updateClient()
```

getId
```
String getId()
```

getClientId
```
String getClientId()
```

setClientId
```
void setClientId(String clientId)
```

getName
```
String getName()
```

setName
```
void setName(String name)
```

isEnabled
```
boolean isEnabled()
```

setEnabled
```
void setEnabled(boolean enabled)
```

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)
```

getBaseUrl
```
String getBaseUrl()
```

setBaseUrl
```
void setBaseUrl(String url)
```

getDefaultRoles
```
List<String> getDefaultRoles()
```

addDefaultRole
```
void addDefaultRole(String name)
```

updateDefaultRoles

void updateDefaultRoles(String[] defaultRoles)

getClientScopeMappings

Set<RoleModel> getClientScopeMappings(ClientModel client)

isBearerOnly
```
boolean isBearerOnly()
```

setBearerOnly
```
void setBearerOnly(boolean only)
```

getNodeReRegistrationTimeout
```
int getNodeReRegistrationTimeout()
```

setNodeReRegistrationTimeout

void setNodeReRegistrationTimeout(int timeout)

validateSecret
```
boolean validateSecret(String secret)
```

getSecret
```
String getSecret()
```

setSecret
```
void setSecret(String secret)
```

isFullScopeAllowed
```
boolean isFullScopeAllowed()
```

setFullScopeAllowed

void setFullScopeAllowed(boolean value)

getProtocol
```
String getProtocol()
```

setProtocol
```
void setProtocol(String protocol)
```

setAttribute

void setAttribute(String name,
                String value)

removeAttribute
```
void removeAttribute(String name)
```

getAttribute
```
String getAttribute(String name)
```

getAttributes
```
Map<String,String> getAttributes()
```

isFrontchannelLogout
```
boolean isFrontchannelLogout()
```

setFrontchannelLogout

void setFrontchannelLogout(boolean flag)

isPublicClient
```
boolean isPublicClient()
```

setPublicClient
```
void setPublicClient(boolean flag)
```

isDirectGrantsOnly
```
boolean isDirectGrantsOnly()
```

setDirectGrantsOnly

void setDirectGrantsOnly(boolean flag)

isConsentRequired
```
boolean isConsentRequired()
```

setConsentRequired

void setConsentRequired(boolean consentRequired)

getScopeMappings
```
Set<RoleModel> getScopeMappings()
```

addScopeMapping
```
void addScopeMapping(RoleModel role)
```

deleteScopeMapping

void deleteScopeMapping(RoleModel role)

getRealmScopeMappings
```
Set<RoleModel> getRealmScopeMappings()
```

hasScope
```
boolean hasScope(RoleModel role)
```

getRealm
```
RealmModel getRealm()
```

getNotBefore
```
int getNotBefore()
```
Time in seconds since epoc

Returns:

setNotBefore
```
void setNotBefore(int notBefore)
```

getProtocolMappers

Set<ProtocolMapperModel> getProtocolMappers()

addProtocolMapper

ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model)

removeProtocolMapper

void removeProtocolMapper(ProtocolMapperModel mapping)

updateProtocolMapper

void updateProtocolMapper(ProtocolMapperModel mapping)

getProtocolMapperById

ProtocolMapperModel getProtocolMapperById(String id)

getProtocolMapperByName

ProtocolMapperModel getProtocolMapperByName(String protocol,
                                          String name)

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)
```

Interface ClientModel

Field Summary

Method Summary

Methods inherited from interface org.keycloak.models.RoleContainerModel

Field Detail

PRIVATE_KEY

PUBLIC_KEY

X509CERTIFICATE

Method Detail

updateClient

getId

getClientId

setClientId

getName

setName

isEnabled

setEnabled

isSurrogateAuthRequired

setSurrogateAuthRequired

getWebOrigins

setWebOrigins

addWebOrigin

removeWebOrigin

getRedirectUris

setRedirectUris

addRedirectUri

removeRedirectUri

getManagementUrl

setManagementUrl

getBaseUrl

setBaseUrl

getDefaultRoles

addDefaultRole

updateDefaultRoles

getClientScopeMappings

isBearerOnly

setBearerOnly

getNodeReRegistrationTimeout

setNodeReRegistrationTimeout

validateSecret

getSecret

setSecret

isFullScopeAllowed

setFullScopeAllowed

getProtocol

setProtocol

setAttribute

removeAttribute

getAttribute

getAttributes

isFrontchannelLogout

setFrontchannelLogout

isPublicClient

setPublicClient

isDirectGrantsOnly

setDirectGrantsOnly

isConsentRequired

setConsentRequired

getScopeMappings

addScopeMapping

deleteScopeMapping

getRealmScopeMappings

hasScope

getRealm

getNotBefore

setNotBefore

getProtocolMappers

addProtocolMapper

removeProtocolMapper

updateProtocolMapper

getProtocolMapperById

getProtocolMapperByName

getRegisteredNodes

registerNode

unregisterNode