RealmModel (Keycloak Model API 1.2.0.Final API)

All Superinterfaces:

RoleContainerModel
```
public interface RealmModel
extends RoleContainerModel
```
Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface RealmModel.ClientCreationEvent

static interface RealmModel.RealmCreationEvent

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`RealmModel.ClientCreationEvent`
`static interface`	`RealmModel.RealmCreationEvent`

Method Summary

Methods
Modifier and Type	Method and Description
`ClientModel`	`addClient(String name)`
`ClientModel`	`addClient(String id, String clientId)`
`void`	`addDefaultRole(String name)`
`void`	`addIdentityProvider(IdentityProviderModel identityProvider)`
`IdentityProviderMapperModel`	`addIdentityProviderMapper(IdentityProviderMapperModel model)`
`void`	`addRequiredCredential(String cred)`
`UserFederationProviderModel`	`addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`
`int`	`getAccessCodeLifespan()`
`int`	`getAccessCodeLifespanLogin()`
`int`	`getAccessCodeLifespanUserAction()`
`int`	`getAccessTokenLifespan()`
`String`	`getAccountTheme()`
`String`	`getAdminTheme()`
`Map<String,String>`	`getBrowserSecurityHeaders()`
`X509Certificate`	`getCertificate()`
`String`	`getCertificatePem()`
`ClientModel`	`getClientByClientId(String clientId)`
`ClientModel`	`getClientById(String id)`
`Map<String,ClientModel>`	`getClientNameMap()`
`List<ClientModel>`	`getClients()`
`String`	`getCodeSecret()`
`Key`	`getCodeSecretKey()`
`String`	`getDefaultLocale()`
`List<String>`	`getDefaultRoles()`
`String`	`getEmailTheme()`
`Set<String>`	`getEnabledEventTypes()`
`long`	`getEventsExpiration()`
`Set<String>`	`getEventsListeners()`
`int`	`getFailureFactor()`
`String`	`getId()`
`IdentityProviderModel`	`getIdentityProviderByAlias(String alias)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperById(String id)`
`IdentityProviderMapperModel`	`getIdentityProviderMapperByName(String brokerAlias, String name)`
`Set<IdentityProviderMapperModel>`	`getIdentityProviderMappers()`
`Set<IdentityProviderMapperModel>`	`getIdentityProviderMappersByAlias(String brokerAlias)`
`List<IdentityProviderModel>`	`getIdentityProviders()`
`String`	`getLoginTheme()`
`ClientModel`	`getMasterAdminClient()`
`int`	`getMaxDeltaTimeSeconds()`
`int`	`getMaxFailureWaitSeconds()`
`int`	`getMinimumQuickLoginWaitSeconds()`
`String`	`getName()`
`int`	`getNotBefore()` Time in seconds since epoc
`PasswordPolicy`	`getPasswordPolicy()`
`PrivateKey`	`getPrivateKey()`
`String`	`getPrivateKeyPem()`
`PublicKey`	`getPublicKey()`
`String`	`getPublicKeyPem()`
`long`	`getQuickLoginCheckMilliSeconds()`
`List<RequiredCredentialModel>`	`getRequiredCredentials()`
`RoleModel`	`getRoleById(String id)`
`Map<String,String>`	`getSmtpConfig()`
`SslRequired`	`getSslRequired()`
`int`	`getSsoSessionIdleTimeout()`
`int`	`getSsoSessionMaxLifespan()`
`Set<String>`	`getSupportedLocales()`
`List<UserFederationProviderModel>`	`getUserFederationProviders()`
`int`	`getWaitIncrementSeconds()`
`boolean`	`isBruteForceProtected()`
`boolean`	`isEnabled()`
`boolean`	`isEventsEnabled()`
`boolean`	`isIdentityFederationEnabled()`
`boolean`	`isInternationalizationEnabled()`
`boolean`	`isPasswordCredentialGrantAllowed()`
`boolean`	`isRegistrationAllowed()`
`boolean`	`isRegistrationEmailAsUsername()`
`boolean`	`isRememberMe()`
`boolean`	`isResetPasswordAllowed()`
`boolean`	`isVerifyEmail()`
`boolean`	`removeClient(String id)`
`void`	`removeIdentityProviderByAlias(String alias)`
`void`	`removeIdentityProviderMapper(IdentityProviderMapperModel mapping)`
`boolean`	`removeRoleById(String id)`
`void`	`removeUserFederationProvider(UserFederationProviderModel provider)`
`void`	`setAccessCodeLifespan(int seconds)`
`void`	`setAccessCodeLifespanLogin(int seconds)`
`void`	`setAccessCodeLifespanUserAction(int seconds)`
`void`	`setAccessTokenLifespan(int seconds)`
`void`	`setAccountTheme(String name)`
`void`	`setAdminTheme(String name)`
`void`	`setBrowserSecurityHeaders(Map<String,String> headers)`
`void`	`setBruteForceProtected(boolean value)`
`void`	`setCertificate(X509Certificate certificate)`
`void`	`setCertificatePem(String certificate)`
`void`	`setCodeSecret(String codeSecret)`
`void`	`setDefaultLocale(String locale)`
`void`	`setEmailTheme(String name)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabledEventTypes(Set<String> enabledEventTypes)`
`void`	`setEventsEnabled(boolean enabled)`
`void`	`setEventsExpiration(long expiration)`
`void`	`setEventsListeners(Set<String> listeners)`
`void`	`setFailureFactor(int failureFactor)`
`void`	`setInternationalizationEnabled(boolean enabled)`
`void`	`setLoginTheme(String name)`
`void`	`setMasterAdminClient(ClientModel client)`
`void`	`setMaxDeltaTimeSeconds(int val)`
`void`	`setMaxFailureWaitSeconds(int val)`
`void`	`setMinimumQuickLoginWaitSeconds(int val)`
`void`	`setName(String name)`
`void`	`setNotBefore(int notBefore)`
`void`	`setPasswordCredentialGrantAllowed(boolean passwordCredentialGrantAllowed)`
`void`	`setPasswordPolicy(PasswordPolicy policy)`
`void`	`setPrivateKey(PrivateKey privateKey)`
`void`	`setPrivateKeyPem(String privateKeyPem)`
`void`	`setPublicKey(PublicKey publicKey)`
`void`	`setPublicKeyPem(String publicKeyPem)`
`void`	`setQuickLoginCheckMilliSeconds(long val)`
`void`	`setRegistrationAllowed(boolean registrationAllowed)`
`void`	`setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)`
`void`	`setRememberMe(boolean rememberMe)`
`void`	`setResetPasswordAllowed(boolean resetPasswordAllowed)`
`void`	`setSmtpConfig(Map<String,String> smtpConfig)`
`void`	`setSslRequired(SslRequired sslRequired)`
`void`	`setSsoSessionIdleTimeout(int seconds)`
`void`	`setSsoSessionMaxLifespan(int seconds)`
`void`	`setSupportedLocales(Set<String> locales)`
`void`	`setUserFederationProviders(List<UserFederationProviderModel> providers)`
`void`	`setVerifyEmail(boolean verifyEmail)`
`void`	`setWaitIncrementSeconds(int val)`
`void`	`updateDefaultRoles(String[] defaultRoles)`
`void`	`updateIdentityProvider(IdentityProviderModel identityProvider)`
`void`	`updateIdentityProviderMapper(IdentityProviderMapperModel mapping)`
`void`	`updateRequiredCredentials(Set<String> creds)`
`void`	`updateUserFederationProvider(UserFederationProviderModel provider)`

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

