Package io.vertx.mutiny.ext.auth.mongo

Class MongoAuthorization

java.lang.Object
io.vertx.mutiny.ext.auth.mongo.MongoAuthorization
All Implemented Interfaces:
MutinyDelegate, AuthorizationProvider
public class MongoAuthorization extends Object implements AuthorizationProvider, MutinyDelegate
An extension of AuthProvider which is using MongoClient as store

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

Author:
francoisprunier
See Also:
  • MongoAuthorization

  • Field Details

    • DEFAULT_COLLECTION_NAME

      public static final String DEFAULT_COLLECTION_NAME
      The default name of the collection to be used
      See Also:

    • DEFAULT_USERNAME_FIELD

      public static final String DEFAULT_USERNAME_FIELD
      The default name of the property for the username, like it is stored in mongodb
      See Also:

    • DEFAULT_ROLE_FIELD

      public static final String DEFAULT_ROLE_FIELD
      The default name of the property for the roles, like it is stored in mongodb. Roles are expected to be saved as JsonArray
      See Also:

    • DEFAULT_PERMISSION_FIELD

      public static final String DEFAULT_PERMISSION_FIELD
      The default name of the property for the permissions, like it is stored in mongodb. Permissions are expected to be saved as JsonArray
      See Also:

    • __TYPE_ARG

      public static final TypeArg<MongoAuthorization> __TYPE_ARG

  • Constructor Details

    • MongoAuthorization

      public MongoAuthorization(io.vertx.ext.auth.mongo.MongoAuthorization delegate)
      Create a new instance of MongoAuthorization delegating to the given (non-null) instance of MongoAuthorization.

    • MongoAuthorization

      public MongoAuthorization(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.mongo.MongoAuthorization getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface AuthorizationProvider
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • getAuthorizations

      @CheckReturnValue public 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.

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

    • getAuthorizationsAndAwait

      public void getAuthorizationsAndAwait(User user)
      Updates the user with the set of authorizations.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      user - user to lookup and update.
      See Also:
      • io.vertx.ext.auth.mongo.MongoAuthorization#getAuthorizations(User)

    • getAuthorizationsAndForget

      public MongoAuthorization getAuthorizationsAndForget(User user)
      Updates the user with the set of authorizations.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      user - user to lookup and update.
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.ext.auth.mongo.MongoAuthorization#getAuthorizations(User)

    • create

      public static MongoAuthorization create(String providerId, MongoClient mongoClient, io.vertx.ext.auth.mongo.MongoAuthorizationOptions options)
      Creates an instance of MongoAuthorization by using the given MongoClient and configuration object.
      Parameters:
      providerId - the provider ID to differentiate from others
      mongoClient - an instance of MongoClient to be used for data storage and retrival
      options - the configuration object for the current instance.
      Returns:
      the created instance of MongoAuthorization

    • getId

      public String getId()
      returns the id of the authorization provider
      Specified by:
      getId in interface AuthorizationProvider
      Returns:

    • newInstance

      public static MongoAuthorization newInstance(io.vertx.ext.auth.mongo.MongoAuthorization delegate)
      Creates a new instance of the MongoAuthorization.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object