Package org.pac4j.vertx.handler.impl

Class CallbackDeployingPac4jAuthHandler

java.lang.Object

io.vertx.ext.web.handler.impl.AuthHandlerImpl

org.pac4j.vertx.handler.impl.SecurityHandler

org.pac4j.vertx.handler.impl.CallbackDeployingPac4jAuthHandler

All Implemented Interfaces:

io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>, io.vertx.ext.web.handler.AuthHandler

public class CallbackDeployingPac4jAuthHandler
extends SecurityHandler

Version of the Pac4j authentication handler which auto-deploys a CallbackHandler on the relative URL derived from the path of the callback URL specified in the Clients object held within the Config object supplied in the constructor. There is no requirement to use this handler rather than a SecurityHandler (and indeed where the same callback URL is being potentially used for multiple authentication handlers it may muddy the waters) but it is supplied as a convenience to anyone wanting to perform very simple indirect authentications. If there is a desire to use the same callback for multiple indirect authentications, it is recommended to explicitly deploy a CallbackHandler for clarity.

Since:

2.0.0

Author:

Jeremy Prime

Field Summary

Fields inherited from class org.pac4j.vertx.handler.impl.SecurityHandler

authorizerName, clientNames, config, matcherName, multiProfile, vertx

Fields inherited from class io.vertx.ext.web.handler.impl.AuthHandlerImpl

authorities, authProvider, realm

Constructor Summary

Constructors

Constructor	Description
CallbackDeployingPac4jAuthHandler(io.vertx.core.Vertx vertx, org.pac4j.core.context.session.SessionStore<VertxWebContext> sessionStore, org.pac4j.core.config.Config config, io.vertx.ext.web.Router router, Pac4jAuthProvider authProvider, SecurityHandlerOptions options, CallbackHandlerOptions callbackOptions)

Method Summary

Methods inherited from class org.pac4j.vertx.handler.impl.SecurityHandler

handle, parseCredentials, toTechnicalException, unexpectedFailure

Methods inherited from class io.vertx.ext.web.handler.impl.AuthHandlerImpl

addAuthorities, addAuthority, authenticateHeader, authorize, processException

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackDeployingPac4jAuthHandler

public CallbackDeployingPac4jAuthHandler(io.vertx.core.Vertx vertx,
                                         org.pac4j.core.context.session.SessionStore<VertxWebContext> sessionStore,
                                         org.pac4j.core.config.Config config,
                                         io.vertx.ext.web.Router router,
                                         Pac4jAuthProvider authProvider,
                                         SecurityHandlerOptions options,
                                         CallbackHandlerOptions callbackOptions)