vertx / io.vertx.ext.web.handler / ChainAuthHandler

ChainAuthHandler

interface ChainAuthHandler : AuthHandler

An auth handler that chains to a sequence of handlers.

Author
Paulo Lopes

Functions

append

abstract fun append(authHandler: AuthHandler): ChainAuthHandler

Appends a auth provider to the chain.

clear

abstract fun clear(): Unit

Clears the chain.

create

open static fun create(): ChainAuthHandler

remove

abstract fun remove(authHandler: AuthHandler): Boolean

Removes a provider from the chain.

Inherited Functions

addAuthorities

abstract fun addAuthorities(authorities: MutableSet<String>): AuthHandler

Add a set of required authorities for this auth handler

addAuthority

abstract fun addAuthority(authority: String): AuthHandler

Add a required authority for this auth handler

authorize

abstract fun authorize(user: User, handler: Handler<AsyncResult<Void>>): Unit

Authorizes the given user against all added authorities.

parseCredentials

abstract fun parseCredentials(context: RoutingContext, handler: Handler<AsyncResult<JsonObject>>): Unit

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.