io.vertx.reactivex.ext.auth.mongo

Class MongoAuth

java.lang.Object

io.vertx.reactivex.ext.auth.authentication.AuthenticationProvider

io.vertx.reactivex.ext.auth.AuthProvider

io.vertx.reactivex.ext.auth.mongo.MongoAuth

public class MongoAuth
extends AuthProvider

An extension of AuthProvider which is using as store

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

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<MongoAuth>	__TYPE_ARG
static String	DEFAULT_COLLECTION_NAME The default name of the collection to be used
static String	DEFAULT_CREDENTIAL_PASSWORD_FIELD The default name of the property for the password, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>)
static String	DEFAULT_CREDENTIAL_USERNAME_FIELD The default name of the property for the username, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>)
static String	DEFAULT_PASSWORD_FIELD The default name of the property for the password, like it is stored in mongodb
static String	DEFAULT_PERMISSION_FIELD The default name of the property for the permissions, like it is stored in mongodb.
static String	DEFAULT_ROLE_FIELD The default name of the property for the roles, like it is stored in mongodb.
static String	DEFAULT_SALT_FIELD The default name of the property for the salt field
static String	DEFAULT_USERNAME_FIELD The default name of the property for the username, like it is stored in mongodb
static String	PROPERTY_COLLECTION_NAME The property name to be used to set the name of the collection inside the config
static String	PROPERTY_CREDENTIAL_PASSWORD_FIELD The property name to be used to set the name of the field, where the password for the credentials is stored inside
static String	PROPERTY_CREDENTIAL_USERNAME_FIELD The property name to be used to set the name of the field, where the username for the credentials is stored inside
static String	PROPERTY_PASSWORD_FIELD The property name to be used to set the name of the field, where the password is stored inside
static String	PROPERTY_PERMISSION_FIELD The property name to be used to set the name of the field, where the permissions are stored inside
static String	PROPERTY_ROLE_FIELD The property name to be used to set the name of the field, where the roles are stored inside
static String	PROPERTY_SALT_FIELD The property name to be used to set the name of the field, where the SALT is stored inside
static String	PROPERTY_SALT_STYLE The property name to be used to set the name of the field, where the salt style is stored inside
static String	PROPERTY_USERNAME_FIELD The property name to be used to set the name of the field, where the username is stored inside
static String	ROLE_PREFIX The prefix which is used by the method when checking for role access

Constructor Summary

Constructors

Constructor and Description
MongoAuth(MongoAuth delegate)
MongoAuth(Object delegate)

Method Summary

Modifier and Type	Method and Description
static MongoAuth	create(MongoClient mongoClient, JsonObject config) Deprecated.
boolean	equals(Object o)
String	getCollectionName() Deprecated.
MongoAuth	getDelegate()
HashStrategy	getHashStrategy() Deprecated.
String	getPasswordCredentialField() Deprecated.
String	getPasswordField() Deprecated.
String	getPermissionField() Deprecated.
String	getRoleField() Deprecated.
String	getSaltField() Deprecated.
String	getUsernameCredentialField() Deprecated.
String	getUsernameField() Deprecated.
int	hashCode()
void	insertUser(String username, String password, List<String> roles, List<String> permissions) Deprecated.
void	insertUser(String username, String password, List<String> roles, List<String> permissions, Handler<AsyncResult<String>> resultHandler) Deprecated.
static MongoAuth	newInstance(MongoAuth arg)
Single<String>	rxInsertUser(String username, String password, List<String> roles, List<String> permissions) Deprecated.
MongoAuth	setCollectionName(String collectionName) Deprecated.
MongoAuth	setHashAlgorithm(HashAlgorithm hashAlgorithm) Deprecated.
MongoAuth	setHashStrategy(HashStrategy hashStrategy) Deprecated.
MongoAuth	setPasswordCredentialField(String fieldName) Deprecated.
MongoAuth	setPasswordField(String fieldName) Deprecated.
MongoAuth	setPermissionField(String fieldName) Deprecated.
MongoAuth	setRoleField(String fieldName) Deprecated.
MongoAuth	setSaltField(String fieldName) Deprecated.
MongoAuth	setUsernameCredentialField(String fieldName) Deprecated.
MongoAuth	setUsernameField(String fieldName) Deprecated.
String	toString()

Methods inherited from class io.vertx.reactivex.ext.auth.AuthProvider

newInstance

Methods inherited from class io.vertx.reactivex.ext.auth.authentication.AuthenticationProvider

authenticate, authenticate, authenticate, authenticate, newInstance, rxAuthenticate, rxAuthenticate

