io.vertx.ext.auth

Interface ChainAuth

All Superinterfaces:

AuthProvider

public interface ChainAuth
extends AuthProvider

Chain several auth providers as if they were one. This is useful for cases where one want to authenticate across several providers, for example, database and fallback to passwd file.

Method Summary

Modifier and Type	Method and Description
ChainAuth	append(AuthProvider other) Appends a auth provider to the chain.
void	clear() Clears the chain.
static ChainAuth	create() Create a Chainable Auth Provider auth provider
boolean	remove(AuthProvider other) Removes a provider from the chain.

Methods inherited from interface io.vertx.ext.auth.AuthProvider

authenticate

Method Detail

create

static ChainAuth create()

Create a Chainable Auth Provider auth provider

Returns:

the auth provider

append

ChainAuth append(AuthProvider other)

Appends a auth provider to the chain.

Parameters:

other - auth provider

Returns:

self

remove

boolean remove(AuthProvider other)

Removes a provider from the chain.

Parameters:

other - provider to remove

Returns:

true if provider was removed, false if non existent in the chain.

clear

void clear()

Clears the chain.