RealmEntity (Keycloak Model JPA 1.3.0.Final API)

java.lang.Object
- org.keycloak.models.jpa.entities.RealmEntity

@Entity
public class RealmEntity
extends Object

Version:: $Revision: 1 $
Author:: Bill Burke

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`accessCodeLifespan`
`protected int`	`accessCodeLifespanLogin`
`protected int`	`accessCodeLifespanUserAction`
`protected int`	`accessTokenLifespan`
`protected String`	`accountTheme`
`protected boolean`	`adminEventsDetailsEnabled`
`protected boolean`	`adminEventsEnabled`
`protected String`	`adminTheme`
`protected String`	`certificatePem`
`protected String`	`codeSecret`
`protected String`	`defaultLocale`
`protected Set<String>`	`defaultRequiredActions`
`protected Collection<RoleEntity>`	`defaultRoles`
`protected boolean`	`editUsernameAllowed`
`protected String`	`emailTheme`
`protected boolean`	`enabled`
`protected Set<String>`	`enabledEventTypes`
`protected boolean`	`eventsEnabled`
`protected long`	`eventsExpiration`
`protected Set<String>`	`eventsListeners`
`protected String`	`id`
`protected List<IdentityProviderEntity>`	`identityProviders`
`protected boolean`	`internationalizationEnabled`
`protected String`	`loginTheme`
`protected ClientEntity`	`masterAdminClient`
`protected String`	`name`
`protected int`	`notBefore`
`protected String`	`passwordPolicy`
`protected String`	`privateKeyPem`
`protected String`	`publicKeyPem`
`protected boolean`	`registrationAllowed`
`protected boolean`	`registrationEmailAsUsername`
`protected boolean`	`rememberMe`
`protected boolean`	`resetPasswordAllowed`
`protected Map<String,String>`	`smtpConfig`
`protected String`	`sslRequired`
`protected Set<String>`	`supportedLocales`
`protected boolean`	`verifyEmail`

Constructor Summary

Constructors
Constructor and Description

RealmEntity()

