jetbrains.buildServer.serverSide.auth
Interface LoginModuleDescriptor


public interface LoginModuleDescriptor

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.
Please refer to JAAS documentation for more information about writing login modules.
See also LoginPageProvider for affecting web-side login.


Method Summary
 java.lang.String getDisplayName()
          Returns name of the login module to show in the UI
 java.lang.Class<? extends javax.security.auth.spi.LoginModule> getLoginModuleClass()
           
 java.util.Map<java.lang.String,?> getOptions()
          Options to pass to JAAS login module
 java.lang.String getTextForLoginPage()
          Returns description to be shown on the login page unless it is overridden by user in server configuration.
 

Method Detail

getLoginModuleClass

java.lang.Class<? extends javax.security.auth.spi.LoginModule> getLoginModuleClass()

getOptions

@Nullable
java.util.Map<java.lang.String,?> getOptions()
Options to pass to JAAS login module

Returns:

getTextForLoginPage

@Nullable
java.lang.String getTextForLoginPage()
Returns description to be shown on the login page unless it is overridden by user in server configuration.

Returns:

getDisplayName

@Nullable
java.lang.String getDisplayName()
Returns name of the login module to show in the UI

Returns: