Package org.camunda.bpm.spring.boot.starter.security.oauth2.impl

Class AuthorizeTokenFilter

java.lang.Object
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.OncePerRequestFilter
org.camunda.bpm.spring.boot.starter.security.oauth2.impl.AuthorizeTokenFilter
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 class AuthorizeTokenFilter extends org.springframework.web.filter.OncePerRequestFilter
Authorize or re-authorize (if required) oauth2 client using OAuth2AuthorizedClientManager.
  • If the access token is valid, then does nothing.
  • If the access token is expired, then refreshes it.
  • If authorize failed, then clears the SecurityContext and HttpSession.

References:

  • OAuth2AuthorizedClientManager.authorize(OAuth2AuthorizeRequest)
  • OAuth2AuthorizedClientProvider.authorize(OAuth2AuthorizationContext)
  • DelegatingOAuth2AuthorizedClientProvider.authorize(OAuth2AuthorizationContext)
  • RefreshTokenOAuth2AuthorizedClientProvider.authorize(OAuth2AuthorizationContext)

  • Field Summary

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

    ALREADY_FILTERED_SUFFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthorizeTokenFilter(org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager clientManager)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    authorizeToken(org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken token, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    protected void
    clearContext(jakarta.servlet.http.HttpServletRequest request)
     
    protected void
    doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)
     
    protected boolean
    hasTokenExpired(org.springframework.security.oauth2.core.OAuth2Token token)
     

    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

  • Constructor Details

    • AuthorizeTokenFilter

      public AuthorizeTokenFilter(org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager clientManager)

  • Method Details

    • doFilterInternal

      protected void doFilterInternal(@Nonnull jakarta.servlet.http.HttpServletRequest request, @Nonnull jakarta.servlet.http.HttpServletResponse response, @Nonnull jakarta.servlet.FilterChain filterChain) throws jakarta.servlet.ServletException, IOException
      Specified by:
      doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter
      Throws:
      jakarta.servlet.ServletException
      IOException

    • hasTokenExpired

      protected boolean hasTokenExpired(org.springframework.security.oauth2.core.OAuth2Token token)

    • clearContext

      protected void clearContext(jakarta.servlet.http.HttpServletRequest request)

    • authorizeToken

      protected void authorizeToken(org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken token, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)