Constructors
Constructor and Description
`RealmEntity()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addIdentityProvider(IdentityProviderEntity entity)`
`void`	`addRole(RoleEntity role)`
`int`	`getAccessCodeLifespan()`
`int`	`getAccessCodeLifespanLogin()`
`int`	`getAccessCodeLifespanUserAction()`
`int`	`getAccessTokenLifespan()`
`String`	`getAccountTheme()`
`String`	`getAdminTheme()`
`Collection<RealmAttributeEntity>`	`getAttributes()`
`Collection<AuthenticationFlowEntity>`	`getAuthenticationFlows()`
`Collection<AuthenticatorEntity>`	`getAuthenticators()`
`String`	`getCertificatePem()`
`Collection<ClientEntity>`	`getClients()`
`String`	`getCodeSecret()`
`String`	`getDefaultLocale()`
`Set<String>`	`getDefaultRequiredActions()`
`Collection<RoleEntity>`	`getDefaultRoles()`
`String`	`getEmailTheme()`
`Set<String>`	`getEnabledEventTypes()`
`long`	`getEventsExpiration()`
`Set<String>`	`getEventsListeners()`
`String`	`getId()`
`Collection<IdentityProviderMapperEntity>`	`getIdentityProviderMappers()`
`List<IdentityProviderEntity>`	`getIdentityProviders()`
`String`	`getLoginTheme()`
`ClientEntity`	`getMasterAdminClient()`
`String`	`getName()`
`int`	`getNotBefore()`
`String`	`getPasswordPolicy()`
`String`	`getPrivateKeyPem()`
`String`	`getPublicKeyPem()`
`Collection<RequiredCredentialEntity>`	`getRequiredCredentials()`
`Collection<RoleEntity>`	`getRoles()`
`Map<String,String>`	`getSmtpConfig()`
`String`	`getSslRequired()`
`int`	`getSsoSessionIdleTimeout()`
`int`	`getSsoSessionMaxLifespan()`
`Set<String>`	`getSupportedLocales()`
`Collection<UserFederationMapperEntity>`	`getUserFederationMappers()`
`List<UserFederationProviderEntity>`	`getUserFederationProviders()`
`boolean`	`isAdminEventsDetailsEnabled()`
`boolean`	`isAdminEventsEnabled()`
`boolean`	`isEditUsernameAllowed()`
`boolean`	`isEnabled()`
`boolean`	`isEventsEnabled()`
`boolean`	`isInternationalizationEnabled()`
`boolean`	`isRegistrationAllowed()`
`boolean`	`isRegistrationEmailAsUsername()`
`boolean`	`isRememberMe()`
`boolean`	`isResetPasswordAllowed()`
`boolean`	`isVerifyEmail()`
`void`	`setAccessCodeLifespan(int accessCodeLifespan)`
`void`	`setAccessCodeLifespanLogin(int accessCodeLifespanLogin)`
`void`	`setAccessCodeLifespanUserAction(int accessCodeLifespanUserAction)`
`void`	`setAccessTokenLifespan(int accessTokenLifespan)`
`void`	`setAccountTheme(String theme)`
`void`	`setAdminEventsDetailsEnabled(boolean adminEventsDetailsEnabled)`
`void`	`setAdminEventsEnabled(boolean adminEventsEnabled)`
`void`	`setAdminTheme(String adminTheme)`
`void`	`setAttributes(Collection<RealmAttributeEntity> attributes)`
`void`	`setAuthenticationFlows(Collection<AuthenticationFlowEntity> authenticationFlows)`
`void`	`setAuthenticators(Collection<AuthenticatorEntity> authenticators)`
`void`	`setCertificatePem(String certificatePem)`
`void`	`setClients(Collection<ClientEntity> clients)`
`void`	`setCodeSecret(String codeSecret)`
`void`	`setDefaultLocale(String defaultLocale)`
`void`	`setDefaultRequiredActions(Set<String> defaultRequiredActions)`
`void`	`setDefaultRoles(Collection<RoleEntity> defaultRoles)`
`void`	`setEditUsernameAllowed(boolean editUsernameAllowed)`
`void`	`setEmailTheme(String emailTheme)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabledEventTypes(Set<String> enabledEventTypes)`
`void`	`setEventsEnabled(boolean eventsEnabled)`
`void`	`setEventsExpiration(long eventsExpiration)`
`void`	`setEventsListeners(Set<String> eventsListeners)`
`void`	`setId(String id)`
`void`	`setIdentityProviderMappers(Collection<IdentityProviderMapperEntity> identityProviderMappers)`
`void`	`setIdentityProviders(List<IdentityProviderEntity> identityProviders)`
`void`	`setInternationalizationEnabled(boolean internationalizationEnabled)`
`void`	`setLoginTheme(String theme)`
`void`	`setMasterAdminClient(ClientEntity masterAdminClient)`
`void`	`setName(String name)`
`void`	`setNotBefore(int notBefore)`
`void`	`setPasswordPolicy(String passwordPolicy)`
`void`	`setPrivateKeyPem(String privateKeyPem)`
`void`	`setPublicKeyPem(String publicKeyPem)`
`void`	`setRegistrationAllowed(boolean registrationAllowed)`
`void`	`setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)`
`void`	`setRememberMe(boolean rememberMe)`
`void`	`setRequiredCredentials(Collection<RequiredCredentialEntity> requiredCredentials)`
`void`	`setResetPasswordAllowed(boolean resetPasswordAllowed)`
`void`	`setRoles(Collection<RoleEntity> roles)`
`void`	`setSmtpConfig(Map<String,String> smtpConfig)`
`void`	`setSslRequired(String sslRequired)`
`void`	`setSsoSessionIdleTimeout(int ssoSessionIdleTimeout)`
`void`	`setSsoSessionMaxLifespan(int ssoSessionMaxLifespan)`
`void`	`setSupportedLocales(Set<String> supportedLocales)`
`void`	`setUserFederationMappers(Collection<UserFederationMapperEntity> userFederationMappers)`
`void`	`setUserFederationProviders(List<UserFederationProviderEntity> userFederationProviders)`
`void`	`setVerifyEmail(boolean verifyEmail)`

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

