Package org.springframework.security.web.authentication.ott

Class GenerateOneTimeTokenFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.web.authentication.ott.GenerateOneTimeTokenFilter

All Implemented Interfaces:

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public final class GenerateOneTimeTokenFilter
extends org.springframework.web.filter.OncePerRequestFilter

Filter that process a One-Time Token generation request.

Since:

6.4

See Also:

• OneTimeTokenService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GENERATE_URL

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
GenerateOneTimeTokenFilter(OneTimeTokenService tokenService, OneTimeTokenGenerationSuccessHandler tokenGenerationSuccessHandler)

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)
void	setRequestMatcher(RequestMatcher requestMatcher)	Use the given RequestMatcher to match the request.
void	setRequestResolver(GenerateOneTimeTokenRequestResolver requestResolver)	Use the given GenerateOneTimeTokenRequestResolver to resolve GenerateOneTimeTokenRequest.

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

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

Methods inherited from class org.springframework.web.filter.GenericFilterBean

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

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_GENERATE_URL

public static final String DEFAULT_GENERATE_URL

See Also:

• Constant Field Values

Constructor Details

GenerateOneTimeTokenFilter

public GenerateOneTimeTokenFilter(OneTimeTokenService tokenService,
 OneTimeTokenGenerationSuccessHandler tokenGenerationSuccessHandler)

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

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException

setRequestMatcher

public void setRequestMatcher(RequestMatcher requestMatcher)

Use the given RequestMatcher to match the request.

Parameters:

requestMatcher -

setRequestResolver

public void setRequestResolver(GenerateOneTimeTokenRequestResolver requestResolver)

Use the given GenerateOneTimeTokenRequestResolver to resolve GenerateOneTimeTokenRequest.

Parameters:

requestResolver - GenerateOneTimeTokenRequestResolver

Since:

6.5