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 only valid JWTs are permitted on secured endpoints Success and Failure navigation options are configurable

Constructor Summary

Constructors

Constructor and Description
Auth0Filter(Auth0Config auth0Config)

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain next) Perform filter check on this request - verify tokens exist and verify the id token is valid
void	init(javax.servlet.FilterConfig filterConfig) Called by the web container to indicate to a filter that it is being placed into service.
protected void	onReject(javax.servlet.http.HttpServletResponse res) Navigation to take when a request is rejected by this filter
protected void	onSuccess(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain next, com.auth0.Auth0User auth0User) Navigation to take when a request is successful by this filter
protected boolean	tokensExist(com.auth0.Tokens tokens) Check for existence of id token and access token

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

Called by the web container to indicate to a filter that it is being placed into service. Initialises configuration setup for this filter

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,
                         com.auth0.Auth0User auth0User)
                  throws IOException,
                         javax.servlet.ServletException

Navigation to take when a request is successful by this filter

Throws:

IOException

javax.servlet.ServletException

onReject

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

Navigation to take when a request is rejected by this filter

Throws:

IOException

javax.servlet.ServletException

tokensExist

protected boolean tokensExist(com.auth0.Tokens tokens)

Check for existence of id token and access token

Parameters:

tokens - the tokens object

Returns:

boolean whether both id token and access token exist

doFilter

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

Perform filter check on this request - verify tokens exist and verify the id token is valid

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