jetbrains.buildServer.serverSide.auth
Interface LoginConfiguration

All Superinterfaces:

XmlExternalizable

public interface LoginConfiguration
extends XmlExternalizable

Maintains information about all available login modules. Each login module is described with LoginModuleDescriptor object. To register new login module use method registerLoginModule(LoginModuleDescriptor).

Field Summary

static java.lang.String

DEFAULT_GUEST_USERNAME

Method Summary

javax.security.auth.login.Configuration	createJAASConfiguration() Creates JAAS login configuration.
java.lang.String	getAuthType()
java.lang.String	getGuestUsername() Returns username of the guest user
java.util.Collection<LoginModuleDescriptor>	getRegisteredLoginModules() Returns collection of registered login module descriptors.
LoginModuleDescriptor	getSelectedLoginModuleDescriptor() Returns descriptor of selected login module.
java.lang.String	getTextForLoginPage() Returns text to show on the login page.
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.
void	registerLoginModule(LoginModuleDescriptor moduleDescriptor) Registers new login module

Methods inherited from interface jetbrains.buildServer.XmlExternalizable

writeTo

Field Detail

DEFAULT_GUEST_USERNAME

static final java.lang.String DEFAULT_GUEST_USERNAME

See Also:

Constant Field Values

Method Detail

registerLoginModule

void registerLoginModule(@NotNull
                         LoginModuleDescriptor moduleDescriptor)

Registers new login module

Parameters:

moduleDescriptor - desriptor of the login module

getTextForLoginPage

@Nullable
java.lang.String getTextForLoginPage()

Returns text to show on the login page.

Returns:

isDefaultLoginConfigured

boolean isDefaultLoginConfigured()

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

Returns:

getSelectedLoginModuleDescriptor

@NotNull
LoginModuleDescriptor getSelectedLoginModuleDescriptor()

Returns descriptor of selected login module.

Returns:

isGuestLoginAllowed

boolean isGuestLoginAllowed()

Returns true if guest login is allowed.

Returns:

getGuestUsername

java.lang.String getGuestUsername()

Returns username of the guest user

Returns:

isFreeRegistrationAllowed

boolean isFreeRegistrationAllowed()

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

Returns:

getRegisteredLoginModules

java.util.Collection<LoginModuleDescriptor> getRegisteredLoginModules()

Returns collection of registered login module descriptors.

Returns:

createJAASConfiguration

javax.security.auth.login.Configuration createJAASConfiguration()

Creates JAAS login configuration.

Returns:

getAuthType

java.lang.String getAuthType()