Method Detail

getId
```
String getId()
```

getName
```
String getName()
```

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

isEnabled
```
boolean isEnabled()
```

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

getSslRequired
```
SslRequired getSslRequired()
```

setSslRequired

void setSslRequired(SslRequired sslRequired)

isRegistrationAllowed
```
boolean isRegistrationAllowed()
```

setRegistrationAllowed

void setRegistrationAllowed(boolean registrationAllowed)

isRegistrationEmailAsUsername

boolean isRegistrationEmailAsUsername()

setRegistrationEmailAsUsername

void setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)

isPasswordCredentialGrantAllowed

boolean isPasswordCredentialGrantAllowed()

setPasswordCredentialGrantAllowed

void setPasswordCredentialGrantAllowed(boolean passwordCredentialGrantAllowed)

isRememberMe
```
boolean isRememberMe()
```

setRememberMe

void setRememberMe(boolean rememberMe)

isBruteForceProtected
```
boolean isBruteForceProtected()
```

setBruteForceProtected

void setBruteForceProtected(boolean value)

getMaxFailureWaitSeconds
```
int getMaxFailureWaitSeconds()
```

setMaxFailureWaitSeconds

void setMaxFailureWaitSeconds(int val)

getWaitIncrementSeconds
```
int getWaitIncrementSeconds()
```

setWaitIncrementSeconds
```
void setWaitIncrementSeconds(int val)
```

getMinimumQuickLoginWaitSeconds
```
int getMinimumQuickLoginWaitSeconds()
```

setMinimumQuickLoginWaitSeconds

void setMinimumQuickLoginWaitSeconds(int val)

getQuickLoginCheckMilliSeconds
```
long getQuickLoginCheckMilliSeconds()
```

setQuickLoginCheckMilliSeconds

void setQuickLoginCheckMilliSeconds(long val)

getMaxDeltaTimeSeconds
```
int getMaxDeltaTimeSeconds()
```

setMaxDeltaTimeSeconds
```
void setMaxDeltaTimeSeconds(int val)
```

