com.auth0.web

Class Auth0Filter

java.lang.Object

com.auth0.web.Auth0Filter

All Implemented Interfaces:

javax.servlet.Filter

public class Auth0Filter
extends Object
implements javax.servlet.Filter

Handles interception on a secured endpoint and does JWT Verification Ensures for instance expired JWT tokens are not permitted access Success and Failure navigation options are also configurable

This filter is ENABLED by setting the auth0.properties entry:

auth0.servletFilterEnabled: true

This option exists because a Spring App may wish to use classes in this library but not have auto-configuration of the Filter enabled

A common scenario for this would be when wishing to leverage Spring Security instead.

Constructor Summary

Constructors

Constructor and Description
Auth0Filter(Auth0Config auth0Config)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain next)
void	init(javax.servlet.FilterConfig filterConfig)
protected void	onReject(javax.servlet.http.HttpServletResponse res)
protected void	onSuccess(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain next, Auth0User auth0User)
protected boolean	tokensExist(Tokens tokens)

Methods inherited from class java.lang.Object

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

Constructor Detail

Auth0Filter

public Auth0Filter(Auth0Config auth0Config)

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

onSuccess

protected void onSuccess(javax.servlet.ServletRequest req,
             javax.servlet.ServletResponse res,
             javax.servlet.FilterChain next,
             Auth0User auth0User)
                  throws IOException,
                         javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

onReject

protected void onReject(javax.servlet.http.HttpServletResponse res)
                 throws IOException,
                        javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

tokensExist

protected boolean tokensExist(Tokens tokens)

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain next)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter