Package org.camunda.bpm.engine.rest.security.auth.impl

Class ContainerBasedAuthenticationProvider

java.lang.Object

org.camunda.bpm.engine.rest.security.auth.impl.ContainerBasedAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

Direct Known Subclasses:

OAuth2AuthenticationProvider

public class ContainerBasedAuthenticationProvider
extends Object
implements AuthenticationProvider

Constructor Summary

Constructors

Constructor	Description
ContainerBasedAuthenticationProvider()

Method Summary

Modifier and Type	Method	Description
void	augmentResponseByAuthenticationChallenge(jakarta.servlet.http.HttpServletResponse response, ProcessEngine engine)	Callback to add an authentication challenge to the response to the client.
AuthenticationResult	extractAuthenticatedUser(jakarta.servlet.http.HttpServletRequest request, ProcessEngine engine)	Checks the request for authentication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContainerBasedAuthenticationProvider

public ContainerBasedAuthenticationProvider()

Method Details

extractAuthenticatedUser

public AuthenticationResult extractAuthenticatedUser(jakarta.servlet.http.HttpServletRequest request,
 ProcessEngine engine)

Description copied from interface: AuthenticationProvider

Checks the request for authentication. May not return null, but always an AuthenticationResult that indicates, whether authentication was successful, and, if true, always provides the authenticated user. The result can only be successful if a valid user id was provided in the request. It is not required to provide the group or tenant id, as they will be resolved via the IdentityService (e.g. ProcessEngineAuthenticationFilter.setAuthenticatedUser(org.camunda.bpm.engine.ProcessEngine, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>)).

Specified by:

extractAuthenticatedUser in interface AuthenticationProvider

Parameters:

request - the request to authenticate

engine - the process engine the request addresses. May be used to authenticate against the engine's identity service.

augmentResponseByAuthenticationChallenge

public void augmentResponseByAuthenticationChallenge(jakarta.servlet.http.HttpServletResponse response,
 ProcessEngine engine)

Description copied from interface: AuthenticationProvider

Callback to add an authentication challenge to the response to the client. Called in case of unsuccessful authentication.

For example, a Http Basic auth implementation may set the WWW-Authenticate header to Basic realm="engine name".

Specified by:

augmentResponseByAuthenticationChallenge in interface AuthenticationProvider

engine - the process engine the request addressed. May be considered as an authentication realm to create a specific authentication challenge