getFailureFactor
```
int getFailureFactor()
```

setFailureFactor

void setFailureFactor(int failureFactor)

isVerifyEmail
```
boolean isVerifyEmail()
```

setVerifyEmail

void setVerifyEmail(boolean verifyEmail)

isResetPasswordAllowed
```
boolean isResetPasswordAllowed()
```

setResetPasswordAllowed

void setResetPasswordAllowed(boolean resetPasswordAllowed)

getSsoSessionIdleTimeout
```
int getSsoSessionIdleTimeout()
```

setSsoSessionIdleTimeout

void setSsoSessionIdleTimeout(int seconds)

getSsoSessionMaxLifespan
```
int getSsoSessionMaxLifespan()
```

setSsoSessionMaxLifespan

void setSsoSessionMaxLifespan(int seconds)

getAccessTokenLifespan
```
int getAccessTokenLifespan()
```

setAccessTokenLifespan

void setAccessTokenLifespan(int seconds)

getAccessCodeLifespan
```
int getAccessCodeLifespan()
```

setAccessCodeLifespan

void setAccessCodeLifespan(int seconds)

getAccessCodeLifespanUserAction
```
int getAccessCodeLifespanUserAction()
```

setAccessCodeLifespanUserAction

void setAccessCodeLifespanUserAction(int seconds)

getAccessCodeLifespanLogin
```
int getAccessCodeLifespanLogin()
```

setAccessCodeLifespanLogin

void setAccessCodeLifespanLogin(int seconds)

getPublicKeyPem
```
String getPublicKeyPem()
```

setPublicKeyPem

void setPublicKeyPem(String publicKeyPem)

getPrivateKeyPem
```
String getPrivateKeyPem()
```

setPrivateKeyPem

void setPrivateKeyPem(String privateKeyPem)

getPublicKey
```
PublicKey getPublicKey()
```

setPublicKey

void setPublicKey(PublicKey publicKey)

getCodeSecret
```
String getCodeSecret()
```

getCodeSecretKey
```
Key getCodeSecretKey()
```

setCodeSecret
```
void setCodeSecret(String codeSecret)
```

getCertificate
```
X509Certificate getCertificate()
```

setCertificate

void setCertificate(X509Certificate certificate)

getCertificatePem
```
String getCertificatePem()
```

setCertificatePem

void setCertificatePem(String certificate)

getPrivateKey
```
PrivateKey getPrivateKey()
```

setPrivateKey

void setPrivateKey(PrivateKey privateKey)

getRequiredCredentials

List<RequiredCredentialModel> getRequiredCredentials()

addRequiredCredential

void addRequiredCredential(String cred)

getPasswordPolicy
```
PasswordPolicy getPasswordPolicy()
```

setPasswordPolicy

void setPasswordPolicy(PasswordPolicy policy)

getRoleById
```
RoleModel getRoleById(String id)
```

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

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

updateDefaultRoles

void updateDefaultRoles(String[] defaultRoles)

getClientNameMap

Map<String,ClientModel> getClientNameMap()

getClients
```
List<ClientModel> getClients()
```

addClient
```
ClientModel addClient(String name)
```

addClient

ClientModel addClient(String id,
                    String clientId)

removeClient
```
boolean removeClient(String id)
```

getClientById
```
ClientModel getClientById(String id)
```

getClientByClientId

ClientModel getClientByClientId(String clientId)

updateRequiredCredentials

void updateRequiredCredentials(Set<String> creds)

getBrowserSecurityHeaders

Map<String,String> getBrowserSecurityHeaders()

setBrowserSecurityHeaders

void setBrowserSecurityHeaders(Map<String,String> headers)

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

setSmtpConfig

void setSmtpConfig(Map<String,String> smtpConfig)

getIdentityProviders

List<IdentityProviderModel> getIdentityProviders()

getIdentityProviderByAlias

IdentityProviderModel getIdentityProviderByAlias(String alias)

addIdentityProvider

void addIdentityProvider(IdentityProviderModel identityProvider)

removeIdentityProviderByAlias

void removeIdentityProviderByAlias(String alias)

updateIdentityProvider

void updateIdentityProvider(IdentityProviderModel identityProvider)

getIdentityProviderMappers

Set<IdentityProviderMapperModel> getIdentityProviderMappers()

getIdentityProviderMappersByAlias

Set<IdentityProviderMapperModel> getIdentityProviderMappersByAlias(String brokerAlias)

addIdentityProviderMapper

IdentityProviderMapperModel addIdentityProviderMapper(IdentityProviderMapperModel model)

removeIdentityProviderMapper

void removeIdentityProviderMapper(IdentityProviderMapperModel mapping)

updateIdentityProviderMapper

void updateIdentityProviderMapper(IdentityProviderMapperModel mapping)

