org.keycloak.models

## Interface RealmModel

- All Superinterfaces:
    RoleContainerModel
  All Known Implementing Classes:
    RealmAdapter, RealmAdapter, RealmAdapter

      public interface RealmModel
      extends RoleContainerModel

  Version:
    $Revision: 1 $
  Author:
    Bill Burke

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `ApplicationModel` | `addApplication(String name)`
    `ApplicationModel` | `addApplication(String id, String name)`
    `void` | `addDefaultRole(String name)`
    `OAuthClientModel` | `addOAuthClient(String name)`
    `OAuthClientModel` | `addOAuthClient(String id, String name)`
    `void` | `addRequiredCredential(String cred)`
    `UserFederationProviderModel` | `addUserFederationProvider(String providerName, Map<String,String> config, int priority, String displayName, int fullSyncPeriod, int changedSyncPeriod, int lastSync)`
    `ClientModel` | `findClient(String clientId)`
    `ClientModel` | `findClientById(String id)`
    `int` | `getAccessCodeLifespan()`
    `int` | `getAccessCodeLifespanUserAction()`
    `int` | `getAccessTokenLifespan()`
    `String` | `getAccountTheme()`
    `String` | `getAdminTheme()`
    `ApplicationModel` | `getApplicationById(String id)`
    `ApplicationModel` | `getApplicationByName(String name)`
    `Map<String,ApplicationModel>` | `getApplicationNameMap()`
    `List<ApplicationModel>` | `getApplications()`
    `Map<String,String>` | `getBrowserSecurityHeaders()`
    `X509Certificate` | `getCertificate()`
    `String` | `getCertificatePem()`
    `String` | `getCodeSecret()`
    `List<String>` | `getDefaultRoles()`
    `String` | `getEmailTheme()`
    `long` | `getEventsExpiration()`
    `Set<String>` | `getEventsListeners()`
    `int` | `getFailureFactor()`
    `String` | `getId()`
    `String` | `getLoginTheme()`
    `ApplicationModel` | `getMasterAdminApp()`
    `int` | `getMaxDeltaTimeSeconds()`
    `int` | `getMaxFailureWaitSeconds()`
    `int` | `getMinimumQuickLoginWaitSeconds()`
    `String` | `getName()`
    `int` | `getNotBefore()` Time in seconds since epoc
    `OAuthClientModel` | `getOAuthClient(String name)`
    `OAuthClientModel` | `getOAuthClientById(String id)`
    `List<OAuthClientModel>` | `getOAuthClients()`
    `PasswordPolicy` | `getPasswordPolicy()`
    `PrivateKey` | `getPrivateKey()`
    `String` | `getPrivateKeyPem()`
    `PublicKey` | `getPublicKey()`
    `String` | `getPublicKeyPem()`
    `long` | `getQuickLoginCheckMilliSeconds()`
    `List<RequiredCredentialModel>` | `getRequiredCredentials()`
    `RoleModel` | `getRoleById(String id)`
    `Map<String,String>` | `getSmtpConfig()`
    `Map<String,String>` | `getSocialConfig()`
    `SslRequired` | `getSslRequired()`
    `int` | `getSsoSessionIdleTimeout()`
    `int` | `getSsoSessionMaxLifespan()`
    `List<UserFederationProviderModel>` | `getUserFederationProviders()`
    `int` | `getWaitIncrementSeconds()`
    `boolean` | `isBruteForceProtected()`
    `boolean` | `isEnabled()`
    `boolean` | `isEventsEnabled()`
    `boolean` | `isPasswordCredentialGrantAllowed()`
    `boolean` | `isRegistrationAllowed()`
    `boolean` | `isRememberMe()`
    `boolean` | `isResetPasswordAllowed()`
    `boolean` | `isSocial()`
    `boolean` | `isUpdateProfileOnInitialSocialLogin()`
    `boolean` | `isVerifyEmail()`
    `boolean` | `removeApplication(String id)`
    `boolean` | `removeOAuthClient(String id)`
    `boolean` | `removeRoleById(String id)`
    `void` | `removeUserFederationProvider(UserFederationProviderModel provider)`
    `void` | `setAccessCodeLifespan(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` | `setEmailTheme(String name)`
    `void` | `setEnabled(boolean enabled)`
    `void` | `setEventsEnabled(boolean enabled)`
    `void` | `setEventsExpiration(long expiration)`
    `void` | `setEventsListeners(Set<String> listeners)`
    `void` | `setFailureFactor(int failureFactor)`
    `void` | `setLoginTheme(String name)`
    `void` | `setMasterAdminApp(ApplicationModel app)`
    `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` | `setRememberMe(boolean rememberMe)`
    `void` | `setResetPasswordAllowed(boolean resetPasswordAllowed)`
    `void` | `setSmtpConfig(Map<String,String> smtpConfig)`
    `void` | `setSocial(boolean social)`
    `void` | `setSocialConfig(Map<String,String> socialConfig)`
    `void` | `setSslRequired(SslRequired sslRequired)`
    `void` | `setSsoSessionIdleTimeout(int seconds)`
    `void` | `setSsoSessionMaxLifespan(int seconds)`
    `void` | `setUpdateProfileOnInitialSocialLogin(boolean updateProfileOnInitialSocialLogin)`
    `void` | `setUserFederationProviders(List<UserFederationProviderModel> providers)`
    `void` | `setVerifyEmail(boolean verifyEmail)`
    `void` | `setWaitIncrementSeconds(int val)`
    `void` | `updateDefaultRoles(String[] defaultRoles)`
    `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)

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

    - #### 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()

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

    - #### findClient

          ClientModel findClient(String clientId)

    - #### getApplicationNameMap

          Map<String,ApplicationModel> getApplicationNameMap()

    - #### getApplications

          List<ApplicationModel> getApplications()

    - #### addApplication

          ApplicationModel addApplication(String name)

    - #### addApplication

          ApplicationModel addApplication(String id,
                                        String name)

    - #### removeApplication

          boolean removeApplication(String id)

    - #### getApplicationById

          ApplicationModel getApplicationById(String id)

    - #### getApplicationByName

          ApplicationModel getApplicationByName(String name)

    - #### updateRequiredCredentials

          void updateRequiredCredentials(Set<String> creds)

    - #### isSocial

          boolean isSocial()

    - #### setSocial

          void setSocial(boolean social)

    - #### isUpdateProfileOnInitialSocialLogin

          boolean isUpdateProfileOnInitialSocialLogin()

    - #### setUpdateProfileOnInitialSocialLogin

          void setUpdateProfileOnInitialSocialLogin(boolean updateProfileOnInitialSocialLogin)

    - #### addOAuthClient

          OAuthClientModel addOAuthClient(String name)

    - #### addOAuthClient

          OAuthClientModel addOAuthClient(String id,
                                        String name)

    - #### getOAuthClient

          OAuthClientModel getOAuthClient(String name)

    - #### getOAuthClientById

          OAuthClientModel getOAuthClientById(String id)

    - #### removeOAuthClient

          boolean removeOAuthClient(String id)

    - #### getOAuthClients

          List<OAuthClientModel> getOAuthClients()

    - #### getBrowserSecurityHeaders

          Map<String,String> getBrowserSecurityHeaders()

    - #### setBrowserSecurityHeaders

          void setBrowserSecurityHeaders(Map<String,String> headers)

    - #### getSmtpConfig

          Map<String,String> getSmtpConfig()

    - #### setSmtpConfig

          void setSmtpConfig(Map<String,String> smtpConfig)

    - #### getSocialConfig

          Map<String,String> getSocialConfig()

    - #### setSocialConfig

          void setSocialConfig(Map<String,String> socialConfig)

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

    - #### getMasterAdminApp

          ApplicationModel getMasterAdminApp()

    - #### setMasterAdminApp

          void setMasterAdminApp(ApplicationModel app)

    - #### findClientById

          ClientModel findClientById(String id)

Copyright © 2014. All Rights Reserved.