Class ProcessEngineAuthenticationFilter
java.lang.Object
org.camunda.bpm.engine.rest.security.auth.ProcessEngineAuthenticationFilter
- All Implemented Interfaces:
jakarta.servlet.Filter
Servlet filter to plug in authentication.
Valid init-params:
Parameter | Required | Expected value |
---|---|---|
"authentication-provider" | yes | An implementation of AuthenticationProvider |
"rest-url-pattern-prefix" | no | The expected servlet path. Should only be set, if the underlying JAX-RS application is not deployed as a servlet (e.g. Resteasy allows deployments
as a servlet filter). Value has to match what would be the HttpServletRequest.getServletPath() if it was deployed as a servlet. |
- Author:
- Thorben Lindhauer
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
clearAuthentication
(ProcessEngine engine) void
destroy()
void
doFilter
(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) protected String
extractEngineName
(String requestUrl) May not return nullprotected ProcessEngine
getAddressedEngine
(String engineName) getGroupsOfUser
(ProcessEngine engine, String userId) getTenantsOfUser
(ProcessEngine engine, String userId) void
init
(jakarta.servlet.FilterConfig filterConfig) protected boolean
requiresEngineAuthentication
(String requestUrl) protected void
setAuthenticatedUser
(ProcessEngine engine, String userId, List<String> groupIds, List<String> tenantIds)
-
Field Details
-
WHITE_LISTED_URL_PATTERNS
-
ENGINE_REQUEST_URL_PATTERN
-
DEFAULT_ENGINE_NAME
- See Also:
-
AUTHENTICATION_PROVIDER_PARAM
- See Also:
-
SERVLET_PATH_PREFIX
- See Also:
-
authenticationProvider
-
servletPathPrefix
-
-
Constructor Details
-
ProcessEngineAuthenticationFilter
public ProcessEngineAuthenticationFilter()
-
-
Method Details
-
init
public void init(jakarta.servlet.FilterConfig filterConfig) throws jakarta.servlet.ServletException - Specified by:
init
in interfacejakarta.servlet.Filter
- Throws:
jakarta.servlet.ServletException
-
doFilter
public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException - Specified by:
doFilter
in interfacejakarta.servlet.Filter
- Throws:
IOException
jakarta.servlet.ServletException
-
destroy
public void destroy()- Specified by:
destroy
in interfacejakarta.servlet.Filter
-
setAuthenticatedUser
-
getGroupsOfUser
-
getTenantsOfUser
-
clearAuthentication
-
requiresEngineAuthentication
-
extractEngineName
May not return null -
getAddressedEngine
-