Package io.vertx.mutiny.ext.auth.authorization

Interface AuthorizationProvider

All Superinterfaces:
MutinyDelegate
All Known Implementing Classes:
AuthorizationProvider.AuthorizationProviderImpl, JWTAuthorization, KeycloakAuthorization, MicroProfileAuthorization, MongoAuthorization, PropertyFileAuthorization, ScopeAuthorization, SqlAuthorization
public interface AuthorizationProvider extends MutinyDelegate
The role of an AuthorizationProvider is to return a set of Authorization. Note that each AuthorizationProvider must provide its own unique Id

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
stephane bastian
See Also:
  • AuthorizationProvider

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    AuthorizationProvider.AuthorizationProviderImpl
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<Void>
    getAuthorizations(User user)
    Updates the user with the set of authorizations.
    io.vertx.ext.auth.authorization.AuthorizationProvider
    getDelegate()
     
    String
    getId()
    returns the id of the authorization provider
    static AuthorizationProvider
    newInstance(io.vertx.ext.auth.authorization.AuthorizationProvider delegate)
    Creates a new instance of the AuthorizationProvider.

  • Method Details

    • getDelegate

      io.vertx.ext.auth.authorization.AuthorizationProvider getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • getAuthorizations

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> getAuthorizations(User user)
      Updates the user with the set of authorizations.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      user - user to lookup and update.
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.auth.authorization.AuthorizationProvider#getAuthorizations(User)

    • getId

      String getId()
      returns the id of the authorization provider
      Returns:

    • newInstance

      static AuthorizationProvider newInstance(io.vertx.ext.auth.authorization.AuthorizationProvider delegate)
      Creates a new instance of the AuthorizationProvider.