LoginModuleDescriptor (javadoc 2024.12-174331 API)

All Superinterfaces:

AuthModuleType

All Known Implementing Classes:

DefaultLoginModuleDescriptor, LoginModuleDescriptorAdapter, MockLoginModuleDescriptor, SpecialUsersLoginModuleDescriptor, TokenBasedLoginModuleDescriptor
```
public interface LoginModuleDescriptor
extends AuthModuleType
```
Describes a login module. TeamCity supports JAAS login modules (LoginModule) only. As a result of successful authentication login module must add a ServerPrincipal object to the authorized subject.
In case when this login module cannot authenticate the specified user (e.g. user does not exist and login module does not want it to be created) it must throw NotApplicableLoginException. Then TeamCity will try the next login module.
Please refer to JAAS documentation for more information about writing login modules.
See also jetbrains.buildServer.controllers.login.LoginPageProvider for affecting web-side login.

See Also:

LoginModuleDescriptorAdapter, LoginModuleUtil

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`Map<String,?>`	`getJAASOptions(Map<String,String> properties)`	Options to pass to JAAS login module.
`Class<? extends LoginModule>`	`getLoginModuleClass()`
`Map<String,?>`	`getOptions()`	Deprecated. use `getJAASOptions(java.util.Map)`
`String`	`getTextForLoginPage()`	Returns description to be shown on the login page unless it is overridden by user in server configuration.

Methods inherited from interface jetbrains.buildServer.serverSide.auth.AuthModuleType
describeProperties, getDefaultProperties, getDescription, getDisplayName, getEditPropertiesJspFilePath, getName, isMultipleInstancesAllowed, validate

- Method Detail
  - getLoginModuleClass
```
Class<? extends LoginModule> getLoginModuleClass()
```
  - getOptions
```
@Deprecated
@Nullable
Map<String,?> getOptions()
```
    Deprecated.
    use getJAASOptions(java.util.Map)
    
    Options to pass to JAAS login module
    
    Returns:
    
    Options to pass to JAAS login module
  - getJAASOptions
```
@Nullable
Map<String,?> getJAASOptions(@NotNull
                                   Map<String,String> properties)
```
    Options to pass to JAAS login module.
    
    Parameters:
    
    properties - authentication module options
    
    Returns:
    
    Options to pass to JAAS login module
    
    Since:
    
    8.0
  - getTextForLoginPage
```
@Nullable
String getTextForLoginPage()
```
    Returns description to be shown on the login page unless it is overridden by user in server configuration.
    
    Returns:
    
    description to be shown on the login page unless it is overridden by user in server configuration