com.auth0.web

Class Auth0CallbackHandler

java.lang.Object

com.auth0.web.Auth0CallbackHandler

@Component
public class Auth0CallbackHandler
extends Object

The Servlet endpoint used as the callback handler in the Oauth2 authorization code grant flow. This servlet is called back via a redirect from Auth0 (IdP) post authentication supplying an authorization code Using inheritance or composition leverage this callback handler from a Controller Example usage - Simply extend this class and define Controller in subclass

package com.auth0.example;

import com.auth0.web.Auth0CallbackHandler;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

 @Controller
public class CallbackController extends Auth0CallbackHandler {

     @RequestMapping(value = "${auth0.loginCallback}", method = RequestMethod.GET)
    protected void callback(final HttpServletRequest req, final HttpServletResponse res) throws ServletException, IOException {
        super.handle(req, res);
    }
}
 

Field Summary

Fields

Modifier and Type	Field and Description
protected com.auth0.Auth0Client	auth0Client
protected Auth0Config	auth0Config
protected String	redirectOnFail
protected String	redirectOnSuccess

Constructor Summary

Constructors

Constructor and Description
Auth0CallbackHandler()

Method Summary

Modifier and Type	Method and Description
protected com.auth0.Tokens	fetchTokens(javax.servlet.http.HttpServletRequest req) Get tokens for this request
void	handle(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Entrypoint for http request 1).
protected boolean	hasError(javax.servlet.http.HttpServletRequest req) Checks for the presence of an error in the http servlet request params
protected boolean	isValidRequest(javax.servlet.http.HttpServletRequest req) Indicates whether the request is deemed valid
protected boolean	isValidState(javax.servlet.http.HttpServletRequest req) Indicates whether the nonce value in storage matches the nonce value passed with the http servlet request
protected void	onFailure(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Exception e) Actions / navigation to take when a request is deemed unsuccessful by this callback handler
protected void	onSuccess(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Actions / navigation to take when a request is deemed successful by this callback handler
protected void	setAuth0Client(com.auth0.Auth0Client auth0Client)
protected void	setAuth0Config(Auth0Config auth0Config)
protected void	store(com.auth0.Tokens tokens, com.auth0.Auth0User user, javax.servlet.http.HttpServletRequest req) Store tokens and auth0User

Methods inherited from class java.lang.Object

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

Field Detail

redirectOnSuccess

protected String redirectOnSuccess

redirectOnFail

protected String redirectOnFail

auth0Config

protected Auth0Config auth0Config

auth0Client

protected com.auth0.Auth0Client auth0Client

Constructor Detail

Auth0CallbackHandler

public Auth0CallbackHandler()

Method Detail

setAuth0Client

@Autowired
protected void setAuth0Client(com.auth0.Auth0Client auth0Client)

setAuth0Config

@Autowired
protected void setAuth0Config(Auth0Config auth0Config)

handle

public void handle(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res)
            throws IOException,
                   javax.servlet.ServletException

Entrypoint for http request 1). Responsible for validating the request and ensuring the nonce value in session storage matches the nonce value passed to this endpoint. 2). Exchanging the authorization code received with this http request for tokens 3). Getting user profile information using id token 4). Storing both tokens and user profile information into session storage 5). Clearing the stored nonce value out of state storage 6). Handling success and any failure outcomes

Throws:

IOException

javax.servlet.ServletException

onSuccess

protected void onSuccess(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)
                  throws javax.servlet.ServletException,
                         IOException

Actions / navigation to take when a request is deemed successful by this callback handler

Throws:

javax.servlet.ServletException

IOException

onFailure

protected void onFailure(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res,
                         Exception e)
                  throws javax.servlet.ServletException,
                         IOException

Actions / navigation to take when a request is deemed unsuccessful by this callback handler

Throws:

javax.servlet.ServletException

IOException

store

protected void store(com.auth0.Tokens tokens,
                     com.auth0.Auth0User user,
                     javax.servlet.http.HttpServletRequest req)

Store tokens and auth0User

Parameters:

tokens - the tokens

user - the user profile

req - the http servlet request

fetchTokens

protected com.auth0.Tokens fetchTokens(javax.servlet.http.HttpServletRequest req)

Get tokens for this request

Parameters:

req - the http servlet request

Returns:

the tokens associated with the authentication request

isValidRequest

protected boolean isValidRequest(javax.servlet.http.HttpServletRequest req)
                          throws IOException

Indicates whether the request is deemed valid

Parameters:

req - the http servlet request

Returns:

boolean whether this request is deemed valid

Throws:

IOException

hasError

protected boolean hasError(javax.servlet.http.HttpServletRequest req)

Checks for the presence of an error in the http servlet request params

Parameters:

req - the http servlet request

Returns:

boolean whether this http servlet request indicates an error was present

isValidState

protected boolean isValidState(javax.servlet.http.HttpServletRequest req)

Indicates whether the nonce value in storage matches the nonce value passed with the http servlet request

Parameters:

req - the http servlet request

Returns:

boolean whether nonce value in storage matches the nonce value in the http request