Class LockingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

se.swedenconnect.bankid.idp.concurrency.LockingFilter

All Implemented Interfaces:

jakarta.servlet.Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

@Component
public class LockingFilter
extends OncePerRequestFilter

A Filter that handles per user locking for the polling critical section.

Author:

Martin Lindström, Felix Hellman

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_RESOURCE_BUSY
static final String	POLLING_PATH	The path to protect.

Fields inherited from class OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
LockingFilter(TryLockRepository locks)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)	Checks if the request is "/api/poll", and locks the same user from accessing the resource.

Methods inherited from class OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class Object

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

Field Details

POLLING_PATH

public static final String POLLING_PATH

The path to protect.

See Also:

• Constant Field Values

ERROR_RESOURCE_BUSY

public static final String ERROR_RESOURCE_BUSY

See Also:

• Constant Field Values

Constructor Details

LockingFilter

public LockingFilter(TryLockRepository locks)

Constructor.

Parameters:

locks - the lock repository

Method Details

doFilterInternal

protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain filterChain)
                         throws jakarta.servlet.ServletException,
IOException

Checks if the request is "/api/poll", and locks the same user from accessing the resource. If the resources is already being accessed, the api will return a HTTP-Status 429.

Specified by:

doFilterInternal in class OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException