Package jetbrains.buildServer.serverSide.impl.auth

Class LoginConfigurationImpl

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.LoginConfigurationImpl

All Implemented Interfaces:

LoginConfiguration, LoginConfigurationEx, LoginConfigurationUpdate, XmlExternalizable

public class LoginConfigurationImpl
extends Object
implements LoginConfigurationEx

Author:

Pavel.Sher Date: 22.03.2006

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOWED
static String	AUTH_MODULE
static String	AUTH_MODULES
static String	BUILD_AUTH
static String	BUILD_AUTH_MODE
static String	GRACE_PERIOD_EXPIRATION_TIME
static String	GUEST_LOGIN
static String	GUEST_USERNAME
static String	JAAS_NAME
static String	KEY
static String	LOGIN_DESCRIPTION
static String	LOGIN_FORM
static String	LOGIN_FORM_COLLAPSED
static String	PROPERTY
static String	TWO_FACTOR_AUTH
static String	TYPE

Fields inherited from interface jetbrains.buildServer.serverSide.auth.LoginConfiguration

DEFAULT_GUEST_USERNAME

Constructor Summary

Constructors

Constructor	Description
LoginConfigurationImpl(UserModelEx userModel, CriticalErrors criticalErrors, ConfigHistoryManager configHistoryManager, AuditLogFactory auditLogFactory, ServerPaths serverPaths, SecurityContextEx securityContext)

Method Summary

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	addListener(LoginConfigurationListener listener)
void	clearConfiguredAuthModules()	public for tests only
Configuration	createJAASConfiguration()	Creates JAAS login configuration for first configured login module.
Configuration	createJAASConfiguration(AuthModule<LoginModuleDescriptor> loginModuleWithProperties)	Creates JAAS login configuration for specified login module with properties.
AuthModuleType	findAuthModuleTypeByName(String authModuleTypeName)	Returns registered authentication module type with the specified name.
String	getAuthType()	Always returns "mixed" string.
BuildAuthenticationMode	getBuildAuthenticationMode()	Detemines which mode should be used for build authentication.
<T extends AuthModuleType> List<AuthModule<T>>	getConfiguredAuthModules(Class<T> baseClass)	Returns authentication modules configured in config file.
List<AuthModule<LoginModuleDescriptor>>	getConfiguredLoginModules()	Returns enabled login modules in the order they are specified in config file.
<T extends AuthModuleType> AuthModule<T>	getDefaultLoginModule(List<AuthModule<T>> loginModules)
boolean	getDefaultLoginModuleBooleanPropertyValue(String propertyKey)
String	getGuestUsername()	Returns username of the guest user
Collection<AuthModuleType>	getRegisteredAuthModuleTypes()	Returns collection of registered authentication module types.
Collection<LoginModuleDescriptor>	getRegisteredLoginModules()	Returns collection of registered login module descriptors.
LoginModuleDescriptor	getSelectedLoginModuleDescriptor()	Returns descriptor of the first configured login module.
String	getTextForLoginPage()	Returns text to show on the login page.
TwoFactorAuthenticationType	getTwoFactorAuthType()	Returns current TwoFactorAuthenticationType
long	getTwoFactorGracePeriod()	Returns duration of grace period for two-factor authentication.
Date	getTwoFactorSetupDeadline()	Returns deadline for setup of two-factor authentication.
boolean	isAtLeastOneAuthModuleConfigured(Collection<Class<? extends AuthModuleType>> classes)	Returns true if at least one authentication module with one of the specified type classes is configured.
<T extends AuthModuleType> boolean	isAuthModuleConfigured(Class<T> clazz)	Returns true if authentication module with the specified type class is configured.
boolean	isDefaultLoginConfigured()	Returns true if default login module is configured (authorization via own server database).
boolean	isFreeRegistrationAllowed()	Returns true if free user account registration is allowed.
boolean	isGuestLoginAllowed()	Returns true if guest login is allowed.
boolean	isLoginFormCollapsed()
boolean	isOnlyDefaultLoginConfigured()	Returns true if default login module is configured (authorization via own server database) and no other login modules are configured.
boolean	isRootLoginAllowed()	Returns true if root login is allowed.
boolean	isUsersCanChangeOwnPasswords()	Returns true if users are allowed to change own passwords for built-in authentication module.
void	performBatchChange(Runnable updateAction)	Invokes the specified login configuration update action and fires LoginConfigurationListener.loginConfigurationChanged() event only once at the end.
void	readExternal(org.jdom.Element authConfig)	Reads login configuration from "auth-config.xml".
static Map<String,String>	readProperties(org.jdom.Element element)
void	registerAuthModuleType(AuthModuleType authModuleType)	Registers new authentication module
void	registerLoginModule(LoginModuleDescriptor moduleDescriptor)	Registers new login module
void	removeListener(LoginConfigurationListener listener)
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 user
void	setLoginFormCollapsed(boolean collapsed)	Sets whether the login form should be collapsed on the login page
void	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 authentication
void	setTwoFactorSetupDeadline(Date date)	Set deadline for setup of two-factor authentication.
void	unregisterAuthModuleType(AuthModuleType authModuleType)	Unregisters authentication module which was registered by LoginConfiguration.registerAuthModuleType(jetbrains.buildServer.serverSide.auth.AuthModuleType)
void	writeTo(org.jdom.Element authConfig)	Write data to the JDOM element

