Class HttpAuthenticationSchemeAdapter
- java.lang.Object
-
- jetbrains.buildServer.serverSide.auth.AuthModuleTypeAdapter
-
- jetbrains.buildServer.controllers.interceptors.auth.HttpAuthenticationSchemeAdapter
-
- All Implemented Interfaces:
HttpAuthenticationScheme
,AuthModuleType
- Direct Known Subclasses:
ForbiddingDomainsAuthenticationScheme
,GuestHttpAuthenticationScheme
,PresignedTokenHttpAuthenticationScheme
,ProtocolBasedHttpAuthenticationSchemeAdapter
public abstract class HttpAuthenticationSchemeAdapter extends AuthModuleTypeAdapter implements HttpAuthenticationScheme
Adapter forHttpAuthenticationScheme
.- Since:
- 7.1
-
-
Constructor Summary
Constructors Constructor Description HttpAuthenticationSchemeAdapter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract String
doGetName()
String
getName()
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().Collection<String>
validate(Map<String,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
-
-
-
-
Method Detail
-
getName
@NotNull public String getName()
- Specified by:
getName
in interfaceAuthModuleType
- Returns:
- unique identificator (case-insensitive)
-
doGetName
@NotNull protected abstract String doGetName()
-
processAuthenticationRequest
@NotNull public HttpAuthenticationResult processAuthenticationRequest(@NotNull javax.servlet.http.HttpServletRequest request, @NotNull javax.servlet.http.HttpServletResponse response, @NotNull Map<String,String> properties) throws 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 interfaceHttpAuthenticationScheme
- Parameters:
request
- requestresponse
- responseproperties
- properties from config file- Returns:
- result of processing, see above
- Throws:
IOException
- if some I/O error occurred
-
validate
@Nullable public Collection<String> validate(@NotNull Map<String,String> properties)
Description copied from interface:AuthModuleType
Validates the current login module settings and returns the set of errors if found. Should returnnull
if no errors found.- Specified by:
validate
in interfaceAuthModuleType
- Parameters:
properties
- properties- Returns:
- the collection of errors.
-
-