CachedClient (Keycloak Docs Distribution 14.0.0 API)

java.lang.Object
- org.keycloak.models.cache.infinispan.entities.AbstractRevisioned
- - org.keycloak.models.cache.infinispan.entities.CachedClient

All Implemented Interfaces:

Serializable, CachedObject, InRealm, Revisioned
```
public class CachedClient
extends AbstractRevisioned
implements InRealm
```
Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alwaysDisplayInConsole`
`protected Map<String,String>`	`attributes`
`protected Map<String,String>`	`authFlowBindings`
`protected String`	`baseUrl`
`protected boolean`	`bearerOnly`
`protected String`	`clientAuthenticatorType`
`protected String`	`clientId`
`protected boolean`	`consentRequired`
`protected List<String>`	`defaultClientScopesIds`
`protected String`	`description`
`protected boolean`	`directAccessGrantsEnabled`
`protected boolean`	`enabled`
`protected boolean`	`frontchannelLogout`
`protected boolean`	`fullScopeAllowed`
`protected boolean`	`implicitFlowEnabled`
`protected String`	`managementUrl`
`protected String`	`name`
`protected int`	`nodeReRegistrationTimeout`
`protected int`	`notBefore`
`protected List<String>`	`optionalClientScopesIds`
`protected String`	`protocol`
`protected Set<ProtocolMapperModel>`	`protocolMappers`
`protected boolean`	`publicClient`
`protected String`	`realm`
`protected Set<String>`	`redirectUris`
`protected Map<String,Integer>`	`registeredNodes`
`protected String`	`registrationToken`
`protected String`	`rootUrl`
`protected Set<String>`	`scope`
`protected String`	`secret`
`protected boolean`	`serviceAccountsEnabled`
`protected boolean`	`standardFlowEnabled`
`protected boolean`	`surrogateAuthRequired`
`protected Set<String>`	`webOrigins`

Constructor Summary

Constructors
Constructor and Description

CachedClient(Long revision, RealmModel realm, ClientModel model)

Constructors
Constructor and Description
`CachedClient(Long revision, RealmModel realm, ClientModel model)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAttributes()`
`Map<String,String>`	`getAuthFlowBindings()`
`String`	`getBaseUrl()`
`String`	`getClientAuthenticatorType()`
`String`	`getClientId()`
`List<String>`	`getDefaultClientScopesIds()`
`String`	`getDescription()`
`String`	`getManagementUrl()`
`String`	`getName()`
`int`	`getNodeReRegistrationTimeout()`
`int`	`getNotBefore()`
`List<String>`	`getOptionalClientScopesIds()`
`String`	`getProtocol()`
`Set<ProtocolMapperModel>`	`getProtocolMappers()`
`String`	`getRealm()`
`Set<String>`	`getRedirectUris()`
`Map<String,Integer>`	`getRegisteredNodes()`
`String`	`getRegistrationToken()`
`String`	`getRootUrl()`
`Set<String>`	`getScope()`
`String`	`getSecret()`
`Set<String>`	`getWebOrigins()`
`boolean`	`isAlwaysDisplayInConsole()`
`boolean`	`isBearerOnly()`
`boolean`	`isConsentRequired()`
`boolean`	`isDirectAccessGrantsEnabled()`
`boolean`	`isEnabled()`
`boolean`	`isFrontchannelLogout()`
`boolean`	`isFullScopeAllowed()`
`boolean`	`isImplicitFlowEnabled()`
`boolean`	`isPublicClient()`
`boolean`	`isServiceAccountsEnabled()`
`boolean`	`isStandardFlowEnabled()`
`boolean`	`isSurrogateAuthRequired()`
`void`	`setDescription(String description)`

Methods inherited from class org.keycloak.models.cache.infinispan.entities.AbstractRevisioned
getCacheTimestamp, getId, getRevision, setRevision

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.cache.infinispan.entities.Revisioned
getId, getRevision, setRevision

Field Detail

clientId
```
protected String clientId
```

name
```
protected String name
```

description
```
protected String description
```

realm
```
protected String realm
```

redirectUris
```
protected Set<String> redirectUris
```

enabled
```
protected boolean enabled
```

alwaysDisplayInConsole

protected boolean alwaysDisplayInConsole

clientAuthenticatorType

protected String clientAuthenticatorType

secret
```
protected String secret
```

registrationToken
```
protected String registrationToken
```

protocol
```
protected String protocol
```

attributes

protected Map<String,String> attributes

authFlowBindings

protected Map<String,String> authFlowBindings

publicClient
```
protected boolean publicClient
```

fullScopeAllowed
```
protected boolean fullScopeAllowed
```

frontchannelLogout
```
protected boolean frontchannelLogout
```

notBefore
```
protected int notBefore
```

scope
```
protected Set<String> scope
```

webOrigins
```
protected Set<String> webOrigins
```

protocolMappers

protected Set<ProtocolMapperModel> protocolMappers

surrogateAuthRequired

protected boolean surrogateAuthRequired

managementUrl
```
protected String managementUrl
```

rootUrl
```
protected String rootUrl
```

baseUrl
```
protected String baseUrl
```

bearerOnly
```
protected boolean bearerOnly
```

consentRequired
```
protected boolean consentRequired
```

standardFlowEnabled
```
protected boolean standardFlowEnabled
```

implicitFlowEnabled
```
protected boolean implicitFlowEnabled
```

directAccessGrantsEnabled

protected boolean directAccessGrantsEnabled

serviceAccountsEnabled

protected boolean serviceAccountsEnabled

nodeReRegistrationTimeout

protected int nodeReRegistrationTimeout

registeredNodes

protected Map<String,Integer> registeredNodes

defaultClientScopesIds

protected List<String> defaultClientScopesIds

optionalClientScopesIds

protected List<String> optionalClientScopesIds

Constructor Detail

CachedClient

public CachedClient(Long revision,
                    RealmModel realm,
                    ClientModel model)

Method Detail

getClientId
```
public String getClientId()
```

getName
```
public String getName()
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getRealm
```
public String getRealm()
```
Specified by:

