Package jetbrains.buildServer.controllers.interceptors.auth

Interface HttpAuthenticationScheme

All Superinterfaces:

AuthModuleType

All Known Subinterfaces:

ProtocolBasedHttpAuthenticationScheme

All Known Implementing Classes:

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

@UserImplemented
public interface HttpAuthenticationScheme
extends AuthModuleType

Represents the interface of HTTP authentication scheme

Since:

8.0

See Also:

HttpAuthenticationSchemeAdapter, HttpAuthenticationResult, AuthorizationHeader, HttpAuthenticationProtocol, ProtocolBasedHttpAuthenticationScheme, HttpAuthUtil

Method Summary

Modifier and Type	Method	Description
HttpAuthenticationResult	processAuthenticationRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,String> properties)	Processes authentication request. If the request does not correspond to this scheme, method must return HttpAuthenticationResult.notApplicable(). If response object is changed inside the method, method must return HttpAuthenticationResult.unauthenticated().
default boolean	shouldSkip2FA(javax.servlet.http.HttpServletRequest request, Map<String,String> properties)	Returns whether two-factor authentication should be skipped when this scheme is used.

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

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

Method Detail

processAuthenticationRequest

@NotNull
HttpAuthenticationResult processAuthenticationRequest(@NotNull
                                                      javax.servlet.http.HttpServletRequest request,
                                                      @NotNull
                                                      javax.servlet.http.HttpServletResponse response,
                                                      @NotNull
                                                      Map<String,String> properties)
                                               throws IOException

Processes authentication request.
If the request does not correspond to this scheme, method must return HttpAuthenticationResult.notApplicable().
If response object is changed inside the method, method must return HttpAuthenticationResult.unauthenticated().

Parameters:

request - request

response - response

properties - properties from config file

Returns:

result of processing, see above

Throws:

IOException - if some I/O error occurred

shouldSkip2FA

default boolean shouldSkip2FA(@NotNull
                              javax.servlet.http.HttpServletRequest request,
                              @NotNull
                              Map<String,String> properties)

Returns whether two-factor authentication should be skipped when this scheme is used.

Parameters:

request - request

properties - properties from config file

Returns:

true if two-factor authentication should be skipped, false otherwise