Field Detail

id
```
protected String id
```

name
```
protected String name
```

enabled
```
protected boolean enabled
```

sslRequired
```
protected String sslRequired
```

registrationAllowed
```
protected boolean registrationAllowed
```

registrationEmailAsUsername

protected boolean registrationEmailAsUsername

verifyEmail
```
protected boolean verifyEmail
```

resetPasswordAllowed
```
protected boolean resetPasswordAllowed
```

rememberMe
```
protected boolean rememberMe
```

passwordPolicy
```
protected String passwordPolicy
```

editUsernameAllowed
```
protected boolean editUsernameAllowed
```

accessTokenLifespan
```
protected int accessTokenLifespan
```

accessCodeLifespan
```
protected int accessCodeLifespan
```

accessCodeLifespanUserAction

protected int accessCodeLifespanUserAction

accessCodeLifespanLogin
```
protected int accessCodeLifespanLogin
```

notBefore
```
protected int notBefore
```

publicKeyPem
```
protected String publicKeyPem
```

privateKeyPem
```
protected String privateKeyPem
```

certificatePem
```
protected String certificatePem
```

codeSecret
```
protected String codeSecret
```

loginTheme
```
protected String loginTheme
```

accountTheme
```
protected String accountTheme
```

adminTheme
```
protected String adminTheme
```

emailTheme
```
protected String emailTheme
```

defaultRequiredActions

protected Set<String> defaultRequiredActions

smtpConfig

protected Map<String,String> smtpConfig

defaultRoles

protected Collection<RoleEntity> defaultRoles

eventsEnabled
```
protected boolean eventsEnabled
```

eventsExpiration
```
protected long eventsExpiration
```

eventsListeners
```
protected Set<String> eventsListeners
```

enabledEventTypes

protected Set<String> enabledEventTypes

adminEventsEnabled
```
protected boolean adminEventsEnabled
```

adminEventsDetailsEnabled

protected boolean adminEventsDetailsEnabled

masterAdminClient

protected ClientEntity masterAdminClient

identityProviders

protected List<IdentityProviderEntity> identityProviders

internationalizationEnabled

protected boolean internationalizationEnabled

supportedLocales
```
protected Set<String> supportedLocales
```

defaultLocale
```
protected String defaultLocale
```

Constructor Detail
- RealmEntity
```
public RealmEntity()
```

Method Detail

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

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

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

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

setEnabled

public void setEnabled(boolean enabled)

getSslRequired
```
public String getSslRequired()
```

setSslRequired

public void setSslRequired(String sslRequired)

isRegistrationAllowed

public boolean isRegistrationAllowed()

setRegistrationAllowed

public void setRegistrationAllowed(boolean registrationAllowed)

isRegistrationEmailAsUsername

public boolean isRegistrationEmailAsUsername()

setRegistrationEmailAsUsername

public void setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)

isRememberMe
```
public boolean isRememberMe()
```

setRememberMe

public void setRememberMe(boolean rememberMe)

isVerifyEmail
```
public boolean isVerifyEmail()
```

setVerifyEmail

public void setVerifyEmail(boolean verifyEmail)

isResetPasswordAllowed

public boolean isResetPasswordAllowed()

setResetPasswordAllowed

public void setResetPasswordAllowed(boolean resetPasswordAllowed)

isEditUsernameAllowed

public boolean isEditUsernameAllowed()

setEditUsernameAllowed

public void setEditUsernameAllowed(boolean editUsernameAllowed)

getSsoSessionIdleTimeout
```
public int getSsoSessionIdleTimeout()
```

setSsoSessionIdleTimeout

public void setSsoSessionIdleTimeout(int ssoSessionIdleTimeout)