getRealm in interface InRealm

getRedirectUris
```
public Set<String> getRedirectUris()
```

isEnabled
```
public boolean isEnabled()
```

isAlwaysDisplayInConsole

public boolean isAlwaysDisplayInConsole()

getClientAuthenticatorType

public String getClientAuthenticatorType()

getSecret
```
public String getSecret()
```

getRegistrationToken
```
public String getRegistrationToken()
```

isPublicClient
```
public boolean isPublicClient()
```

getNotBefore
```
public int getNotBefore()
```

getScope
```
public Set<String> getScope()
```

getWebOrigins
```
public Set<String> getWebOrigins()
```

isFullScopeAllowed
```
public boolean isFullScopeAllowed()
```

getProtocol
```
public String getProtocol()
```

getAttributes

public Map<String,String> getAttributes()

isFrontchannelLogout
```
public boolean isFrontchannelLogout()
```

getProtocolMappers

public Set<ProtocolMapperModel> getProtocolMappers()

isSurrogateAuthRequired

public boolean isSurrogateAuthRequired()

getManagementUrl
```
public String getManagementUrl()
```

getRootUrl
```
public String getRootUrl()
```

getBaseUrl
```
public String getBaseUrl()
```

isBearerOnly
```
public boolean isBearerOnly()
```

isConsentRequired
```
public boolean isConsentRequired()
```

isStandardFlowEnabled

public boolean isStandardFlowEnabled()

isImplicitFlowEnabled

public boolean isImplicitFlowEnabled()

isDirectAccessGrantsEnabled

public boolean isDirectAccessGrantsEnabled()

isServiceAccountsEnabled

public boolean isServiceAccountsEnabled()

getNodeReRegistrationTimeout

public int getNodeReRegistrationTimeout()

getRegisteredNodes

public Map<String,Integer> getRegisteredNodes()

getDefaultClientScopesIds

public List<String> getDefaultClientScopesIds()

getOptionalClientScopesIds

public List<String> getOptionalClientScopesIds()

getAuthFlowBindings

public Map<String,String> getAuthFlowBindings()

Class CachedClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.keycloak.models.cache.infinispan.entities.AbstractRevisioned

Methods inherited from class java.lang.Object

Methods inherited from interface org.keycloak.models.cache.infinispan.entities.Revisioned

Field Detail

clientId

name

description

realm

redirectUris

enabled

alwaysDisplayInConsole

clientAuthenticatorType

secret

registrationToken

protocol

attributes

authFlowBindings

publicClient

fullScopeAllowed

frontchannelLogout

notBefore

scope

webOrigins

protocolMappers

surrogateAuthRequired

managementUrl

rootUrl

baseUrl

bearerOnly

consentRequired

standardFlowEnabled

implicitFlowEnabled

directAccessGrantsEnabled

serviceAccountsEnabled

nodeReRegistrationTimeout

registeredNodes

defaultClientScopesIds

optionalClientScopesIds

Constructor Detail

CachedClient

Method Detail

getClientId

getName

getDescription

setDescription

getRealm

getRedirectUris

isEnabled

isAlwaysDisplayInConsole

getClientAuthenticatorType

getSecret

getRegistrationToken

isPublicClient

getNotBefore

getScope

getWebOrigins

isFullScopeAllowed

getProtocol

getAttributes

isFrontchannelLogout

getProtocolMappers

isSurrogateAuthRequired

getManagementUrl

getRootUrl

getBaseUrl

isBearerOnly

isConsentRequired

isStandardFlowEnabled

isImplicitFlowEnabled

isDirectAccessGrantsEnabled

isServiceAccountsEnabled

getNodeReRegistrationTimeout

getRegisteredNodes

getDefaultClientScopesIds

getOptionalClientScopesIds

getAuthFlowBindings