Package jetbrains.buildServer.controllers.interceptors.auth

Class HttpAuthenticationSchemeAdapter

java.lang.Object

jetbrains.buildServer.serverSide.auth.AuthModuleTypeAdapter

jetbrains.buildServer.controllers.interceptors.auth.HttpAuthenticationSchemeAdapter

All Implemented Interfaces:

HttpAuthenticationScheme, AuthModuleType

Direct Known Subclasses:

ProtocolBasedHttpAuthenticationSchemeAdapter

public abstract class HttpAuthenticationSchemeAdapter
extends AuthModuleTypeAdapter
implements HttpAuthenticationScheme

Adapter for HttpAuthenticationScheme.

Since:

7.1

Constructor Summary

Constructors

Constructor	Description
HttpAuthenticationSchemeAdapter()

Method Summary

Modifier and Type	Method	Description
protected abstract java.lang.String	doGetName()
java.lang.String	getName()
HttpAuthenticationResult	processAuthenticationRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,java.lang.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().
java.util.Collection<java.lang.String>	validate(java.util.Map<java.lang.String,java.lang.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, isMultipleInstancesAllowed

Methods inherited from interface jetbrains.buildServer.controllers.interceptors.auth.HttpAuthenticationScheme

shouldSkip2FA

Constructor Detail

HttpAuthenticationSchemeAdapter

public HttpAuthenticationSchemeAdapter()

Method Detail

getName

@NotNull
public java.lang.String getName()

Specified by:

getName in interface AuthModuleType

Returns:

unique identificator (case-insensitive)

doGetName

@NotNull
protected abstract java.lang.String doGetName()

processAuthenticationRequest

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

Description copied from interface: HttpAuthenticationScheme

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().

Specified by:

processAuthenticationRequest in interface HttpAuthenticationScheme

Parameters:

request - request

response - response

properties - properties from config file

Returns:

result of processing, see above

Throws:

java.io.IOException - if some I/O error occurred

validate

@Nullable
public java.util.Collection<java.lang.String> validate(@NotNull
                                                       java.util.Map<java.lang.String,java.lang.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.