getSsoSessionMaxLifespan
```
public int getSsoSessionMaxLifespan()
```

setSsoSessionMaxLifespan

public void setSsoSessionMaxLifespan(int ssoSessionMaxLifespan)

getAccessTokenLifespan
```
public int getAccessTokenLifespan()
```

setAccessTokenLifespan

public void setAccessTokenLifespan(int accessTokenLifespan)

getAccessCodeLifespan
```
public int getAccessCodeLifespan()
```

setAccessCodeLifespan

public void setAccessCodeLifespan(int accessCodeLifespan)

getAccessCodeLifespanUserAction

public int getAccessCodeLifespanUserAction()

setAccessCodeLifespanUserAction

public void setAccessCodeLifespanUserAction(int accessCodeLifespanUserAction)

getAccessCodeLifespanLogin

public int getAccessCodeLifespanLogin()

setAccessCodeLifespanLogin

public void setAccessCodeLifespanLogin(int accessCodeLifespanLogin)

getPublicKeyPem
```
public String getPublicKeyPem()
```

setPublicKeyPem

public void setPublicKeyPem(String publicKeyPem)

getPrivateKeyPem
```
public String getPrivateKeyPem()
```

setPrivateKeyPem

public void setPrivateKeyPem(String privateKeyPem)

getCodeSecret
```
public String getCodeSecret()
```

setCodeSecret

public void setCodeSecret(String codeSecret)

getRequiredCredentials

public Collection<RequiredCredentialEntity> getRequiredCredentials()

setRequiredCredentials

public void setRequiredCredentials(Collection<RequiredCredentialEntity> requiredCredentials)

getClients

public Collection<ClientEntity> getClients()

setClients

public void setClients(Collection<ClientEntity> clients)

getRoles

public Collection<RoleEntity> getRoles()

setRoles

public void setRoles(Collection<RoleEntity> roles)

addRole
```
public void addRole(RoleEntity role)
```

getSmtpConfig

public Map<String,String> getSmtpConfig()

setSmtpConfig

public void setSmtpConfig(Map<String,String> smtpConfig)

getDefaultRoles

public Collection<RoleEntity> getDefaultRoles()

setDefaultRoles

public void setDefaultRoles(Collection<RoleEntity> defaultRoles)

getPasswordPolicy
```
public String getPasswordPolicy()
```

setPasswordPolicy

public void setPasswordPolicy(String passwordPolicy)

getLoginTheme
```
public String getLoginTheme()
```

setLoginTheme

public void setLoginTheme(String theme)

getAccountTheme
```
public String getAccountTheme()
```

setAccountTheme

public void setAccountTheme(String theme)

getAdminTheme
```
public String getAdminTheme()
```

setAdminTheme

public void setAdminTheme(String adminTheme)

getEmailTheme
```
public String getEmailTheme()
```

setEmailTheme

public void setEmailTheme(String emailTheme)

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

setNotBefore

public void setNotBefore(int notBefore)

isEventsEnabled
```
public boolean isEventsEnabled()
```

setEventsEnabled

public void setEventsEnabled(boolean eventsEnabled)

getEventsExpiration
```
public long getEventsExpiration()
```

setEventsExpiration

public void setEventsExpiration(long eventsExpiration)

getEventsListeners

public Set<String> getEventsListeners()

setEventsListeners

public void setEventsListeners(Set<String> eventsListeners)

getEnabledEventTypes

public Set<String> getEnabledEventTypes()

setEnabledEventTypes

public void setEnabledEventTypes(Set<String> enabledEventTypes)

isAdminEventsEnabled
```
public boolean isAdminEventsEnabled()
```

setAdminEventsEnabled

public void setAdminEventsEnabled(boolean adminEventsEnabled)

isAdminEventsDetailsEnabled

public boolean isAdminEventsDetailsEnabled()

setAdminEventsDetailsEnabled

public void setAdminEventsDetailsEnabled(boolean adminEventsDetailsEnabled)

getMasterAdminClient

public ClientEntity getMasterAdminClient()