Methods inherited from class java.lang.Object

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

Field Detail

JAAS_NAME

@NotNull
public static final String JAAS_NAME

See Also:

Constant Field Values

AUTH_MODULES

@NotNull
public static final String AUTH_MODULES

See Also:

Constant Field Values

AUTH_MODULE

@NotNull
public static final String AUTH_MODULE

See Also:

Constant Field Values

TYPE

@NotNull
public static final String TYPE

See Also:

Constant Field Values

PROPERTY

@NotNull
public static final String PROPERTY

See Also:

Constant Field Values

KEY

@NotNull
public static final String KEY

See Also:

Constant Field Values

LOGIN_DESCRIPTION

@NotNull
public static final String LOGIN_DESCRIPTION

See Also:

Constant Field Values

LOGIN_FORM

@NotNull
public static final String LOGIN_FORM

See Also:

Constant Field Values

LOGIN_FORM_COLLAPSED

@NotNull
public static final String LOGIN_FORM_COLLAPSED

See Also:

Constant Field Values

GUEST_LOGIN

@NotNull
public static final String GUEST_LOGIN

See Also:

Constant Field Values

GUEST_USERNAME

@NotNull
public static final String GUEST_USERNAME

See Also:

Constant Field Values

ALLOWED

@NotNull
public static final String ALLOWED

See Also:

Constant Field Values

TWO_FACTOR_AUTH

@NotNull
public static final String TWO_FACTOR_AUTH

See Also:

Constant Field Values

GRACE_PERIOD_EXPIRATION_TIME

@NotNull
public static final String GRACE_PERIOD_EXPIRATION_TIME

See Also:

Constant Field Values

BUILD_AUTH

@NotNull
public static final String BUILD_AUTH

See Also:

Constant Field Values

BUILD_AUTH_MODE

@NotNull
public static final String BUILD_AUTH_MODE

See Also:

Constant Field Values

Constructor Detail

LoginConfigurationImpl

public LoginConfigurationImpl(@NotNull
                              UserModelEx userModel,
                              @NotNull
                              CriticalErrors criticalErrors,
                              @NotNull
                              ConfigHistoryManager configHistoryManager,
                              @NotNull
                              AuditLogFactory auditLogFactory,
                              @NotNull
                              ServerPaths serverPaths,
                              @NotNull
                              SecurityContextEx securityContext)

Method Detail

clearConfiguredAuthModules

public void clearConfiguredAuthModules()

public for tests only

Specified by:

clearConfiguredAuthModules in interface LoginConfigurationUpdate

addAuthModule

@NotNull
public <T extends AuthModuleType> AuthModule<T> addAuthModule(@NotNull
                                                              T authModuleType,
                                                              @NotNull
                                                              Map<String,String> properties)

Description copied from interface: LoginConfigurationUpdate

Adds specified auth module with properties to list of configured auth modules. Call AuthConfigManager.persistConfiguration() to persist the change.

Specified by:

addAuthModule in interface LoginConfigurationUpdate

Parameters:

authModuleType - auth module type

properties - auth module properties

Returns:

created auth module

getConfiguredAuthModules

@NotNull
public <T extends AuthModuleType> List<AuthModule<T>> getConfiguredAuthModules(@Nullable
                                                                               Class<T> baseClass)

Description copied from interface: LoginConfiguration

Returns authentication modules configured in config file.

Specified by:

getConfiguredAuthModules in interface LoginConfiguration

Parameters:

baseClass - auth module descriptor base class to filter auth modules or null to return all

