Package jetbrains.buildServer.serverSide.auth

Class LoginModuleDescriptorAdapter

java.lang.Object

jetbrains.buildServer.serverSide.auth.AuthModuleTypeAdapter

jetbrains.buildServer.serverSide.auth.LoginModuleDescriptorAdapter

All Implemented Interfaces:

AuthModuleType, LoginModuleDescriptor

Direct Known Subclasses:

DefaultLoginModuleDescriptor, MockLoginModuleDescriptor, SpecialUsersLoginModuleDescriptor, TokenBasedLoginModuleDescriptor

public abstract class LoginModuleDescriptorAdapter
extends AuthModuleTypeAdapter
implements LoginModuleDescriptor

Adapter for LoginModuleDescriptor

Since:

8.0

Constructor Summary

Constructors

Constructor	Description
LoginModuleDescriptorAdapter()

Method Summary

Modifier and Type	Method	Description
Map<String,?>	getJAASOptions(Map<String,String> properties)	Options to pass to JAAS login module.
Map<String,?>	getOptions()	Options to pass to JAAS login module
String	getTextForLoginPage()	Returns description to be shown on the login page unless it is overridden by user in server configuration.
Collection<String>	validate(Map<String,String> properties)	Validates the current login module settings and returns the set of errors if found.

Methods inherited from class jetbrains.buildServer.serverSide.auth.AuthModuleTypeAdapter

describeProperties, getDefaultProperties, getDescription, getDisplayName, getEditPropertiesJspFilePath, isMultipleInstancesAllowed

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.auth.AuthModuleType

describeProperties, getDefaultProperties, getDescription, getDisplayName, getEditPropertiesJspFilePath, getName, isMultipleInstancesAllowed

Methods inherited from interface jetbrains.buildServer.serverSide.auth.LoginModuleDescriptor

getLoginModuleClass

Constructor Detail

LoginModuleDescriptorAdapter

public LoginModuleDescriptorAdapter()

Method Detail

getOptions

@Nullable
public Map<String,?> getOptions()

Description copied from interface: LoginModuleDescriptor

Options to pass to JAAS login module

Specified by:

getOptions in interface LoginModuleDescriptor

Returns:

Options to pass to JAAS login module

getJAASOptions

@Nullable
public Map<String,?> getJAASOptions(@NotNull
                                          Map<String,String> properties)

Description copied from interface: LoginModuleDescriptor

Options to pass to JAAS login module.

Specified by:

getJAASOptions in interface LoginModuleDescriptor

Parameters:

properties - authentication module options

Returns:

Options to pass to JAAS login module

getTextForLoginPage

@Nullable
public String getTextForLoginPage()

Description copied from interface: LoginModuleDescriptor

Returns description to be shown on the login page unless it is overridden by user in server configuration.

Specified by:

getTextForLoginPage in interface LoginModuleDescriptor

Returns:

description to be shown on the login page unless it is overridden by user in server configuration

validate

@Nullable
public Collection<String> validate(@NotNull
                                   Map<String,String> properties)

Description copied from interface: AuthModuleType

Validates the current login module settings and returns the set of errors if found. Should return null if no errors found.

Specified by:

validate in interface AuthModuleType

Parameters:

properties - properties

Returns:

the collection of errors.