getIdentityProviderMapperById

IdentityProviderMapperModel getIdentityProviderMapperById(String id)

getIdentityProviderMapperByName

IdentityProviderMapperModel getIdentityProviderMapperByName(String brokerAlias,
                                                          String name)

getUserFederationProviders

List<UserFederationProviderModel> getUserFederationProviders()

addUserFederationProvider

UserFederationProviderModel addUserFederationProvider(String providerName,
                                                    Map<String,String> config,
                                                    int priority,
                                                    String displayName,
                                                    int fullSyncPeriod,
                                                    int changedSyncPeriod,
                                                    int lastSync)

updateUserFederationProvider

void updateUserFederationProvider(UserFederationProviderModel provider)

removeUserFederationProvider

void removeUserFederationProvider(UserFederationProviderModel provider)

setUserFederationProviders

void setUserFederationProviders(List<UserFederationProviderModel> providers)

getLoginTheme
```
String getLoginTheme()
```

setLoginTheme
```
void setLoginTheme(String name)
```

getAccountTheme
```
String getAccountTheme()
```

setAccountTheme
```
void setAccountTheme(String name)
```

getAdminTheme
```
String getAdminTheme()
```

setAdminTheme
```
void setAdminTheme(String name)
```

getEmailTheme
```
String getEmailTheme()
```

setEmailTheme
```
void setEmailTheme(String name)
```

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

Returns:

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

removeRoleById
```
boolean removeRoleById(String id)
```

isEventsEnabled
```
boolean isEventsEnabled()
```

setEventsEnabled

void setEventsEnabled(boolean enabled)

getEventsExpiration
```
long getEventsExpiration()
```

setEventsExpiration

void setEventsExpiration(long expiration)

getEventsListeners
```
Set<String> getEventsListeners()
```

setEventsListeners

void setEventsListeners(Set<String> listeners)

getEnabledEventTypes
```
Set<String> getEnabledEventTypes()
```

setEnabledEventTypes

void setEnabledEventTypes(Set<String> enabledEventTypes)

getMasterAdminClient
```
ClientModel getMasterAdminClient()
```

setMasterAdminClient

void setMasterAdminClient(ClientModel client)

isIdentityFederationEnabled
```
boolean isIdentityFederationEnabled()
```

isInternationalizationEnabled

boolean isInternationalizationEnabled()

setInternationalizationEnabled

void setInternationalizationEnabled(boolean enabled)

getSupportedLocales
```
Set<String> getSupportedLocales()
```

setSupportedLocales

void setSupportedLocales(Set<String> locales)

getDefaultLocale
```
String getDefaultLocale()
```

setDefaultLocale
```
void setDefaultLocale(String locale)
```

Interface RealmModel

Nested Class Summary

Method Summary

Methods inherited from interface org.keycloak.models.RoleContainerModel

Method Detail

getId

getName

setName

isEnabled

setEnabled

getSslRequired

setSslRequired

isRegistrationAllowed

setRegistrationAllowed

isRegistrationEmailAsUsername

setRegistrationEmailAsUsername

isPasswordCredentialGrantAllowed

setPasswordCredentialGrantAllowed

isRememberMe

setRememberMe

isBruteForceProtected

setBruteForceProtected

getMaxFailureWaitSeconds

setMaxFailureWaitSeconds

getWaitIncrementSeconds

setWaitIncrementSeconds

getMinimumQuickLoginWaitSeconds

setMinimumQuickLoginWaitSeconds

getQuickLoginCheckMilliSeconds

setQuickLoginCheckMilliSeconds

getMaxDeltaTimeSeconds

setMaxDeltaTimeSeconds

getFailureFactor

setFailureFactor

isVerifyEmail

setVerifyEmail

isResetPasswordAllowed

setResetPasswordAllowed

getSsoSessionIdleTimeout

setSsoSessionIdleTimeout

getSsoSessionMaxLifespan

setSsoSessionMaxLifespan

getAccessTokenLifespan

setAccessTokenLifespan

getAccessCodeLifespan

setAccessCodeLifespan

getAccessCodeLifespanUserAction

setAccessCodeLifespanUserAction

getAccessCodeLifespanLogin

setAccessCodeLifespanLogin

getPublicKeyPem

setPublicKeyPem

getPrivateKeyPem

setPrivateKeyPem

getPublicKey

setPublicKey

getCodeSecret

getCodeSecretKey

setCodeSecret

getCertificate

setCertificate

getCertificatePem

setCertificatePem

getPrivateKey

setPrivateKey

getRequiredCredentials

addRequiredCredential

getPasswordPolicy

setPasswordPolicy

getRoleById

getDefaultRoles

addDefaultRole

updateDefaultRoles

getClientNameMap

getClients

addClient

addClient

removeClient

getClientById

getClientByClientId