io.vertx.ext.auth.authorization

Interface AuthorizationProvider

All Known Subinterfaces:

JDBCAuthorization, JWTAuthorization, KeycloakAuthorization, MicroProfileAuthorization, MongoAuthorization, PropertyFileAuthorization, ScopeAuthorization, SqlAuthorization

public interface AuthorizationProvider

The role of an AuthorizationProvider is to return a set of Authorization. Note that each AuthorizationProvider must provide its own unique Id

Author:

stephane bastian

Method Summary

Modifier and Type	Method and Description
static AuthorizationProvider	create(String id, Set<Authorization> authorizations) create an authorization provider with the specified id and authorizations
default Future<Void>	getAuthorizations(User user) Updates the user with the set of authorizations.
void	getAuthorizations(User user, Handler<AsyncResult<Void>> handler) Updates the user with the set of authorizations.
String	getId() returns the id of the authorization provider

Method Detail

create

static AuthorizationProvider create(String id,
                                    Set<Authorization> authorizations)

create an authorization provider with the specified id and authorizations

Parameters:

id -

authorizations -

Returns:

getId

String getId()

returns the id of the authorization provider

Returns:

getAuthorizations

void getAuthorizations(User user,
                       Handler<AsyncResult<Void>> handler)

Updates the user with the set of authorizations.

Parameters:

user - user to lookup and update

handler - result handler

getAuthorizations

default Future<Void> getAuthorizations(User user)

Updates the user with the set of authorizations.

Parameters:

user - user to lookup and update.

Returns:

Future void to signal end of asynchronous call.