Interface LoginConfigurationUpdate
-
- All Known Subinterfaces:
LoginConfigurationEx
- All Known Implementing Classes:
LoginConfigurationImpl
,SecuredLoginConfiguration
public interface LoginConfigurationUpdate
- Author:
- Sergey.Anchipolevsky Date: 01.10.2007
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T extends AuthModuleType>
AuthModule<T>addAuthModule(T authModuleType, Map<String,String> properties)
Adds specified auth module with properties to list of configured auth modules.AuthModule<LoginModuleDescriptor>
addDefaultLoginModule()
Adds default login module to list of configured auth modules.void
clearConfiguredAuthModules()
Clears all configured authentication modules.void
performBatchChange(Runnable updateAction)
Invokes the specified login configuration update action and firesLoginConfigurationListener.loginConfigurationChanged()
event only once at the end.void
readExternal(org.jdom.Element rootElement)
Reads login configuration from "auth-config.xml".void
setBuildAuthenticationMode(BuildAuthenticationMode buildAuthenticationMode)
Set build authentication mode.void
setFreeRegistrationAllowed(boolean freeRegistrationAllowed)
Enables free user account registration.void
setGuestLoginAllowed(boolean guestLoginAllowed)
Enables guest login.void
setGuestUsername(String username)
Sets username to be used by guest uservoid
setLoginFormCollapsed(boolean collapsed)
Sets whether the login form should be collapsed on the login pagevoid
setRootLoginAllowed(boolean rootLoginAllowed)
Enables root login.void
setSelectedLoginModule(LoginModuleDescriptor loginModuleDescriptor)
Sets current login module.void
setTextForLoginPage(String textForLoginPage)
Sets text to show on the login page.void
setTwoFactorAuthType(TwoFactorAuthenticationType twoFactorAuthType)
Sets type of two-factor authenticationvoid
setTwoFactorSetupDeadline(Date date)
Set deadline for setup of two-factor authentication.
-
-
-
Method Detail
-
clearConfiguredAuthModules
void clearConfiguredAuthModules()
Clears all configured authentication modules.
-
readExternal
void readExternal(@NotNull org.jdom.Element rootElement)
Reads login configuration from "auth-config.xml".- Parameters:
rootElement
- root element from "auth-config.xml"
-
performBatchChange
void performBatchChange(@NotNull Runnable updateAction)
Invokes the specified login configuration update action and firesLoginConfigurationListener.loginConfigurationChanged()
event only once at the end.- Parameters:
updateAction
- action to invoke
-
addAuthModule
@NotNull <T extends AuthModuleType> AuthModule<T> addAuthModule(@NotNull T authModuleType, @NotNull Map<String,String> properties)
Adds specified auth module with properties to list of configured auth modules. CallAuthConfigManager.persistConfiguration()
to persist the change.- Parameters:
authModuleType
- auth module typeproperties
- auth module properties- Returns:
- created auth module
-
addDefaultLoginModule
@TestOnly AuthModule<LoginModuleDescriptor> addDefaultLoginModule()
Adds default login module to list of configured auth modules.
-
setSelectedLoginModule
@TestOnly void setSelectedLoginModule(@NotNull LoginModuleDescriptor loginModuleDescriptor)
Sets current login module.- Parameters:
className
- name of the login module class
-
setTextForLoginPage
void setTextForLoginPage(String textForLoginPage)
Sets text to show on the login page.- Parameters:
textForLoginPage
-
-
setLoginFormCollapsed
void setLoginFormCollapsed(boolean collapsed)
Sets whether the login form should be collapsed on the login page- Since:
- 2020.2.3
-
setGuestUsername
void setGuestUsername(@NotNull String username)
Sets username to be used by guest user
-
setGuestLoginAllowed
void setGuestLoginAllowed(boolean guestLoginAllowed)
Enables guest login.- Parameters:
guestLoginAllowed
-
-
setTwoFactorAuthType
void setTwoFactorAuthType(@NotNull TwoFactorAuthenticationType twoFactorAuthType)
Sets type of two-factor authentication- Parameters:
twoFactorAuthType
-
-
setTwoFactorSetupDeadline
void setTwoFactorSetupDeadline(@NotNull Date date)
Set deadline for setup of two-factor authentication. Applicable only in mandatory mode.- Parameters:
date
-
-
setBuildAuthenticationMode
void setBuildAuthenticationMode(@NotNull BuildAuthenticationMode buildAuthenticationMode)
Set build authentication mode.- Parameters:
buildAuthenticationMode
-
-
setRootLoginAllowed
@TestOnly void setRootLoginAllowed(boolean rootLoginAllowed)
Enables root login.- Parameters:
rootLoginAllowed
-
-
setFreeRegistrationAllowed
@TestOnly void setFreeRegistrationAllowed(boolean freeRegistrationAllowed)
Enables free user account registration. Free registration can be enabled only if default login module selected.- Parameters:
freeRegistrationAllowed
-
-
-