Methods inherited from class java.lang.Object

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

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<MongoAuth> __TYPE_ARG

PROPERTY_COLLECTION_NAME

public static final String PROPERTY_COLLECTION_NAME

The property name to be used to set the name of the collection inside the config

See Also:

Constant Field Values

PROPERTY_USERNAME_FIELD

public static final String PROPERTY_USERNAME_FIELD

The property name to be used to set the name of the field, where the username is stored inside

See Also:

Constant Field Values

PROPERTY_ROLE_FIELD

public static final String PROPERTY_ROLE_FIELD

The property name to be used to set the name of the field, where the roles are stored inside

See Also:

Constant Field Values

PROPERTY_PERMISSION_FIELD

public static final String PROPERTY_PERMISSION_FIELD

The property name to be used to set the name of the field, where the permissions are stored inside

See Also:

Constant Field Values

PROPERTY_PASSWORD_FIELD

public static final String PROPERTY_PASSWORD_FIELD

The property name to be used to set the name of the field, where the password is stored inside

See Also:

Constant Field Values

PROPERTY_CREDENTIAL_USERNAME_FIELD

public static final String PROPERTY_CREDENTIAL_USERNAME_FIELD

The property name to be used to set the name of the field, where the username for the credentials is stored inside

See Also:

Constant Field Values

PROPERTY_CREDENTIAL_PASSWORD_FIELD

public static final String PROPERTY_CREDENTIAL_PASSWORD_FIELD

The property name to be used to set the name of the field, where the password for the credentials is stored inside

See Also:

Constant Field Values

PROPERTY_SALT_FIELD

public static final String PROPERTY_SALT_FIELD

The property name to be used to set the name of the field, where the SALT is stored inside

See Also:

Constant Field Values

PROPERTY_SALT_STYLE

public static final String PROPERTY_SALT_STYLE

The property name to be used to set the name of the field, where the salt style is stored inside

See Also:

Constant Field Values

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_PASSWORD_FIELD

public static final String DEFAULT_PASSWORD_FIELD

The default name of the property for the password, 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

DEFAULT_CREDENTIAL_USERNAME_FIELD

public static final String DEFAULT_CREDENTIAL_USERNAME_FIELD

The default name of the property for the username, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>)

See Also:

Constant Field Values

DEFAULT_CREDENTIAL_PASSWORD_FIELD

public static final String DEFAULT_CREDENTIAL_PASSWORD_FIELD

The default name of the property for the password, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>)

See Also:

Constant Field Values

DEFAULT_SALT_FIELD

public static final String DEFAULT_SALT_FIELD

The default name of the property for the salt field

See Also:

Constant Field Values

ROLE_PREFIX

public static final String ROLE_PREFIX

The prefix which is used by the method when checking for role access

See Also:

Constant Field Values

Constructor Detail

MongoAuth

public MongoAuth(MongoAuth delegate)

MongoAuth

public MongoAuth(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class AuthProvider

equals

public boolean equals(Object o)

Overrides:

equals in class AuthProvider

hashCode

public int hashCode()

Overrides:

hashCode in class AuthProvider

getDelegate

public MongoAuth getDelegate()

Overrides:

getDelegate in class AuthProvider

create

@Deprecated
public static MongoAuth create(MongoClient mongoClient,
                                           JsonObject config)

Deprecated.

Creates an instance of MongoAuth by using the given and configuration object. An example for a configuration object:

 JsonObject js = new JsonObject();
 js.put(MongoAuth.PROPERTY_COLLECTION_NAME, createCollectionName(MongoAuth.DEFAULT_COLLECTION_NAME));
 

Parameters:

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

config - the configuration object for the current instance. By this

Returns:

the created instance of MongoAuths

setCollectionName

@Deprecated
public MongoAuth setCollectionName(String collectionName)

Deprecated.

Set the name of the collection to be used. Defaults to MongoAuth

Parameters:

collectionName - the name of the collection to be used for storing and reading user data

Returns:

the current instance itself for fluent calls

setUsernameField

@Deprecated
public MongoAuth setUsernameField(String fieldName)

Deprecated.

Set the name of the field to be used for the username. Defaults to MongoAuth

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setPasswordField

@Deprecated
public MongoAuth setPasswordField(String fieldName)

Deprecated.

Set the name of the field to be used for the password Defaults to MongoAuth

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setRoleField

@Deprecated
public MongoAuth setRoleField(String fieldName)

Deprecated.

Set the name of the field to be used for the roles. Defaults to MongoAuth. Roles are expected to be saved as JsonArray

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setPermissionField

@Deprecated
public MongoAuth setPermissionField(String fieldName)

Deprecated.

Set the name of the field to be used for the permissions. Defaults to MongoAuth. Permissions are expected to be saved as JsonArray

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setUsernameCredentialField

@Deprecated
public MongoAuth setUsernameCredentialField(String fieldName)

Deprecated.

Set the name of the field to be used as property for the username in the method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>). Defaults to MongoAuth

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setPasswordCredentialField

