org.pac4j.vertx.handlers

Class CallbackHandler

java.lang.Object

org.pac4j.vertx.handlers.SessionAwareHandler

org.pac4j.vertx.handlers.RequiresAuthenticationHandler

org.pac4j.vertx.handlers.CallbackHandler

All Implemented Interfaces:

org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest>

public class CallbackHandler
extends RequiresAuthenticationHandler

Callback handler for Vert.x pac4j binding. This handler finishes the stateful authentication process.

Since:

1.0.0

Author:

Michael Remond

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Fields inherited from class org.pac4j.vertx.handlers.SessionAwareHandler

sessionHelper

Constructor Summary

Constructors

Constructor and Description
CallbackHandler(Pac4jHelper pac4jHelper, SessionHelper sessionHelper)
CallbackHandler(String clientName, org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest> delegate, Pac4jHelper pac4jHelper, SessionHelper sessionHelper)

Method Summary

Modifier and Type	Method and Description
protected void	authenticationFailure(org.vertx.java.core.http.HttpServerRequest req, String sessionId, org.vertx.java.core.json.JsonObject sessionAttributes) Default authentication failure strategy; save the original url in session and redirects to the Identity Provider if stateful.
protected void	authenticationSuccess(AuthHttpServerRequest req, String sessionId, org.vertx.java.core.json.JsonObject sessionAttributes) Default authentication success strategy; forwards the request to the next handler if the user has a granted access, sends a 403 forbidden response otherwise.
static String	defaultUrl(String url, String defaultUrl) This method returns the default url from a specified url compared with a default url.
protected void	retrieveUserProfile(org.vertx.java.core.http.HttpServerRequest req, String sessionId, org.vertx.java.core.json.JsonObject sessionAttributes, org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler) Returns the User Profile from the session if stateful or from the credentials if stateless.

Methods inherited from class org.pac4j.vertx.handlers.RequiresAuthenticationHandler

authenticate, doHandle, getRequireAllRoles, getRequireAnyRole, hasAccess, isAjaxRequest, redirectToIdentityProvider, retrieveOriginalUrl, saveOriginalUrl, saveUrl, saveUserProfile, setRequireAllRoles, setRequireAnyRole

Methods inherited from class org.pac4j.vertx.handlers.SessionAwareHandler

handle, isStateless, saveSessionAttributes

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

CallbackHandler

public CallbackHandler(String clientName,
                       org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest> delegate,
                       Pac4jHelper pac4jHelper,
                       SessionHelper sessionHelper)

CallbackHandler

public CallbackHandler(Pac4jHelper pac4jHelper,
                       SessionHelper sessionHelper)

Method Detail

retrieveUserProfile

protected void retrieveUserProfile(org.vertx.java.core.http.HttpServerRequest req,
                                   String sessionId,
                                   org.vertx.java.core.json.JsonObject sessionAttributes,
                                   org.vertx.java.core.Handler<org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject>> handler)

Description copied from class: RequiresAuthenticationHandler

Returns the User Profile from the session if stateful or from the credentials if stateless.

Overrides:

retrieveUserProfile in class RequiresAuthenticationHandler

Parameters:

req - the HTTP request

sessionId - the session identifier

sessionAttributes - the session attributes

handler - the handler

authenticationSuccess

protected void authenticationSuccess(AuthHttpServerRequest req,
                                     String sessionId,
                                     org.vertx.java.core.json.JsonObject sessionAttributes)

Description copied from class: RequiresAuthenticationHandler

Default authentication success strategy; forwards the request to the next handler if the user has a granted access, sends a 403 forbidden response otherwise.

Overrides:

authenticationSuccess in class RequiresAuthenticationHandler

Parameters:

req - the HTTP request

sessionId - the session identifier

sessionAttributes - the session attributes

authenticationFailure

protected void authenticationFailure(org.vertx.java.core.http.HttpServerRequest req,
                                     String sessionId,
                                     org.vertx.java.core.json.JsonObject sessionAttributes)

Description copied from class: RequiresAuthenticationHandler

Default authentication failure strategy; save the original url in session and redirects to the Identity Provider if stateful. Sends an unauthorized response if stateless.

Overrides:

authenticationFailure in class RequiresAuthenticationHandler

Parameters:

req - the HTTP request

sessionId - the session identifier

sessionAttributes - the session attributes

defaultUrl

public static String defaultUrl(String url,
                                String defaultUrl)

This method returns the default url from a specified url compared with a default url.

Parameters:

url - a specific url

defaultUrl - the default url

Returns:

the default url