Interface LoginConfigurationUpdate

    • 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"
      • addAuthModule

        @NotNull
        <T extends AuthModuleTypeAuthModule<T> addAuthModule​(@NotNull
                                                               T authModuleType,
                                                               @NotNull
                                                               Map<String,​String> properties)
        Adds specified auth module with properties to list of configured auth modules. Call AuthConfigManager.persistConfiguration() to persist the change.
        Parameters:
        authModuleType - auth module type
        properties - auth module properties
        Returns:
        created auth module
      • 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 -