Package jetbrains.buildServer.serverSide.auth

Interface AuthModuleType

All Known Subinterfaces:

HttpAuthenticationScheme, LoginModuleDescriptor, ProtocolBasedHttpAuthenticationScheme, SystemAuthModuleType

All Known Implementing Classes:

AgentHttpAuthenticationScheme, AuthModuleTypeAdapter, AuthorizationHeaderBasedHttpAuthenticationScheme, AzureDevOpsAuthentication, BaseOAuthAuthentication, BasicHttpAuthenticationScheme, BasicProtocolBasedHttpAuthenticationScheme, BitBucketAuthentication, DefaultLoginModuleDescriptor, ForbiddingDomainsAuthenticationScheme, GitHubAuthentication.BaseGitHubAuthentication, GitHubAuthentication.GitHubComAuth, GitHubAuthentication.GitHubEnterpriseAuth, GitLabAuthentication.BaseGitLabAuthentication, GitLabAuthentication.GitLabCeOrEeAuth, GitLabAuthentication.GitLabComAuth, GoogleAuthentication, GuestHttpAuthenticationScheme, HttpAuthenticationSchemeAdapter, LoginModuleDescriptorAdapter, MockLoginModuleDescriptor, PresignedTokenHttpAuthenticationScheme, ProtocolBasedHttpAuthenticationSchemeAdapter, SpaceAuthentication, SpecialUsersLoginModuleDescriptor, TokenBasedHttpAuthenticationScheme, TokenBasedLoginModuleDescriptor

@UserImplemented
public interface AuthModuleType

Describes an authentication module. Authentication module should store own user name in TeamCity user's properties if it differs from TeamCity's login. On login attempt authentication module must find existing user with the specified value of that property and return TeamCity's login for that user or return own user name if user does not exist yet.

Since:

8.0

See Also:

AuthModule, AuthModuleTypeAdapter, AuthModuleUtil, ServerPrincipal

Method Summary

Modifier and Type	Method	Description
String	describeProperties(Map<String,String> properties)	Returns description of the specified properties map to be shown in UI
Map<String,String>	getDefaultProperties()
String	getDescription()	Returns description of the authentication module to show in the UI
String	getDisplayName()	Returns name of the authentication module to show in the UI
String	getEditPropertiesJspFilePath()
String	getName()
boolean	isMultipleInstancesAllowed()
Collection<String>	validate(Map<String,String> properties)	Validates the current login module settings and returns the set of errors if found.

Method Detail

getName

@NotNull
String getName()

Returns:

unique identificator (case-insensitive)

getDisplayName

@NotNull
String getDisplayName()

Returns name of the authentication module to show in the UI

Returns:

name of the authentication module to show in the UI

getDescription

@NotNull
String getDescription()

Returns description of the authentication module to show in the UI

Returns:

description of the authentication module to show in the UI

isMultipleInstancesAllowed

boolean isMultipleInstancesAllowed()

Returns:

true, if multiple instances of this authentication module are allowed, false otherwise

getDefaultProperties

@NotNull
Map<String,String> getDefaultProperties()

Returns:

default properties for this authentication module

getEditPropertiesJspFilePath

@Nullable
String getEditPropertiesJspFilePath()

Returns:

path to JSP file to edit properties of this authentication module or null if authentication module has no properties

describeProperties

@NotNull
String describeProperties(@NotNull
                          Map<String,String> properties)

Returns description of the specified properties map to be shown in UI

Parameters:

properties - properties

Returns:

description of the specified properties map

validate

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

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

Parameters:

properties - properties

Returns:

the collection of errors.

Since:

8.1