Returns:

see above

createJAASConfiguration

public Configuration createJAASConfiguration()

Description copied from interface: LoginConfiguration

Creates JAAS login configuration for first configured login module.

Specified by:

createJAASConfiguration in interface LoginConfiguration

Returns:

JAAS login configuration

createJAASConfiguration

@NotNull
public Configuration createJAASConfiguration(@NotNull
                                             AuthModule<LoginModuleDescriptor> loginModuleWithProperties)

Description copied from interface: LoginConfiguration

Creates JAAS login configuration for specified login module with properties.

Specified by:

createJAASConfiguration in interface LoginConfiguration

Returns:

JAAS login configuration

getTextForLoginPage

@Nullable
public String getTextForLoginPage()

Description copied from interface: LoginConfiguration

Returns text to show on the login page.

Specified by:

getTextForLoginPage in interface LoginConfiguration

Returns:

text to show on the login page.

setTextForLoginPage

public void setTextForLoginPage(String textForLoginPage)

Description copied from interface: LoginConfigurationUpdate

Sets text to show on the login page.

Specified by:

setTextForLoginPage in interface LoginConfigurationUpdate

isLoginFormCollapsed

public boolean isLoginFormCollapsed()

Specified by:

isLoginFormCollapsed in interface LoginConfigurationEx

getTwoFactorAuthType

public TwoFactorAuthenticationType getTwoFactorAuthType()

Description copied from interface: LoginConfigurationEx

Returns current TwoFactorAuthenticationType

Specified by:

getTwoFactorAuthType in interface LoginConfigurationEx

Returns:

two-factor authentication type

getTwoFactorSetupDeadline

@Nullable
public Date getTwoFactorSetupDeadline()

Description copied from interface: LoginConfigurationEx

Returns deadline for setup of two-factor authentication. Applicable in mandatory mode only. After the deadline, users without grace period would not be able to log in.

Specified by:

getTwoFactorSetupDeadline in interface LoginConfigurationEx

Returns:

global deadline for setup of 2FA

getTwoFactorGracePeriod

public long getTwoFactorGracePeriod()

Description copied from interface: LoginConfigurationEx

Returns duration of grace period for two-factor authentication. This duration is used for grace period refreshes, both for single user and for all server users

Specified by:

getTwoFactorGracePeriod in interface LoginConfigurationEx

Returns:

grace period duration, in milliseconds

getBuildAuthenticationMode

@NotNull
public BuildAuthenticationMode getBuildAuthenticationMode()

Description copied from interface: LoginConfigurationEx

Detemines which mode should be used for build authentication.

Specified by:

getBuildAuthenticationMode in interface LoginConfigurationEx

setLoginFormCollapsed

public void setLoginFormCollapsed(boolean collapsed)

Description copied from interface: LoginConfigurationUpdate

Sets whether the login form should be collapsed on the login page

Specified by:

setLoginFormCollapsed in interface LoginConfigurationUpdate

getSelectedLoginModuleDescriptor

@NotNull
public LoginModuleDescriptor getSelectedLoginModuleDescriptor()

Description copied from interface: LoginConfiguration

Returns descriptor of the first configured login module.

Specified by:

getSelectedLoginModuleDescriptor in interface LoginConfiguration

Returns:

descriptor of the first configured login module

getConfiguredLoginModules

@NotNull
public List<AuthModule<LoginModuleDescriptor>> getConfiguredLoginModules()

Description copied from interface: LoginConfiguration

Returns enabled login modules in the order they are specified in config file. Never returns empty list: if no login modules are configured, returns the list that contains only default login module.

Specified by:

getConfiguredLoginModules in interface LoginConfiguration

Returns:

see above

isDefaultLoginConfigured

public boolean isDefaultLoginConfigured()

Description copied from interface: LoginConfiguration

Returns true if default login module is configured (authorization via own server database).

Specified by:

isDefaultLoginConfigured in interface LoginConfiguration

Returns:

true if default login module is configured (authorization via own server database).

isOnlyDefaultLoginConfigured

public boolean isOnlyDefaultLoginConfigured()

Description copied from interface: LoginConfiguration

Returns true if default login module is configured (authorization via own server database) and no other login modules are configured.

Specified by:

isOnlyDefaultLoginConfigured in interface LoginConfiguration

Returns:

true if default login module is configured

isAuthModuleConfigured

public <T extends AuthModuleType> boolean isAuthModuleConfigured(@NotNull
                                                                 Class<T> clazz)

Description copied from interface: LoginConfiguration

Returns true if authentication module with the specified type class is configured.

Specified by:

isAuthModuleConfigured in interface LoginConfiguration

Returns:

true if authentication module with the specified type class is configured

isAtLeastOneAuthModuleConfigured

public boolean isAtLeastOneAuthModuleConfigured(@NotNull
                                                Collection<Class<? extends AuthModuleType>> classes)

Description copied from interface: LoginConfiguration

Returns true if at least one authentication module with one of the specified type classes is configured.

Specified by:

isAtLeastOneAuthModuleConfigured in interface LoginConfiguration

Returns:

true if at least one authentication module with one of the specified type classes is configured

addDefaultLoginModule

@TestOnly
public AuthModule<LoginModuleDescriptor> addDefaultLoginModule()

Description copied from interface: LoginConfigurationUpdate

Adds default login module to list of configured auth modules.

Specified by:

addDefaultLoginModule in interface LoginConfigurationUpdate

setSelectedLoginModule

@TestOnly
public void setSelectedLoginModule(@NotNull
                                   LoginModuleDescriptor loginModuleDescriptor)

Description copied from interface: LoginConfigurationUpdate

Sets current login module.

Specified by:

setSelectedLoginModule in interface LoginConfigurationUpdate

readExternal

public void readExternal(@NotNull
                         org.jdom.Element authConfig)

Description copied from interface: LoginConfigurationUpdate

Reads login configuration from "auth-config.xml".

Specified by:

readExternal in interface LoginConfigurationUpdate

Parameters:

authConfig - root element from "auth-config.xml"

performBatchChange

public void performBatchChange(@NotNull
                               Runnable updateAction)

Description copied from interface: LoginConfigurationUpdate

Invokes the specified login configuration update action and fires LoginConfigurationListener.loginConfigurationChanged() event only once at the end.

Specified by:

performBatchChange in interface LoginConfigurationUpdate

Parameters:

updateAction - action to invoke

writeTo

public void writeTo(@NotNull
                    org.jdom.Element authConfig)

Description copied from interface: XmlExternalizable

Write data to the JDOM element

Specified by:

writeTo in interface XmlExternalizable

Parameters:

authConfig - - parent element to write data to

readProperties

@NotNull
public static Map<String,String> readProperties(@NotNull
                                                      org.jdom.Element element)

isFreeRegistrationAllowed

public boolean isFreeRegistrationAllowed()

Description copied from interface: LoginConfiguration

Returns true if free user account registration is allowed. Free registration can be enabled only if default login module selected.

Specified by:

isFreeRegistrationAllowed in interface LoginConfiguration

Returns:

true if free user account registration is allowed

isUsersCanChangeOwnPasswords

public boolean isUsersCanChangeOwnPasswords()

Description copied from interface: LoginConfiguration

Returns true if users are allowed to change own passwords for built-in authentication module.

Specified by:

isUsersCanChangeOwnPasswords in interface LoginConfiguration

Returns:

see above

getDefaultLoginModuleBooleanPropertyValue

public boolean getDefaultLoginModuleBooleanPropertyValue(@NotNull
                                                         String propertyKey)

Specified by:

getDefaultLoginModuleBooleanPropertyValue in interface LoginConfigurationEx

getDefaultLoginModule

@Nullable
public <T extends AuthModuleType> AuthModule<T> getDefaultLoginModule(@NotNull
                                                                      List<AuthModule<T>> loginModules)

Specified by:

getDefaultLoginModule in interface LoginConfigurationEx

getRegisteredLoginModules

@NotNull
public Collection<LoginModuleDescriptor> getRegisteredLoginModules()

Description copied from interface: LoginConfiguration

Returns collection of registered login module descriptors.

Specified by:

getRegisteredLoginModules in interface LoginConfiguration

Returns:

collection of registered login module descriptors

getRegisteredAuthModuleTypes

@NotNull
public Collection<AuthModuleType> getRegisteredAuthModuleTypes()

Description copied from interface: LoginConfiguration

Returns collection of registered authentication module types.

Specified by:

getRegisteredAuthModuleTypes in interface LoginConfiguration

Returns:

collection of registered authentication module types

findAuthModuleTypeByName

@Nullable
public AuthModuleType findAuthModuleTypeByName(@NotNull
                                               String authModuleTypeName)

Description copied from interface: LoginConfiguration

Returns registered authentication module type with the specified name.