setMasterAdminClient

public void setMasterAdminClient(ClientEntity masterAdminClient)

getUserFederationProviders

public List<UserFederationProviderEntity> getUserFederationProviders()

setUserFederationProviders

public void setUserFederationProviders(List<UserFederationProviderEntity> userFederationProviders)

getUserFederationMappers

public Collection<UserFederationMapperEntity> getUserFederationMappers()

setUserFederationMappers

public void setUserFederationMappers(Collection<UserFederationMapperEntity> userFederationMappers)

getAttributes

public Collection<RealmAttributeEntity> getAttributes()

setAttributes

public void setAttributes(Collection<RealmAttributeEntity> attributes)

getCertificatePem
```
public String getCertificatePem()
```

setCertificatePem

public void setCertificatePem(String certificatePem)

getIdentityProviders

public List<IdentityProviderEntity> getIdentityProviders()

setIdentityProviders

public void setIdentityProviders(List<IdentityProviderEntity> identityProviders)

addIdentityProvider

public void addIdentityProvider(IdentityProviderEntity entity)

isInternationalizationEnabled

public boolean isInternationalizationEnabled()

setInternationalizationEnabled

public void setInternationalizationEnabled(boolean internationalizationEnabled)

getSupportedLocales

public Set<String> getSupportedLocales()

setSupportedLocales

public void setSupportedLocales(Set<String> supportedLocales)

getDefaultLocale
```
public String getDefaultLocale()
```

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

getIdentityProviderMappers

public Collection<IdentityProviderMapperEntity> getIdentityProviderMappers()

setIdentityProviderMappers

public void setIdentityProviderMappers(Collection<IdentityProviderMapperEntity> identityProviderMappers)

getAuthenticators

public Collection<AuthenticatorEntity> getAuthenticators()

setAuthenticators

public void setAuthenticators(Collection<AuthenticatorEntity> authenticators)

getAuthenticationFlows

public Collection<AuthenticationFlowEntity> getAuthenticationFlows()

setAuthenticationFlows

public void setAuthenticationFlows(Collection<AuthenticationFlowEntity> authenticationFlows)

getDefaultRequiredActions

public Set<String> getDefaultRequiredActions()

setDefaultRequiredActions

public void setDefaultRequiredActions(Set<String> defaultRequiredActions)

Class RealmEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

enabled

sslRequired

registrationAllowed

registrationEmailAsUsername

verifyEmail

resetPasswordAllowed

rememberMe

passwordPolicy

editUsernameAllowed

accessTokenLifespan

accessCodeLifespan

accessCodeLifespanUserAction

accessCodeLifespanLogin

notBefore

publicKeyPem

privateKeyPem

certificatePem

codeSecret

loginTheme

accountTheme

adminTheme

emailTheme

defaultRequiredActions

smtpConfig

defaultRoles

eventsEnabled

eventsExpiration

eventsListeners

enabledEventTypes

adminEventsEnabled

adminEventsDetailsEnabled

masterAdminClient

identityProviders

internationalizationEnabled

supportedLocales

defaultLocale

Constructor Detail

RealmEntity

Method Detail

getId

setId

getName

setName

isEnabled

setEnabled

getSslRequired

setSslRequired

isRegistrationAllowed

setRegistrationAllowed

isRegistrationEmailAsUsername

setRegistrationEmailAsUsername

isRememberMe

setRememberMe

isVerifyEmail

setVerifyEmail

isResetPasswordAllowed

setResetPasswordAllowed

isEditUsernameAllowed

setEditUsernameAllowed

getSsoSessionIdleTimeout

setSsoSessionIdleTimeout

getSsoSessionMaxLifespan

setSsoSessionMaxLifespan

getAccessTokenLifespan

setAccessTokenLifespan

getAccessCodeLifespan

setAccessCodeLifespan

getAccessCodeLifespanUserAction

setAccessCodeLifespanUserAction

getAccessCodeLifespanLogin

setAccessCodeLifespanLogin

getPublicKeyPem