Package org.keycloak.models.utils

Class RealmModelDelegate

java.lang.Object

org.keycloak.models.utils.RealmModelDelegate

All Implemented Interfaces:

RealmModel, RoleContainerModel

public class RealmModelDelegate
extends Object
implements RealmModel

Author:

Alexander Schwartz

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.RealmModel

RealmModel.IdentityProviderRemovedEvent, RealmModel.IdentityProviderUpdatedEvent, RealmModel.RealmCreationEvent, RealmModel.RealmPostCreateEvent, RealmModel.RealmRemovedEvent

Nested classes/interfaces inherited from interface org.keycloak.models.RoleContainerModel

RoleContainerModel.RoleRemovedEvent

Field Summary

Fields inherited from interface org.keycloak.models.RealmModel

COMPARE_BY_NAME

Constructor Summary

Constructors

Constructor	Description
RealmModelDelegate(RealmModel delegate)

Method Summary

Modifier and Type	Method	Description
AuthenticationFlowModel	addAuthenticationFlow(AuthenticationFlowModel model)
AuthenticatorConfigModel	addAuthenticatorConfig(AuthenticatorConfigModel model)
AuthenticationExecutionModel	addAuthenticatorExecution(AuthenticationExecutionModel model)
ClientModel	addClient(String name)
ClientModel	addClient(String id, String clientId)
ClientScopeModel	addClientScope(String name)	Creates new client scope with the given name.
ClientScopeModel	addClientScope(String id, String name)	Creates new client scope with the given internal ID and name.
ComponentModel	addComponentModel(ComponentModel model)	Adds component model.
void	addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)	Adds given client scope among default/optional client scopes of this realm.
void	addDefaultGroup(GroupModel group)
void	addIdentityProvider(IdentityProviderModel identityProvider)
IdentityProviderMapperModel	addIdentityProviderMapper(IdentityProviderMapperModel model)
RequiredActionProviderModel	addRequiredActionProvider(RequiredActionProviderModel model)
void	addRequiredCredential(String cred)
RoleModel	addRole(String name)
RoleModel	addRole(String id, String name)
void	addToDefaultRoles(RoleModel role)	Adds a role as a composite to default role of this realm.
ClientInitialAccessModel	createClientInitialAccessModel(int expiration, int count)
GroupModel	createGroup(String name)
GroupModel	createGroup(String id, String name)
GroupModel	createGroup(String id, String name, GroupModel toParent)
GroupModel	createGroup(String name, GroupModel toParent)
void	createOrUpdateRealmLocalizationTexts(String locale, Map<String,String> localizationTexts)	Creates or updates the realm-specific localization texts for the given locale.
void	decreaseRemainingCount(ClientInitialAccessModel clientInitialAccess)
int	getAccessCodeLifespan()
int	getAccessCodeLifespanLogin()
int	getAccessCodeLifespanUserAction()
int	getAccessTokenLifespan()
int	getAccessTokenLifespanForImplicitFlow()
String	getAccountTheme()
int	getActionTokenGeneratedByAdminLifespan()
int	getActionTokenGeneratedByUserLifespan()
int	getActionTokenGeneratedByUserLifespan(String actionTokenType)
String	getAdminTheme()
Stream<ClientModel>	getAlwaysDisplayInConsoleClientsStream()	Returns clients which are always displayed in the admin console as a stream.
String	getAttribute(String name)
Boolean	getAttribute(String name, Boolean defaultValue)
Integer	getAttribute(String name, Integer defaultValue)
Long	getAttribute(String name, Long defaultValue)
Map<String,String>	getAttributes()
AuthenticationExecutionModel	getAuthenticationExecutionByFlowId(String flowId)
AuthenticationExecutionModel	getAuthenticationExecutionById(String id)
Stream<AuthenticationExecutionModel>	getAuthenticationExecutionsStream(String flowId)	Returns sorted (according to priority) AuthenticationExecutionModel as a stream.
AuthenticationFlowModel	getAuthenticationFlowById(String id)
Stream<AuthenticationFlowModel>	getAuthenticationFlowsStream()	Returns authentications flows as a stream.
AuthenticatorConfigModel	getAuthenticatorConfigByAlias(String alias)
AuthenticatorConfigModel	getAuthenticatorConfigById(String id)
Stream<AuthenticatorConfigModel>	getAuthenticatorConfigsStream()	Returns authentication configs as a stream.
AuthenticationFlowModel	getBrowserFlow()
Map<String,String>	getBrowserSecurityHeaders()
CibaConfig	getCibaPolicy()
AuthenticationFlowModel	getClientAuthenticationFlow()
ClientModel	getClientByClientId(String clientId)
ClientModel	getClientById(String id)
Stream<ClientInitialAccessModel>	getClientInitialAccesses()
ClientInitialAccessModel	getClientInitialAccessModel(String id)
int	getClientOfflineSessionIdleTimeout()
int	getClientOfflineSessionMaxLifespan()
ClientScopeModel	getClientScopeById(String id)
Stream<ClientScopeModel>	getClientScopesStream()	Returns all client scopes of this realm as a stream.
Long	getClientsCount()
int	getClientSessionIdleTimeout()
int	getClientSessionMaxLifespan()
Stream<ClientModel>	getClientsStream()	Returns clients as a stream.
Stream<ClientModel>	getClientsStream(Integer firstResult, Integer maxResults)	Returns clients as a stream.
ComponentModel	getComponent(String id)
Stream<ComponentModel>	getComponentsStream()	Returns stream of component models.
Stream<ComponentModel>	getComponentsStream(String parentId)	Returns stream of ComponentModels for specific parentId.
Stream<ComponentModel>	getComponentsStream(String parentId, String providerType)	Returns stream of ComponentModels for specific parentId and providerType.
Stream<ClientScopeModel>	getDefaultClientScopesStream(boolean defaultScope)	Returns default client scopes of this realm either default ones or optional ones.
Stream<GroupModel>	getDefaultGroupsStream()	Returns default groups as a stream.
String	getDefaultLocale()
RoleModel	getDefaultRole()	Returns default realm role.
String	getDefaultSignatureAlgorithm()
AuthenticationFlowModel	getDirectGrantFlow()
String	getDisplayName()
String	getDisplayNameHtml()
AuthenticationFlowModel	getDockerAuthenticationFlow()
String	getEmailTheme()
Stream<String>	getEnabledEventTypesStream()	Returns enabled event types as a stream.
long	getEventsExpiration()
Stream<String>	getEventsListenersStream()	Returns events listeners as a stream.
int	getFailureFactor()
AuthenticationFlowModel	getFirstBrokerLoginFlow()
AuthenticationFlowModel	getFlowByAlias(String alias)
GroupModel	getGroupById(String id)
Long	getGroupsCount(Boolean onlyTopGroups)
Long	getGroupsCountByNameContaining(String search)
Stream<GroupModel>	getGroupsStream()	Returns groups as a stream.
String	getId()
IdentityProviderModel	getIdentityProviderByAlias(String alias)
IdentityProviderMapperModel	getIdentityProviderMapperById(String id)
IdentityProviderMapperModel	getIdentityProviderMapperByName(String brokerAlias, String name)
Stream<IdentityProviderMapperModel>	getIdentityProviderMappersByAliasStream(String brokerAlias)	Returns identity provider mappers by the provided alias as a stream.
Stream<IdentityProviderMapperModel>	getIdentityProviderMappersStream()	Returns identity provider mappers as a stream.
Stream<IdentityProviderModel>	getIdentityProvidersStream()	Returns identity providers as a stream.
String	getLoginTheme()
ClientModel	getMasterAdminClient()
int	getMaxDeltaTimeSeconds()
int	getMaxFailureWaitSeconds()
int	getMaxTemporaryLockouts()
int	getMinimumQuickLoginWaitSeconds()
String	getName()
int	getNotBefore()	Time in seconds since epoc
OAuth2DeviceConfig	getOAuth2DeviceConfig()
int	getOfflineSessionIdleTimeout()
int	getOfflineSessionMaxLifespan()
OTPPolicy	getOTPPolicy()
ParConfig	getParPolicy()
PasswordPolicy	getPasswordPolicy()
long	getQuickLoginCheckMilliSeconds()
Map<String,Map<String,String>>	getRealmLocalizationTexts()
Map<String,String>	getRealmLocalizationTextsByLocale(String locale)
int	getRefreshTokenMaxReuse()
AuthenticationFlowModel	getRegistrationFlow()
RequiredActionConfigModel	getRequiredActionConfigByAlias(String alias)
RequiredActionConfigModel	getRequiredActionConfigById(String id)
Stream<RequiredActionConfigModel>	getRequiredActionConfigsStream()
RequiredActionProviderModel	getRequiredActionProviderByAlias(String alias)
RequiredActionProviderModel	getRequiredActionProviderById(String id)
Stream<RequiredActionProviderModel>	getRequiredActionProvidersStream()	Returns sorted RequiredActionProviderModel as a stream.
Stream<RequiredCredentialModel>	getRequiredCredentialsStream()	Returns required credentials as a stream.
AuthenticationFlowModel	getResetCredentialsFlow()
RoleModel	getRole(String name)
RoleModel	getRoleById(String id)
Stream<RoleModel>	getRolesStream()	Returns available roles as a stream.
Stream<RoleModel>	getRolesStream(Integer firstResult, Integer maxResults)	Returns available roles as a stream.
Map<String,String>	getSmtpConfig()
SslRequired	getSslRequired()
int	getSsoSessionIdleTimeout()
int	getSsoSessionIdleTimeoutRememberMe()
int	getSsoSessionMaxLifespan()
int	getSsoSessionMaxLifespanRememberMe()
Stream<ComponentModel>	getStorageProviders(Class<? extends Provider> storageProviderClass)	Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.
Stream<String>	getSupportedLocalesStream()	Returns supported locales as a stream.
Stream<GroupModel>	getTopLevelGroupsStream()	Deprecated.
Stream<GroupModel>	getTopLevelGroupsStream(Integer first, Integer max)	Deprecated.
Map<String,Integer>	getUserActionTokenLifespans()	This method will return a map with all the lifespans available or an empty map, but never null.
int	getWaitIncrementSeconds()
WebAuthnPolicy	getWebAuthnPolicy()
WebAuthnPolicy	getWebAuthnPolicyPasswordless()
ComponentModel	importComponentModel(ComponentModel model)	Adds component model.
boolean	isAdminEventsDetailsEnabled()
boolean	isAdminEventsEnabled()
boolean	isBruteForceProtected()
boolean	isDuplicateEmailsAllowed()
boolean	isEditUsernameAllowed()
boolean	isEnabled()
boolean	isEventsEnabled()
boolean	isIdentityFederationEnabled()
boolean	isInternationalizationEnabled()
boolean	isLoginWithEmailAllowed()
boolean	isOfflineSessionMaxLifespanEnabled()
boolean	isOrganizationsEnabled()
boolean	isPermanentLockout()
boolean	isRegistrationAllowed()
boolean	isRegistrationEmailAsUsername()
boolean	isRememberMe()
boolean	isResetPasswordAllowed()
boolean	isRevokeRefreshToken()
boolean	isUserManagedAccessAllowed()
boolean	isVerifyEmail()
void	moveGroup(GroupModel group, GroupModel toParent)
void	removeAttribute(String name)
void	removeAuthenticationFlow(AuthenticationFlowModel model)
void	removeAuthenticatorConfig(AuthenticatorConfigModel model)
void	removeAuthenticatorExecution(AuthenticationExecutionModel model)
boolean	removeClient(String id)
void	removeClientInitialAccessModel(String id)
boolean	removeClientScope(String id)	Removes client scope with given id from this realm.
void	removeComponent(ComponentModel component)	Removes given component.
void	removeComponents(String parentId)	Removes all components with given parentId
void	removeDefaultClientScope(ClientScopeModel clientScope)	Removes given client scope from default or optional client scopes of this realm.
void	removeDefaultGroup(GroupModel group)
boolean	removeGroup(GroupModel group)
void	removeIdentityProviderByAlias(String alias)
void	removeIdentityProviderMapper(IdentityProviderMapperModel mapping)
boolean	removeRealmLocalizationTexts(String locale)
void	removeRequiredActionProvider(RequiredActionProviderModel model)
void	removeRequiredActionProviderConfig(RequiredActionConfigModel model)
boolean	removeRole(RoleModel role)
Stream<ClientModel>	searchClientByAttributes(Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientByAuthenticationFlowBindingOverrides(Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	searchClientByClientIdStream(String clientId, Integer firstResult, Integer maxResults)	Search for clients by provided client's id.
Stream<RoleModel>	searchForRolesStream(String search, Integer first, Integer max)	Searches roles by the given name.
void	setAccessCodeLifespan(int seconds)
void	setAccessCodeLifespanLogin(int seconds)
void	setAccessCodeLifespanUserAction(int seconds)
void	setAccessTokenLifespan(int seconds)
void	setAccessTokenLifespanForImplicitFlow(int seconds)
void	setAccountTheme(String name)
void	setActionTokenGeneratedByAdminLifespan(int seconds)
void	setActionTokenGeneratedByUserLifespan(int seconds)
void	setActionTokenGeneratedByUserLifespan(String actionTokenType, Integer seconds)
void	setAdminEventsDetailsEnabled(boolean enabled)
void	setAdminEventsEnabled(boolean enabled)
void	setAdminTheme(String name)
void	setAttribute(String name, Boolean value)
void	setAttribute(String name, Integer value)
void	setAttribute(String name, Long value)
void	setAttribute(String name, String value)
void	setBrowserFlow(AuthenticationFlowModel flow)
void	setBrowserSecurityHeaders(Map<String,String> headers)
void	setBruteForceProtected(boolean value)
void	setClientAuthenticationFlow(AuthenticationFlowModel flow)
void	setClientOfflineSessionIdleTimeout(int seconds)
void	setClientOfflineSessionMaxLifespan(int seconds)
void	setClientSessionIdleTimeout(int seconds)
void	setClientSessionMaxLifespan(int seconds)
void	setDefaultLocale(String locale)
void	setDefaultRole(RoleModel role)	Sets default role for this realm
void	setDefaultSignatureAlgorithm(String defaultSignatureAlgorithm)
void	setDirectGrantFlow(AuthenticationFlowModel flow)
void	setDisplayName(String displayName)
void	setDisplayNameHtml(String displayNameHtml)
void	setDockerAuthenticationFlow(AuthenticationFlowModel flow)
void	setDuplicateEmailsAllowed(boolean duplicateEmailsAllowed)
void	setEditUsernameAllowed(boolean editUsernameAllowed)
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	setFirstBrokerLoginFlow(AuthenticationFlowModel flow)
void	setInternationalizationEnabled(boolean enabled)
void	setLoginTheme(String name)
void	setLoginWithEmailAllowed(boolean loginWithEmailAllowed)
void	setMasterAdminClient(ClientModel client)
void	setMaxDeltaTimeSeconds(int val)
void	setMaxFailureWaitSeconds(int val)
void	setMaxTemporaryLockouts(int val)
void	setMinimumQuickLoginWaitSeconds(int val)
void	setName(String name)
void	setNotBefore(int notBefore)
void	setOfflineSessionIdleTimeout(int seconds)
void	setOfflineSessionMaxLifespan(int seconds)
void	setOfflineSessionMaxLifespanEnabled(boolean offlineSessionMaxLifespanEnabled)
void	setOrganizationsEnabled(boolean organizationsEnabled)
void	setOTPPolicy(OTPPolicy policy)
void	setPasswordPolicy(PasswordPolicy policy)
void	setPermanentLockout(boolean val)
void	setQuickLoginCheckMilliSeconds(long val)
void	setRefreshTokenMaxReuse(int revokeRefreshTokenCount)
void	setRegistrationAllowed(boolean registrationAllowed)
void	setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)
void	setRegistrationFlow(AuthenticationFlowModel flow)
void	setRememberMe(boolean rememberMe)
void	setResetCredentialsFlow(AuthenticationFlowModel flow)
void	setResetPasswordAllowed(boolean resetPasswordAllowed)
void	setRevokeRefreshToken(boolean revokeRefreshToken)
void	setSmtpConfig(Map<String,String> smtpConfig)
void	setSslRequired(SslRequired sslRequired)
void	setSsoSessionIdleTimeout(int seconds)
void	setSsoSessionIdleTimeoutRememberMe(int seconds)
void	setSsoSessionMaxLifespan(int seconds)
void	setSsoSessionMaxLifespanRememberMe(int seconds)
void	setSupportedLocales(Set<String> locales)
void	setUserManagedAccessAllowed(boolean userManagedAccessAllowed)
void	setVerifyEmail(boolean verifyEmail)
void	setWaitIncrementSeconds(int val)
void	setWebAuthnPolicy(WebAuthnPolicy policy)	Set WebAuthn policy for 2-factor authentication
void	setWebAuthnPolicyPasswordless(WebAuthnPolicy policy)	Set WebAuthn passwordless policy below.
void	updateAuthenticationFlow(AuthenticationFlowModel model)
void	updateAuthenticatorConfig(AuthenticatorConfigModel model)
void	updateAuthenticatorExecution(AuthenticationExecutionModel model)
void	updateComponent(ComponentModel component)	Updates component model.
void	updateIdentityProvider(IdentityProviderModel identityProvider)
void	updateIdentityProviderMapper(IdentityProviderMapperModel mapping)
void	updateRequiredActionConfig(RequiredActionConfigModel model)
void	updateRequiredActionProvider(RequiredActionProviderModel model)
void	updateRequiredCredentials(Set<String> creds)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RealmModelDelegate

public RealmModelDelegate(RealmModel delegate)

Method Details

getId

public String getId()

Specified by:

getId in interface RealmModel

Specified by:

getId in interface RoleContainerModel

getName

public String getName()

Specified by:

getName in interface RealmModel

setName

public void setName(String name)

Specified by:

setName in interface RealmModel

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface RealmModel

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface RealmModel

getDisplayNameHtml

public String getDisplayNameHtml()

Specified by:

getDisplayNameHtml in interface RealmModel

setDisplayNameHtml

public void setDisplayNameHtml(String displayNameHtml)

Specified by:

setDisplayNameHtml in interface RealmModel

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface RealmModel

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface RealmModel

getSslRequired

public SslRequired getSslRequired()

Specified by:

getSslRequired in interface RealmModel

setSslRequired

public void setSslRequired(SslRequired sslRequired)

Specified by:

setSslRequired in interface RealmModel

isRegistrationAllowed

public boolean isRegistrationAllowed()

Specified by:

isRegistrationAllowed in interface RealmModel

setRegistrationAllowed

public void setRegistrationAllowed(boolean registrationAllowed)

Specified by:

setRegistrationAllowed in interface RealmModel

isRegistrationEmailAsUsername

public boolean isRegistrationEmailAsUsername()

Specified by:

isRegistrationEmailAsUsername in interface RealmModel

setRegistrationEmailAsUsername

public void setRegistrationEmailAsUsername(boolean registrationEmailAsUsername)

Specified by:

setRegistrationEmailAsUsername in interface RealmModel

isRememberMe

public boolean isRememberMe()

Specified by:

isRememberMe in interface RealmModel

setRememberMe

public void setRememberMe(boolean rememberMe)

Specified by:

setRememberMe in interface RealmModel

isEditUsernameAllowed

public boolean isEditUsernameAllowed()

Specified by:

isEditUsernameAllowed in interface RealmModel

setEditUsernameAllowed

public void setEditUsernameAllowed(boolean editUsernameAllowed)

Specified by:

setEditUsernameAllowed in interface RealmModel

isUserManagedAccessAllowed

public boolean isUserManagedAccessAllowed()

Specified by:

isUserManagedAccessAllowed in interface RealmModel

setUserManagedAccessAllowed

public void setUserManagedAccessAllowed(boolean userManagedAccessAllowed)

Specified by:

setUserManagedAccessAllowed in interface RealmModel

setAttribute

public void setAttribute(String name,
 String value)

Specified by:

setAttribute in interface RealmModel

setAttribute

public void setAttribute(String name,
 Boolean value)

Specified by:

setAttribute in interface RealmModel

setAttribute

public void setAttribute(String name,
 Integer value)

Specified by:

setAttribute in interface RealmModel

setAttribute

public void setAttribute(String name,
 Long value)

Specified by:

setAttribute in interface RealmModel

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface RealmModel

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface RealmModel

getAttribute

public Integer getAttribute(String name,
 Integer defaultValue)

Specified by:

getAttribute in interface RealmModel

getAttribute

public Long getAttribute(String name,
 Long defaultValue)

Specified by:

getAttribute in interface RealmModel

getAttribute

public Boolean getAttribute(String name,
 Boolean defaultValue)

Specified by:

getAttribute in interface RealmModel

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface RealmModel

isBruteForceProtected

public boolean isBruteForceProtected()

Specified by:

isBruteForceProtected in interface RealmModel

setBruteForceProtected

public void setBruteForceProtected(boolean value)

Specified by:

setBruteForceProtected in interface RealmModel

isPermanentLockout

public boolean isPermanentLockout()

Specified by:

isPermanentLockout in interface RealmModel

setPermanentLockout

public void setPermanentLockout(boolean val)

Specified by:

setPermanentLockout in interface RealmModel

getMaxTemporaryLockouts

public int getMaxTemporaryLockouts()

Specified by:

getMaxTemporaryLockouts in interface RealmModel

setMaxTemporaryLockouts

public void setMaxTemporaryLockouts(int val)

Specified by:

setMaxTemporaryLockouts in interface RealmModel

getMaxFailureWaitSeconds

public int getMaxFailureWaitSeconds()

Specified by:

getMaxFailureWaitSeconds in interface RealmModel

setMaxFailureWaitSeconds

public void setMaxFailureWaitSeconds(int val)

Specified by:

setMaxFailureWaitSeconds in interface RealmModel

getWaitIncrementSeconds

public int getWaitIncrementSeconds()

Specified by:

getWaitIncrementSeconds in interface RealmModel

setWaitIncrementSeconds

public void setWaitIncrementSeconds(int val)

Specified by:

setWaitIncrementSeconds in interface RealmModel

getMinimumQuickLoginWaitSeconds

public int getMinimumQuickLoginWaitSeconds()

Specified by:

getMinimumQuickLoginWaitSeconds in interface RealmModel

setMinimumQuickLoginWaitSeconds

public void setMinimumQuickLoginWaitSeconds(int val)

Specified by:

setMinimumQuickLoginWaitSeconds in interface RealmModel

getQuickLoginCheckMilliSeconds

public long getQuickLoginCheckMilliSeconds()

Specified by:

getQuickLoginCheckMilliSeconds in interface RealmModel

setQuickLoginCheckMilliSeconds

public void setQuickLoginCheckMilliSeconds(long val)

Specified by:

setQuickLoginCheckMilliSeconds in interface RealmModel

getMaxDeltaTimeSeconds

public int getMaxDeltaTimeSeconds()

Specified by:

getMaxDeltaTimeSeconds in interface RealmModel

setMaxDeltaTimeSeconds

public void setMaxDeltaTimeSeconds(int val)

Specified by:

setMaxDeltaTimeSeconds in interface RealmModel

getFailureFactor

public int getFailureFactor()

Specified by:

getFailureFactor in interface RealmModel

setFailureFactor

public void setFailureFactor(int failureFactor)

Specified by:

setFailureFactor in interface RealmModel

isVerifyEmail

public boolean isVerifyEmail()

Specified by:

isVerifyEmail in interface RealmModel

setVerifyEmail

public void setVerifyEmail(boolean verifyEmail)

Specified by:

setVerifyEmail in interface RealmModel

isLoginWithEmailAllowed

public boolean isLoginWithEmailAllowed()

Specified by:

isLoginWithEmailAllowed in interface RealmModel

setLoginWithEmailAllowed

public void setLoginWithEmailAllowed(boolean loginWithEmailAllowed)

Specified by:

setLoginWithEmailAllowed in interface RealmModel

isDuplicateEmailsAllowed

public boolean isDuplicateEmailsAllowed()

Specified by:

isDuplicateEmailsAllowed in interface RealmModel

setDuplicateEmailsAllowed

public void setDuplicateEmailsAllowed(boolean duplicateEmailsAllowed)

Specified by:

setDuplicateEmailsAllowed in interface RealmModel

isResetPasswordAllowed

public boolean isResetPasswordAllowed()

Specified by:

isResetPasswordAllowed in interface RealmModel

setResetPasswordAllowed

public void setResetPasswordAllowed(boolean resetPasswordAllowed)

Specified by:

setResetPasswordAllowed in interface RealmModel

getDefaultSignatureAlgorithm

public String getDefaultSignatureAlgorithm()

Specified by:

getDefaultSignatureAlgorithm in interface RealmModel

setDefaultSignatureAlgorithm

public void setDefaultSignatureAlgorithm(String defaultSignatureAlgorithm)

Specified by:

setDefaultSignatureAlgorithm in interface RealmModel

isRevokeRefreshToken

public boolean isRevokeRefreshToken()

Specified by:

isRevokeRefreshToken in interface RealmModel

setRevokeRefreshToken

public void setRevokeRefreshToken(boolean revokeRefreshToken)

Specified by:

setRevokeRefreshToken in interface RealmModel

getRefreshTokenMaxReuse

public int getRefreshTokenMaxReuse()

Specified by:

getRefreshTokenMaxReuse in interface RealmModel

setRefreshTokenMaxReuse

public void setRefreshTokenMaxReuse(int revokeRefreshTokenCount)

Specified by:

setRefreshTokenMaxReuse in interface RealmModel

getSsoSessionIdleTimeout

public int getSsoSessionIdleTimeout()

Specified by:

getSsoSessionIdleTimeout in interface RealmModel

setSsoSessionIdleTimeout

public void setSsoSessionIdleTimeout(int seconds)

Specified by:

setSsoSessionIdleTimeout in interface RealmModel

getSsoSessionMaxLifespan

public int getSsoSessionMaxLifespan()

Specified by:

getSsoSessionMaxLifespan in interface RealmModel

setSsoSessionMaxLifespan

public void setSsoSessionMaxLifespan(int seconds)

Specified by:

setSsoSessionMaxLifespan in interface RealmModel

getSsoSessionIdleTimeoutRememberMe

public int getSsoSessionIdleTimeoutRememberMe()

Specified by:

getSsoSessionIdleTimeoutRememberMe in interface RealmModel

setSsoSessionIdleTimeoutRememberMe

public void setSsoSessionIdleTimeoutRememberMe(int seconds)

Specified by:

setSsoSessionIdleTimeoutRememberMe in interface RealmModel

getSsoSessionMaxLifespanRememberMe

public int getSsoSessionMaxLifespanRememberMe()

Specified by:

getSsoSessionMaxLifespanRememberMe in interface RealmModel

setSsoSessionMaxLifespanRememberMe

public void setSsoSessionMaxLifespanRememberMe(int seconds)

Specified by:

setSsoSessionMaxLifespanRememberMe in interface RealmModel

getOfflineSessionIdleTimeout

public int getOfflineSessionIdleTimeout()

Specified by:

getOfflineSessionIdleTimeout in interface RealmModel

setOfflineSessionIdleTimeout

public void setOfflineSessionIdleTimeout(int seconds)

Specified by:

setOfflineSessionIdleTimeout in interface RealmModel

getAccessTokenLifespan

public int getAccessTokenLifespan()

Specified by:

getAccessTokenLifespan in interface RealmModel

isOfflineSessionMaxLifespanEnabled

public boolean isOfflineSessionMaxLifespanEnabled()

Specified by:

isOfflineSessionMaxLifespanEnabled in interface RealmModel

setOfflineSessionMaxLifespanEnabled

public void setOfflineSessionMaxLifespanEnabled(boolean offlineSessionMaxLifespanEnabled)

Specified by:

setOfflineSessionMaxLifespanEnabled in interface RealmModel

getOfflineSessionMaxLifespan

public int getOfflineSessionMaxLifespan()

Specified by:

getOfflineSessionMaxLifespan in interface RealmModel

setOfflineSessionMaxLifespan

public void setOfflineSessionMaxLifespan(int seconds)

Specified by:

setOfflineSessionMaxLifespan in interface RealmModel

getClientSessionIdleTimeout

public int getClientSessionIdleTimeout()

Specified by:

getClientSessionIdleTimeout in interface RealmModel

setClientSessionIdleTimeout

public void setClientSessionIdleTimeout(int seconds)

Specified by:

setClientSessionIdleTimeout in interface RealmModel

getClientSessionMaxLifespan

public int getClientSessionMaxLifespan()

Specified by:

getClientSessionMaxLifespan in interface RealmModel

setClientSessionMaxLifespan

public void setClientSessionMaxLifespan(int seconds)

Specified by:

setClientSessionMaxLifespan in interface RealmModel

getClientOfflineSessionIdleTimeout

public int getClientOfflineSessionIdleTimeout()

Specified by:

getClientOfflineSessionIdleTimeout in interface RealmModel

setClientOfflineSessionIdleTimeout

public void setClientOfflineSessionIdleTimeout(int seconds)

Specified by:

setClientOfflineSessionIdleTimeout in interface RealmModel

getClientOfflineSessionMaxLifespan

public int getClientOfflineSessionMaxLifespan()

Specified by:

getClientOfflineSessionMaxLifespan in interface RealmModel

setClientOfflineSessionMaxLifespan

public void setClientOfflineSessionMaxLifespan(int seconds)

Specified by:

setClientOfflineSessionMaxLifespan in interface RealmModel

setAccessTokenLifespan

public void setAccessTokenLifespan(int seconds)

Specified by:

setAccessTokenLifespan in interface RealmModel

getAccessTokenLifespanForImplicitFlow

public int getAccessTokenLifespanForImplicitFlow()

Specified by:

getAccessTokenLifespanForImplicitFlow in interface RealmModel

setAccessTokenLifespanForImplicitFlow

public void setAccessTokenLifespanForImplicitFlow(int seconds)

Specified by:

setAccessTokenLifespanForImplicitFlow in interface RealmModel

getAccessCodeLifespan

public int getAccessCodeLifespan()

Specified by:

getAccessCodeLifespan in interface RealmModel

setAccessCodeLifespan

public void setAccessCodeLifespan(int seconds)

Specified by:

setAccessCodeLifespan in interface RealmModel

getAccessCodeLifespanUserAction

public int getAccessCodeLifespanUserAction()

Specified by:

getAccessCodeLifespanUserAction in interface RealmModel

setAccessCodeLifespanUserAction

public void setAccessCodeLifespanUserAction(int seconds)

Specified by:

setAccessCodeLifespanUserAction in interface RealmModel

getOAuth2DeviceConfig

public OAuth2DeviceConfig getOAuth2DeviceConfig()

Specified by:

getOAuth2DeviceConfig in interface RealmModel

getCibaPolicy

public CibaConfig getCibaPolicy()

Specified by:

getCibaPolicy in interface RealmModel

getParPolicy

public ParConfig getParPolicy()

Specified by:

getParPolicy in interface RealmModel

getUserActionTokenLifespans

public Map<String,Integer> getUserActionTokenLifespans()

Description copied from interface: RealmModel

This method will return a map with all the lifespans available or an empty map, but never null.

Specified by:

getUserActionTokenLifespans in interface RealmModel

Returns:

map with user action token lifespans

getAccessCodeLifespanLogin

public int getAccessCodeLifespanLogin()

Specified by:

getAccessCodeLifespanLogin in interface RealmModel

setAccessCodeLifespanLogin

public void setAccessCodeLifespanLogin(int seconds)

Specified by:

setAccessCodeLifespanLogin in interface RealmModel

getActionTokenGeneratedByAdminLifespan

public int getActionTokenGeneratedByAdminLifespan()

Specified by:

getActionTokenGeneratedByAdminLifespan in interface RealmModel

setActionTokenGeneratedByAdminLifespan

public void setActionTokenGeneratedByAdminLifespan(int seconds)

Specified by:

setActionTokenGeneratedByAdminLifespan in interface RealmModel

getActionTokenGeneratedByUserLifespan

public int getActionTokenGeneratedByUserLifespan()

Specified by:

getActionTokenGeneratedByUserLifespan in interface RealmModel

setActionTokenGeneratedByUserLifespan

public void setActionTokenGeneratedByUserLifespan(int seconds)

Specified by:

setActionTokenGeneratedByUserLifespan in interface RealmModel

getActionTokenGeneratedByUserLifespan

public int getActionTokenGeneratedByUserLifespan(String actionTokenType)

Specified by:

getActionTokenGeneratedByUserLifespan in interface RealmModel

setActionTokenGeneratedByUserLifespan

public void setActionTokenGeneratedByUserLifespan(String actionTokenType,
 Integer seconds)

Specified by:

setActionTokenGeneratedByUserLifespan in interface RealmModel

getRequiredCredentialsStream

public Stream<RequiredCredentialModel> getRequiredCredentialsStream()

Description copied from interface: RealmModel

Returns required credentials as a stream.

Specified by:

getRequiredCredentialsStream in interface RealmModel

Returns:

Stream of RequiredCredentialModel. Never returns null.

addRequiredCredential

public void addRequiredCredential(String cred)

Specified by:

addRequiredCredential in interface RealmModel

getPasswordPolicy

public PasswordPolicy getPasswordPolicy()

Specified by:

getPasswordPolicy in interface RealmModel

setPasswordPolicy

public void setPasswordPolicy(PasswordPolicy policy)

Specified by:

setPasswordPolicy in interface RealmModel

getOTPPolicy

public OTPPolicy getOTPPolicy()

Specified by:

getOTPPolicy in interface RealmModel

setOTPPolicy

public void setOTPPolicy(OTPPolicy policy)

Specified by:

setOTPPolicy in interface RealmModel

getWebAuthnPolicy

public WebAuthnPolicy getWebAuthnPolicy()

Specified by:

getWebAuthnPolicy in interface RealmModel

Returns:

WebAuthn policy for 2-factor authentication

setWebAuthnPolicy

public void setWebAuthnPolicy(WebAuthnPolicy policy)

Description copied from interface: RealmModel

Set WebAuthn policy for 2-factor authentication

Specified by:

setWebAuthnPolicy in interface RealmModel

getWebAuthnPolicyPasswordless

public WebAuthnPolicy getWebAuthnPolicyPasswordless()

Specified by:

getWebAuthnPolicyPasswordless in interface RealmModel

Returns:

WebAuthn passwordless policy below. This is temporary and will be removed later.

setWebAuthnPolicyPasswordless

public void setWebAuthnPolicyPasswordless(WebAuthnPolicy policy)

Description copied from interface: RealmModel

Set WebAuthn passwordless policy below. This is temporary and will be removed later.

Specified by:

setWebAuthnPolicyPasswordless in interface RealmModel

getRoleById

public RoleModel getRoleById(String id)

Specified by:

getRoleById in interface RealmModel

getDefaultGroupsStream

public Stream<GroupModel> getDefaultGroupsStream()

Description copied from interface: RealmModel

Returns default groups as a stream.

Specified by:

getDefaultGroupsStream in interface RealmModel

Returns:

Stream of GroupModel. Never returns null.

addDefaultGroup

public void addDefaultGroup(GroupModel group)

Specified by:

addDefaultGroup in interface RealmModel

removeDefaultGroup

public void removeDefaultGroup(GroupModel group)

Specified by:

removeDefaultGroup in interface RealmModel

getClientsStream

public Stream<ClientModel> getClientsStream()

Description copied from interface: RealmModel

Returns clients as a stream.

Specified by:

getClientsStream in interface RealmModel

Returns:

Stream of ClientModel. Never returns null.

getClientsStream

public Stream<ClientModel> getClientsStream(Integer firstResult,
 Integer maxResults)

Description copied from interface: RealmModel

Returns clients as a stream.

Specified by:

getClientsStream in interface RealmModel

Parameters:

firstResult - Integer Index of the first desired client. Ignored if negative or null.

maxResults - Integer Maximum number of returned clients. Ignored if negative or null.

Returns:

Stream of ClientModel. Never returns null.

getClientsCount

public Long getClientsCount()

Specified by:

getClientsCount in interface RealmModel

getAlwaysDisplayInConsoleClientsStream

public Stream<ClientModel> getAlwaysDisplayInConsoleClientsStream()

Description copied from interface: RealmModel

Returns clients which are always displayed in the admin console as a stream.

Specified by:

getAlwaysDisplayInConsoleClientsStream in interface RealmModel

Returns:

Stream of ClientModel. Never returns null.

addClient

public ClientModel addClient(String name)

Specified by:

addClient in interface RealmModel

addClient

public ClientModel addClient(String id,
 String clientId)

Specified by:

addClient in interface RealmModel

removeClient

public boolean removeClient(String id)

Specified by:

removeClient in interface RealmModel

getClientById

public ClientModel getClientById(String id)

Specified by:

getClientById in interface RealmModel

getClientByClientId

public ClientModel getClientByClientId(String clientId)

Specified by:

getClientByClientId in interface RealmModel

searchClientByClientIdStream

public Stream<ClientModel> searchClientByClientIdStream(String clientId,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: RealmModel

Search for clients by provided client's id.

Specified by:

searchClientByClientIdStream in interface RealmModel

Parameters:

clientId - String Id of the client.

firstResult - Index of the first desired client. Ignored if negative or null.

maxResults - Maximum number of returned clients. Ignored if negative or null.

Returns:

Stream of ClientModel. Never returns null.

searchClientByAttributes

public Stream<ClientModel> searchClientByAttributes(Map<String,String> attributes,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientByAttributes in interface RealmModel

searchClientByAuthenticationFlowBindingOverrides

public Stream<ClientModel> searchClientByAuthenticationFlowBindingOverrides(Map<String,String> overrides,
 Integer firstResult,
 Integer maxResults)

Specified by:

searchClientByAuthenticationFlowBindingOverrides in interface RealmModel

updateRequiredCredentials

public void updateRequiredCredentials(Set<String> creds)

Specified by:

updateRequiredCredentials in interface RealmModel

getBrowserSecurityHeaders

public Map<String,String> getBrowserSecurityHeaders()

Specified by:

getBrowserSecurityHeaders in interface RealmModel

setBrowserSecurityHeaders

public void setBrowserSecurityHeaders(Map<String,String> headers)

Specified by:

setBrowserSecurityHeaders in interface RealmModel

getSmtpConfig

public Map<String,String> getSmtpConfig()

Specified by:

getSmtpConfig in interface RealmModel

setSmtpConfig

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

Specified by:

setSmtpConfig in interface RealmModel

getBrowserFlow

public AuthenticationFlowModel getBrowserFlow()

Specified by:

getBrowserFlow in interface RealmModel

setBrowserFlow

public void setBrowserFlow(AuthenticationFlowModel flow)

Specified by:

setBrowserFlow in interface RealmModel

getRegistrationFlow

public AuthenticationFlowModel getRegistrationFlow()

Specified by:

getRegistrationFlow in interface RealmModel

setRegistrationFlow

public void setRegistrationFlow(AuthenticationFlowModel flow)

Specified by:

setRegistrationFlow in interface RealmModel

getDirectGrantFlow

public AuthenticationFlowModel getDirectGrantFlow()

Specified by:

getDirectGrantFlow in interface RealmModel

setDirectGrantFlow

public void setDirectGrantFlow(AuthenticationFlowModel flow)

Specified by:

setDirectGrantFlow in interface RealmModel

getResetCredentialsFlow

public AuthenticationFlowModel getResetCredentialsFlow()

Specified by:

getResetCredentialsFlow in interface RealmModel

setResetCredentialsFlow

public void setResetCredentialsFlow(AuthenticationFlowModel flow)

Specified by:

setResetCredentialsFlow in interface RealmModel

getClientAuthenticationFlow

public AuthenticationFlowModel getClientAuthenticationFlow()

Specified by:

getClientAuthenticationFlow in interface RealmModel

setClientAuthenticationFlow

public void setClientAuthenticationFlow(AuthenticationFlowModel flow)

Specified by:

setClientAuthenticationFlow in interface RealmModel

getDockerAuthenticationFlow

public AuthenticationFlowModel getDockerAuthenticationFlow()

Specified by:

getDockerAuthenticationFlow in interface RealmModel

setDockerAuthenticationFlow

public void setDockerAuthenticationFlow(AuthenticationFlowModel flow)

Specified by:

setDockerAuthenticationFlow in interface RealmModel

getFirstBrokerLoginFlow

public AuthenticationFlowModel getFirstBrokerLoginFlow()

Specified by:

getFirstBrokerLoginFlow in interface RealmModel

setFirstBrokerLoginFlow

public void setFirstBrokerLoginFlow(AuthenticationFlowModel flow)

Specified by:

setFirstBrokerLoginFlow in interface RealmModel

getAuthenticationFlowsStream

public Stream<AuthenticationFlowModel> getAuthenticationFlowsStream()

Description copied from interface: RealmModel

Returns authentications flows as a stream.

Specified by:

getAuthenticationFlowsStream in interface RealmModel

Returns:

Stream of AuthenticationFlowModel. Never returns null.

getFlowByAlias

public AuthenticationFlowModel getFlowByAlias(String alias)

Specified by:

getFlowByAlias in interface RealmModel

addAuthenticationFlow

public AuthenticationFlowModel addAuthenticationFlow(AuthenticationFlowModel model)

Specified by:

addAuthenticationFlow in interface RealmModel

getAuthenticationFlowById

public AuthenticationFlowModel getAuthenticationFlowById(String id)

Specified by:

getAuthenticationFlowById in interface RealmModel

removeAuthenticationFlow

public void removeAuthenticationFlow(AuthenticationFlowModel model)

Specified by:

removeAuthenticationFlow in interface RealmModel

updateAuthenticationFlow

public void updateAuthenticationFlow(AuthenticationFlowModel model)

Specified by:

updateAuthenticationFlow in interface RealmModel

getAuthenticationExecutionsStream

public Stream<AuthenticationExecutionModel> getAuthenticationExecutionsStream(String flowId)

Description copied from interface: RealmModel

Returns sorted (according to priority) AuthenticationExecutionModel as a stream. It should be used with forEachOrdered if the ordering is required.

Specified by:

getAuthenticationExecutionsStream in interface RealmModel

Parameters:

flowId - String Id of the flow.

Returns:

Sorted stream of AuthenticationExecutionModel. Never returns null.

getAuthenticationExecutionById

public AuthenticationExecutionModel getAuthenticationExecutionById(String id)

Specified by:

getAuthenticationExecutionById in interface RealmModel

getAuthenticationExecutionByFlowId

public AuthenticationExecutionModel getAuthenticationExecutionByFlowId(String flowId)

Specified by:

getAuthenticationExecutionByFlowId in interface RealmModel

addAuthenticatorExecution

public AuthenticationExecutionModel addAuthenticatorExecution(AuthenticationExecutionModel model)

Specified by:

addAuthenticatorExecution in interface RealmModel

updateAuthenticatorExecution

public void updateAuthenticatorExecution(AuthenticationExecutionModel model)

Specified by:

updateAuthenticatorExecution in interface RealmModel

removeAuthenticatorExecution

public void removeAuthenticatorExecution(AuthenticationExecutionModel model)

Specified by:

removeAuthenticatorExecution in interface RealmModel

getAuthenticatorConfigsStream

public Stream<AuthenticatorConfigModel> getAuthenticatorConfigsStream()

Description copied from interface: RealmModel

Returns authentication configs as a stream.

Specified by:

getAuthenticatorConfigsStream in interface RealmModel

Returns:

Stream of AuthenticatorConfigModel. Never returns null.

addAuthenticatorConfig

public AuthenticatorConfigModel addAuthenticatorConfig(AuthenticatorConfigModel model)

Specified by:

addAuthenticatorConfig in interface RealmModel

updateAuthenticatorConfig

public void updateAuthenticatorConfig(AuthenticatorConfigModel model)

Specified by:

updateAuthenticatorConfig in interface RealmModel

removeAuthenticatorConfig

public void removeAuthenticatorConfig(AuthenticatorConfigModel model)

Specified by:

removeAuthenticatorConfig in interface RealmModel

getAuthenticatorConfigById

public AuthenticatorConfigModel getAuthenticatorConfigById(String id)

Specified by:

getAuthenticatorConfigById in interface RealmModel

getAuthenticatorConfigByAlias

public AuthenticatorConfigModel getAuthenticatorConfigByAlias(String alias)

Specified by:

getAuthenticatorConfigByAlias in interface RealmModel

getRequiredActionConfigById

public RequiredActionConfigModel getRequiredActionConfigById(String id)

Specified by:

getRequiredActionConfigById in interface RealmModel

getRequiredActionConfigByAlias

public RequiredActionConfigModel getRequiredActionConfigByAlias(String alias)

Specified by:

getRequiredActionConfigByAlias in interface RealmModel

removeRequiredActionProviderConfig

public void removeRequiredActionProviderConfig(RequiredActionConfigModel model)

Specified by:

removeRequiredActionProviderConfig in interface RealmModel

updateRequiredActionConfig

public void updateRequiredActionConfig(RequiredActionConfigModel model)

Specified by:

updateRequiredActionConfig in interface RealmModel

getRequiredActionConfigsStream

public Stream<RequiredActionConfigModel> getRequiredActionConfigsStream()

Specified by:

getRequiredActionConfigsStream in interface RealmModel

getRequiredActionProvidersStream

public Stream<RequiredActionProviderModel> getRequiredActionProvidersStream()

Description copied from interface: RealmModel

Returns sorted RequiredActionProviderModel as a stream. It should be used with forEachOrdered if the ordering is required.

Specified by:

getRequiredActionProvidersStream in interface RealmModel

Returns:

Sorted stream of RequiredActionProviderModel. Never returns null.

addRequiredActionProvider

public RequiredActionProviderModel addRequiredActionProvider(RequiredActionProviderModel model)

Specified by:

addRequiredActionProvider in interface RealmModel

updateRequiredActionProvider

public void updateRequiredActionProvider(RequiredActionProviderModel model)

Specified by:

updateRequiredActionProvider in interface RealmModel

removeRequiredActionProvider

public void removeRequiredActionProvider(RequiredActionProviderModel model)

Specified by:

removeRequiredActionProvider in interface RealmModel

getRequiredActionProviderById

public RequiredActionProviderModel getRequiredActionProviderById(String id)

Specified by:

getRequiredActionProviderById in interface RealmModel

getRequiredActionProviderByAlias

public RequiredActionProviderModel getRequiredActionProviderByAlias(String alias)

Specified by:

getRequiredActionProviderByAlias in interface RealmModel

getIdentityProvidersStream

public Stream<IdentityProviderModel> getIdentityProvidersStream()

Description copied from interface: RealmModel

Returns identity providers as a stream.

Specified by:

getIdentityProvidersStream in interface RealmModel

Returns:

Stream of IdentityProviderModel. Never returns null.

getIdentityProviderByAlias

public IdentityProviderModel getIdentityProviderByAlias(String alias)

Specified by:

getIdentityProviderByAlias in interface RealmModel

addIdentityProvider

public void addIdentityProvider(IdentityProviderModel identityProvider)

Specified by:

addIdentityProvider in interface RealmModel

removeIdentityProviderByAlias

public void removeIdentityProviderByAlias(String alias)

Specified by:

removeIdentityProviderByAlias in interface RealmModel

updateIdentityProvider

public void updateIdentityProvider(IdentityProviderModel identityProvider)

Specified by:

updateIdentityProvider in interface RealmModel

getIdentityProviderMappersStream

public Stream<IdentityProviderMapperModel> getIdentityProviderMappersStream()

Description copied from interface: RealmModel

Returns identity provider mappers as a stream.

Specified by:

getIdentityProviderMappersStream in interface RealmModel

Returns:

Stream of IdentityProviderMapperModel. Never returns null.

getIdentityProviderMappersByAliasStream

public Stream<IdentityProviderMapperModel> getIdentityProviderMappersByAliasStream(String brokerAlias)

Description copied from interface: RealmModel

Returns identity provider mappers by the provided alias as a stream.

Specified by:

getIdentityProviderMappersByAliasStream in interface RealmModel

Parameters:

brokerAlias - String Broker's alias to filter results.

Returns:

Stream of IdentityProviderMapperModel Never returns null.

addIdentityProviderMapper

public IdentityProviderMapperModel addIdentityProviderMapper(IdentityProviderMapperModel model)

Specified by:

addIdentityProviderMapper in interface RealmModel

removeIdentityProviderMapper

public void removeIdentityProviderMapper(IdentityProviderMapperModel mapping)

Specified by:

removeIdentityProviderMapper in interface RealmModel

updateIdentityProviderMapper

public void updateIdentityProviderMapper(IdentityProviderMapperModel mapping)

Specified by:

updateIdentityProviderMapper in interface RealmModel

getIdentityProviderMapperById

public IdentityProviderMapperModel getIdentityProviderMapperById(String id)

Specified by:

getIdentityProviderMapperById in interface RealmModel

getIdentityProviderMapperByName

public IdentityProviderMapperModel getIdentityProviderMapperByName(String brokerAlias,
 String name)

Specified by:

getIdentityProviderMapperByName in interface RealmModel

addComponentModel

public ComponentModel addComponentModel(ComponentModel model)

Description copied from interface: RealmModel

Adds component model. Will call onCreate() method of ComponentFactory

Specified by:

addComponentModel in interface RealmModel

Returns:

importComponentModel

public ComponentModel importComponentModel(ComponentModel model)

Description copied from interface: RealmModel

Adds component model. Will NOT call onCreate() method of ComponentFactory

Specified by:

importComponentModel in interface RealmModel

Returns:

updateComponent

public void updateComponent(ComponentModel component)

Description copied from interface: RealmModel

Updates component model. Will call onUpdate() method of ComponentFactory

Specified by:

updateComponent in interface RealmModel

Parameters:

component - to be updated

removeComponent

public void removeComponent(ComponentModel component)

Description copied from interface: RealmModel

Removes given component. Will call preRemove() method of ComponentFactory. Also calls this.removeComponents(component.getId()).

Specified by:

removeComponent in interface RealmModel

Parameters:

component - to be removed

removeComponents

public void removeComponents(String parentId)

Description copied from interface: RealmModel

Removes all components with given parentId

Specified by:

removeComponents in interface RealmModel

Parameters:

parentId - String id of parent

getComponentsStream

public Stream<ComponentModel> getComponentsStream(String parentId,
 String providerType)

Description copied from interface: RealmModel

Returns stream of ComponentModels for specific parentId and providerType.

Specified by:

getComponentsStream in interface RealmModel

Parameters:

parentId - String id of parent

providerType - String type of provider

Returns:

Stream of ComponentModel. Never returns null.

getComponentsStream

public Stream<ComponentModel> getComponentsStream(String parentId)

Description copied from interface: RealmModel

Returns stream of ComponentModels for specific parentId.

Specified by:

getComponentsStream in interface RealmModel

Parameters:

parentId - String id of parent

Returns:

Stream of ComponentModel. Never returns null.

getComponentsStream

public Stream<ComponentModel> getComponentsStream()

Description copied from interface: RealmModel

Returns stream of component models.

Specified by:

getComponentsStream in interface RealmModel

Returns:

Stream of ComponentModel. Never returns null.

getComponent

public ComponentModel getComponent(String id)

Specified by:

getComponent in interface RealmModel

getStorageProviders

public Stream<ComponentModel> getStorageProviders(Class<? extends Provider> storageProviderClass)

Description copied from interface: RealmModel

Returns stream of ComponentModels that represent StorageProviders for class storageProviderClass in this realm.

Specified by:

getStorageProviders in interface RealmModel

Parameters:

storageProviderClass - Class<? extends Provider>

Returns:

Stream of ComponentModel. Never returns null.

getLoginTheme

public String getLoginTheme()

Specified by:

getLoginTheme in interface RealmModel

setLoginTheme

public void setLoginTheme(String name)

Specified by:

setLoginTheme in interface RealmModel

getAccountTheme

public String getAccountTheme()

Specified by:

getAccountTheme in interface RealmModel

setAccountTheme

public void setAccountTheme(String name)

Specified by:

setAccountTheme in interface RealmModel

getAdminTheme

public String getAdminTheme()

Specified by:

getAdminTheme in interface RealmModel

setAdminTheme

public void setAdminTheme(String name)

Specified by:

setAdminTheme in interface RealmModel

getEmailTheme

public String getEmailTheme()

Specified by:

getEmailTheme in interface RealmModel

setEmailTheme

public void setEmailTheme(String name)

Specified by:

setEmailTheme in interface RealmModel

getNotBefore

public int getNotBefore()

Description copied from interface: RealmModel

Time in seconds since epoc

Specified by:

getNotBefore in interface RealmModel

Returns:

setNotBefore

public void setNotBefore(int notBefore)

Specified by:

setNotBefore in interface RealmModel

isEventsEnabled

public boolean isEventsEnabled()

Specified by:

isEventsEnabled in interface RealmModel

setEventsEnabled

public void setEventsEnabled(boolean enabled)

Specified by:

setEventsEnabled in interface RealmModel

getEventsExpiration

public long getEventsExpiration()

Specified by:

getEventsExpiration in interface RealmModel

setEventsExpiration

public void setEventsExpiration(long expiration)

Specified by:

setEventsExpiration in interface RealmModel

getEventsListenersStream

public Stream<String> getEventsListenersStream()

Description copied from interface: RealmModel

Returns events listeners as a stream.

Specified by:

getEventsListenersStream in interface RealmModel

Returns:

Stream of String. Never returns null.

setEventsListeners

public void setEventsListeners(Set<String> listeners)

Specified by:

setEventsListeners in interface RealmModel

getEnabledEventTypesStream

public Stream<String> getEnabledEventTypesStream()

Description copied from interface: RealmModel

Returns enabled event types as a stream.

Specified by:

getEnabledEventTypesStream in interface RealmModel

Returns:

Stream of String. Never returns null.

setEnabledEventTypes

public void setEnabledEventTypes(Set<String> enabledEventTypes)

Specified by:

setEnabledEventTypes in interface RealmModel

isAdminEventsEnabled

public boolean isAdminEventsEnabled()

Specified by:

isAdminEventsEnabled in interface RealmModel

setAdminEventsEnabled

public void setAdminEventsEnabled(boolean enabled)

Specified by:

setAdminEventsEnabled in interface RealmModel

isAdminEventsDetailsEnabled

public boolean isAdminEventsDetailsEnabled()

Specified by:

isAdminEventsDetailsEnabled in interface RealmModel

setAdminEventsDetailsEnabled

public void setAdminEventsDetailsEnabled(boolean enabled)

Specified by:

setAdminEventsDetailsEnabled in interface RealmModel

getMasterAdminClient

public ClientModel getMasterAdminClient()

Specified by:

getMasterAdminClient in interface RealmModel

setMasterAdminClient

public void setMasterAdminClient(ClientModel client)

Specified by:

setMasterAdminClient in interface RealmModel

getDefaultRole

public RoleModel getDefaultRole()

Description copied from interface: RealmModel

Returns default realm role. All both realm and client default roles are assigned as composite of this role.

Specified by:

getDefaultRole in interface RealmModel

Returns:

Default role of this realm

setDefaultRole

public void setDefaultRole(RoleModel role)

Description copied from interface: RealmModel

Sets default role for this realm

Specified by:

setDefaultRole in interface RealmModel

Parameters:

role - to be set

isIdentityFederationEnabled

public boolean isIdentityFederationEnabled()

Specified by:

isIdentityFederationEnabled in interface RealmModel

isInternationalizationEnabled

public boolean isInternationalizationEnabled()

Specified by:

isInternationalizationEnabled in interface RealmModel

setInternationalizationEnabled

public void setInternationalizationEnabled(boolean enabled)

Specified by:

setInternationalizationEnabled in interface RealmModel

getSupportedLocalesStream

public Stream<String> getSupportedLocalesStream()

Description copied from interface: RealmModel

Returns supported locales as a stream.

Specified by:

getSupportedLocalesStream in interface RealmModel

Returns:

Stream of String. Never returns null.

setSupportedLocales

public void setSupportedLocales(Set<String> locales)

Specified by:

setSupportedLocales in interface RealmModel

getDefaultLocale

public String getDefaultLocale()

Specified by:

getDefaultLocale in interface RealmModel

setDefaultLocale

public void setDefaultLocale(String locale)

Specified by:

setDefaultLocale in interface RealmModel

createGroup

public GroupModel createGroup(String name)

Specified by:

createGroup in interface RealmModel

createGroup

public GroupModel createGroup(String id,
 String name)

Specified by:

createGroup in interface RealmModel

createGroup

public GroupModel createGroup(String name,
 GroupModel toParent)

Specified by:

createGroup in interface RealmModel

createGroup

public GroupModel createGroup(String id,
 String name,
 GroupModel toParent)

Specified by:

createGroup in interface RealmModel

getGroupById

public GroupModel getGroupById(String id)

Specified by:

getGroupById in interface RealmModel

getGroupsStream

public Stream<GroupModel> getGroupsStream()

Description copied from interface: RealmModel

Returns groups as a stream.

Specified by:

getGroupsStream in interface RealmModel

Returns:

Stream of GroupModel. Never returns null.

getGroupsCount

public Long getGroupsCount(Boolean onlyTopGroups)

Specified by:

getGroupsCount in interface RealmModel

getGroupsCountByNameContaining

public Long getGroupsCountByNameContaining(String search)

Specified by:

getGroupsCountByNameContaining in interface RealmModel

getTopLevelGroupsStream

@Deprecated
public Stream<GroupModel> getTopLevelGroupsStream()

Deprecated.

Specified by:

getTopLevelGroupsStream in interface RealmModel

getTopLevelGroupsStream

@Deprecated
public Stream<GroupModel> getTopLevelGroupsStream(Integer first,
 Integer max)

Deprecated.

Specified by:

getTopLevelGroupsStream in interface RealmModel

removeGroup

public boolean removeGroup(GroupModel group)

Specified by:

removeGroup in interface RealmModel

moveGroup

public void moveGroup(GroupModel group,
 GroupModel toParent)

Specified by:

moveGroup in interface RealmModel

getClientScopesStream

public Stream<ClientScopeModel> getClientScopesStream()

Description copied from interface: RealmModel

Returns all client scopes of this realm as a stream.

Specified by:

getClientScopesStream in interface RealmModel

Returns:

Stream of ClientScopeModel. Never returns null.

addClientScope

public ClientScopeModel addClientScope(String name)

Description copied from interface: RealmModel

Creates new client scope with the given name. Internal ID is created automatically. If given name contains spaces, those are replaced by underscores.

Specified by:

addClientScope in interface RealmModel

Parameters:

name - String name of the client scope.

Returns:

Model of the created client scope.

addClientScope

public ClientScopeModel addClientScope(String id,
 String name)

Description copied from interface: RealmModel

Creates new client scope with the given internal ID and name. If given name contains spaces, those are replaced by underscores.

Specified by:

addClientScope in interface RealmModel

Parameters:

id - String id of the client scope.

name - String name of the client scope.

Returns:

Model of the created client scope.

removeClientScope

public boolean removeClientScope(String id)

Description copied from interface: RealmModel

Removes client scope with given id from this realm.

Specified by:

removeClientScope in interface RealmModel

Parameters:

id - of the client scope

Returns:

true if the realm contained the scope and the removal was successful, false otherwise

getClientScopeById

public ClientScopeModel getClientScopeById(String id)

Specified by:

getClientScopeById in interface RealmModel

Parameters:

id - of the client scope

Returns:

Client scope with the given id, or null when the scope does not exist.

addDefaultClientScope

public void addDefaultClientScope(ClientScopeModel clientScope,
 boolean defaultScope)

Description copied from interface: RealmModel

Adds given client scope among default/optional client scopes of this realm. The scope will be assigned to each new client.

Specified by:

addDefaultClientScope in interface RealmModel

Parameters:

clientScope - to be added

defaultScope - if true the scope will be added among default client scopes, if false it will be added among optional client scopes

removeDefaultClientScope

public void removeDefaultClientScope(ClientScopeModel clientScope)

Description copied from interface: RealmModel

Removes given client scope from default or optional client scopes of this realm.

Specified by:

removeDefaultClientScope in interface RealmModel

Parameters:

clientScope - to be removed

createOrUpdateRealmLocalizationTexts

public void createOrUpdateRealmLocalizationTexts(String locale,
 Map<String,String> localizationTexts)

Description copied from interface: RealmModel

Creates or updates the realm-specific localization texts for the given locale. This method will not delete any text. It updates texts, which are already stored or create new ones if the key does not exist yet.

Specified by:

createOrUpdateRealmLocalizationTexts in interface RealmModel

removeRealmLocalizationTexts

public boolean removeRealmLocalizationTexts(String locale)

Specified by:

removeRealmLocalizationTexts in interface RealmModel

getRealmLocalizationTexts

public Map<String,Map<String,String>> getRealmLocalizationTexts()

Specified by:

getRealmLocalizationTexts in interface RealmModel

getRealmLocalizationTextsByLocale

public Map<String,String> getRealmLocalizationTextsByLocale(String locale)

Specified by:

getRealmLocalizationTextsByLocale in interface RealmModel

getDefaultClientScopesStream

public Stream<ClientScopeModel> getDefaultClientScopesStream(boolean defaultScope)

Description copied from interface: RealmModel

Returns default client scopes of this realm either default ones or optional ones.

Specified by:

getDefaultClientScopesStream in interface RealmModel

Parameters:

defaultScope - if true default client scopes are returned, if false optional client scopes are returned.

Returns:

Stream of ClientScopeModel. Never returns null.

addToDefaultRoles

public void addToDefaultRoles(RoleModel role)

Description copied from interface: RealmModel

Adds a role as a composite to default role of this realm.

Specified by:

addToDefaultRoles in interface RealmModel

Parameters:

role - to be added

createClientInitialAccessModel

public ClientInitialAccessModel createClientInitialAccessModel(int expiration,
 int count)

Specified by:

createClientInitialAccessModel in interface RealmModel

getClientInitialAccessModel

public ClientInitialAccessModel getClientInitialAccessModel(String id)

Specified by:

getClientInitialAccessModel in interface RealmModel

removeClientInitialAccessModel

public void removeClientInitialAccessModel(String id)

Specified by:

removeClientInitialAccessModel in interface RealmModel

getClientInitialAccesses

public Stream<ClientInitialAccessModel> getClientInitialAccesses()

Specified by:

getClientInitialAccesses in interface RealmModel

decreaseRemainingCount

public void decreaseRemainingCount(ClientInitialAccessModel clientInitialAccess)

Specified by:

decreaseRemainingCount in interface RealmModel

getRole

public RoleModel getRole(String name)

Specified by:

getRole in interface RoleContainerModel

addRole

public RoleModel addRole(String name)

Specified by:

addRole in interface RoleContainerModel

addRole

public RoleModel addRole(String id,
 String name)

Specified by:

addRole in interface RoleContainerModel

removeRole

public boolean removeRole(RoleModel role)

Specified by:

removeRole in interface RoleContainerModel

getRolesStream

public Stream<RoleModel> getRolesStream()

Description copied from interface: RoleContainerModel

Returns available roles as a stream.

Specified by:

getRolesStream in interface RoleContainerModel

Returns:

Stream of RoleModel. Never returns null.

getRolesStream

public Stream<RoleModel> getRolesStream(Integer firstResult,
 Integer maxResults)

Description copied from interface: RoleContainerModel

Returns available roles as a stream.

Specified by:

getRolesStream in interface RoleContainerModel

Parameters:

firstResult - Integer Index of the first desired role. Ignored if negative or null.

maxResults - Integer Maximum number of returned roles. Ignored if negative or null.

Returns:

Stream of RoleModel. Never returns null.

searchForRolesStream

public Stream<RoleModel> searchForRolesStream(String search,
 Integer first,
 Integer max)

Description copied from interface: RoleContainerModel

Searches roles by the given name. Returns all roles that match the given filter.

Specified by:

searchForRolesStream in interface RoleContainerModel

Parameters:

search - String Name of the role to be used as a filter.

first - Integer Index of the first desired role. Ignored if negative or null.

max - Integer Maximum number of returned roles. Ignored if negative or null.

Returns:

Stream of RoleModel. Never returns null.

isOrganizationsEnabled

public boolean isOrganizationsEnabled()

Specified by:

isOrganizationsEnabled in interface RealmModel

setOrganizationsEnabled

public void setOrganizationsEnabled(boolean organizationsEnabled)

Specified by:

setOrganizationsEnabled in interface RealmModel