@Deprecated
public MongoAuth setPasswordCredentialField(String fieldName)

Deprecated.

Set the name of the field to be used as property for the password of credentials in the method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>). Defaults to MongoAuth

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

setSaltField

@Deprecated
public MongoAuth setSaltField(String fieldName)

Deprecated.

Set the name of the field to be used for the salt. Only used when HashStrategy.setSaltStyle(io.vertx.ext.auth.mongo.HashSaltStyle) is set to

Parameters:

fieldName - the name of the field to be used

Returns:

the current instance itself for fluent calls

getCollectionName

@Deprecated
public String getCollectionName()

Deprecated.

The name of the collection used to store User objects inside. Defaults to MongoAuth

Returns:

the collectionName

getUsernameField

@Deprecated
public String getUsernameField()

Deprecated.

Get the name of the field to be used for the username. Defaults to MongoAuth

Returns:

the usernameField

getPasswordField

@Deprecated
public String getPasswordField()

Deprecated.

Get the name of the field to be used for the password Defaults to MongoAuth

Returns:

the passwordField

getRoleField

@Deprecated
public String getRoleField()

Deprecated.

Get the name of the field to be used for the roles. Defaults to MongoAuth. Roles are expected to be saved as JsonArray

Returns:

the roleField

getPermissionField

@Deprecated
public String getPermissionField()

Deprecated.

Get the name of the field to be used for the permissions. Defaults to MongoAuth. Permissions are expected to be saved as JsonArray

Returns:

the permissionField

getUsernameCredentialField

@Deprecated
public String getUsernameCredentialField()

Deprecated.

Get the name of the field to be used as property for the username in the method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>). Defaults to MongoAuth

Returns:

the usernameCredentialField

getPasswordCredentialField

@Deprecated
public String getPasswordCredentialField()

Deprecated.

Get the name of the field to be used as property for the password of credentials in the method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.ext.auth.User>>). Defaults to MongoAuth

Returns:

the passwordCredentialField

getSaltField

@Deprecated
public String getSaltField()

Deprecated.

Get the name of the field to be used for the salt. Only used when HashStrategy.setSaltStyle(io.vertx.ext.auth.mongo.HashSaltStyle) is set to

Returns:

the saltField

setHashStrategy

@Deprecated
public MongoAuth setHashStrategy(HashStrategy hashStrategy)

Deprecated.

The HashStrategy which is used by the current instance

Parameters:

hashStrategy - the HashStrategy to be set

Returns:

the current instance itself for fluent calls

getHashStrategy

@Deprecated
public HashStrategy getHashStrategy()

Deprecated.

The HashStrategy which is used by the current instance

Returns:

the defined instance of HashStrategy

setHashAlgorithm

@Deprecated
public MongoAuth setHashAlgorithm(HashAlgorithm hashAlgorithm)

Deprecated.

The Hash Algorithm which is used by the current instance

Parameters:

hashAlgorithm - the HashAlgorithm to be set

Returns:

the current instance itself for fluent calls

insertUser

@Deprecated
public void insertUser(String username,
                                   String password,
                                   List<String> roles,
                                   List<String> permissions,
                                   Handler<AsyncResult<String>> resultHandler)

Deprecated.

Parameters:

username - the username to be set

password - the passsword in clear text, will be adapted following the definitions of the defined HashStrategy

roles - a list of roles to be set

permissions - a list of permissions to be set

resultHandler - the ResultHandler will be provided with the id of the generated record

insertUser

@Deprecated
public void insertUser(String username,
                                   String password,
                                   List<String> roles,
                                   List<String> permissions)

Deprecated.

Parameters:

username - the username to be set

password - the passsword in clear text, will be adapted following the definitions of the defined HashStrategy

roles - a list of roles to be set

permissions - a list of permissions to be set

rxInsertUser

@Deprecated
public Single<String> rxInsertUser(String username,
                                               String password,
                                               List<String> roles,
                                               List<String> permissions)

Deprecated.

Parameters:

username - the username to be set

password - the passsword in clear text, will be adapted following the definitions of the defined HashStrategy

roles - a list of roles to be set

permissions - a list of permissions to be set

Returns:

newInstance

public static MongoAuth newInstance(MongoAuth arg)