Specified by:

findAuthModuleTypeByName in interface LoginConfiguration

Returns:

type or null if not found

setFreeRegistrationAllowed

@TestOnly
public void setFreeRegistrationAllowed(boolean freeRegistrationAllowed)

Description copied from interface: LoginConfigurationUpdate

Enables free user account registration. Free registration can be enabled only if default login module selected.

Specified by:

setFreeRegistrationAllowed in interface LoginConfigurationUpdate

isGuestLoginAllowed

public boolean isGuestLoginAllowed()

Description copied from interface: LoginConfiguration

Returns true if guest login is allowed.

Specified by:

isGuestLoginAllowed in interface LoginConfiguration

Returns:

true if guest login is allowed

isRootLoginAllowed

public boolean isRootLoginAllowed()

Description copied from interface: LoginConfiguration

Returns true if root login is allowed.

Specified by:

isRootLoginAllowed in interface LoginConfiguration

Returns:

true if root login is allowed

getGuestUsername

@NotNull
public String getGuestUsername()

Description copied from interface: LoginConfiguration

Returns username of the guest user

Specified by:

getGuestUsername in interface LoginConfiguration

Returns:

username of the guest user

setGuestUsername

public void setGuestUsername(@NotNull
                             String username)

Description copied from interface: LoginConfigurationUpdate

Sets username to be used by guest user

Specified by:

setGuestUsername in interface LoginConfigurationUpdate

setGuestLoginAllowed

public void setGuestLoginAllowed(boolean guestLoginAllowed)

Description copied from interface: LoginConfigurationUpdate

Enables guest login.

Specified by:

setGuestLoginAllowed in interface LoginConfigurationUpdate

setTwoFactorAuthType

public void setTwoFactorAuthType(@NotNull
                                 TwoFactorAuthenticationType twoFactorAuthType)

Description copied from interface: LoginConfigurationUpdate

Sets type of two-factor authentication

Specified by:

setTwoFactorAuthType in interface LoginConfigurationUpdate

setTwoFactorSetupDeadline

public void setTwoFactorSetupDeadline(@NotNull
                                      Date date)

Description copied from interface: LoginConfigurationUpdate

Set deadline for setup of two-factor authentication. Applicable only in mandatory mode.

Specified by:

setTwoFactorSetupDeadline in interface LoginConfigurationUpdate

setBuildAuthenticationMode

public void setBuildAuthenticationMode(@NotNull
                                       BuildAuthenticationMode buildAuthenticationMode)

Description copied from interface: LoginConfigurationUpdate

Set build authentication mode.

Specified by:

setBuildAuthenticationMode in interface LoginConfigurationUpdate

setRootLoginAllowed

@TestOnly
public void setRootLoginAllowed(boolean rootLoginAllowed)

Description copied from interface: LoginConfigurationUpdate

Enables root login.

Specified by:

setRootLoginAllowed in interface LoginConfigurationUpdate

registerLoginModule

public void registerLoginModule(@NotNull
                                LoginModuleDescriptor moduleDescriptor)

Description copied from interface: LoginConfiguration

Registers new login module

Specified by:

registerLoginModule in interface LoginConfiguration

Parameters:

moduleDescriptor - descriptor of the login module

registerAuthModuleType

public void registerAuthModuleType(@NotNull
                                   AuthModuleType authModuleType)

Description copied from interface: LoginConfiguration

Registers new authentication module

Specified by:

registerAuthModuleType in interface LoginConfiguration

Parameters:

authModuleType - type of the authentication module

unregisterAuthModuleType

public void unregisterAuthModuleType(@NotNull
                                     AuthModuleType authModuleType)

Description copied from interface: LoginConfigurationEx

Unregisters authentication module which was registered by LoginConfiguration.registerAuthModuleType(jetbrains.buildServer.serverSide.auth.AuthModuleType)

Specified by:

unregisterAuthModuleType in interface LoginConfigurationEx

Parameters:

authModuleType - type of the authentication module

getAuthType

public final String getAuthType()

Description copied from interface: LoginConfiguration

Always returns "mixed" string.

Specified by:

getAuthType in interface LoginConfiguration

Returns:

see above

addListener

public void addListener(@NotNull
                        LoginConfigurationListener listener)

Specified by:

addListener in interface LoginConfigurationEx

removeListener

public void removeListener(@NotNull
                           LoginConfigurationListener listener)

Specified by:

removeListener in interface LoginConfigurationEx