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

Class MongoAuthorization

java.lang.Object

io.vertx.mutiny.ext.auth.authorization.AuthorizationProvider

io.vertx.mutiny.ext.auth.mongo.MongoAuthorization

All Implemented Interfaces:

MutinyDelegate

public class MongoAuthorization
extends AuthorizationProvider
implements MutinyDelegate

An extension of AuthProvider which is using as store

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TypeArg<MongoAuthorization>	__TYPE_ARG
static final String	DEFAULT_COLLECTION_NAME	The default name of the collection to be used
static final String	DEFAULT_PERMISSION_FIELD	The default name of the property for the permissions, like it is stored in mongodb.
static final String	DEFAULT_ROLE_FIELD	The default name of the property for the roles, like it is stored in mongodb.
static final String	DEFAULT_USERNAME_FIELD	The default name of the property for the username, like it is stored in mongodb

Constructor Summary

Constructors

Constructor	Description
MongoAuthorization(io.vertx.ext.auth.mongo.MongoAuthorization delegate)
MongoAuthorization(Object delegate)

Method Summary

Modifier and Type	Method	Description
static MongoAuthorization	create(String providerId, MongoClient mongoClient, io.vertx.ext.auth.mongo.MongoAuthorizationOptions options)
boolean	equals(Object o)
io.vertx.ext.auth.mongo.MongoAuthorization	getDelegate()
int	hashCode()
static MongoAuthorization	newInstance(io.vertx.ext.auth.mongo.MongoAuthorization arg)
String	toString()

Methods inherited from class io.vertx.mutiny.ext.auth.authorization.AuthorizationProvider

create, getAuthorizations, getAuthorizationsAndAwait, getAuthorizationsAndForget, getId, newInstance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

__TYPE_ARG

public static final TypeArg<MongoAuthorization> __TYPE_ARG

DEFAULT_COLLECTION_NAME

public static final String DEFAULT_COLLECTION_NAME

The default name of the collection to be used

See Also:

• Constant Field Values

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:

• Constant Field Values

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:

• Constant Field Values

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:

• Constant Field Values

Constructor Details

MongoAuthorization

public MongoAuthorization(io.vertx.ext.auth.mongo.MongoAuthorization delegate)

MongoAuthorization

public MongoAuthorization(Object delegate)

Method Details

getDelegate

public io.vertx.ext.auth.mongo.MongoAuthorization getDelegate()

Specified by:

getDelegate in interface MutinyDelegate

Overrides:

getDelegate in class AuthorizationProvider

Returns:

the delegate used by this Mutiny object of generated type

toString

public String toString()

Overrides:

toString in class AuthorizationProvider

equals

public boolean equals(Object o)

Overrides:

equals in class AuthorizationProvider

hashCode

public int hashCode()

Overrides:

hashCode in class AuthorizationProvider

create

public static MongoAuthorization create(String providerId,
 MongoClient mongoClient,
 io.vertx.ext.auth.mongo.MongoAuthorizationOptions options)

Parameters:

providerId - the provider ID to differentiate from others

mongoClient - an instance of to be used for data storage and retrival

options - the configuration object for the current instance.

Returns:

the created instance of MongoAuthorization

newInstance

public static MongoAuthorization newInstance(io.vertx.ext.auth.mongo.MongoAuthorization arg)