io.vertx.rxjava3.ext.auth.sqlclient

Class SqlUserUtil

java.lang.Object

io.vertx.rxjava3.ext.auth.sqlclient.SqlUserUtil

public class SqlUserUtil
extends Object

Utility to create users/roles/permissions. This is a helper class and not intended to be a full user management utility. While the standard authentication and authorization interfaces will require usually read only access to the database, in order to use this API a full read/write access must be granted.

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<SqlUserUtil>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
SqlUserUtil(Object delegate)
SqlUserUtil(SqlUserUtil delegate)

Method Summary

Modifier and Type	Method and Description
static SqlUserUtil	create(SqlClient client) Create an instance of the user helper.
static SqlUserUtil	create(SqlClient client, String insertUserSQL, String insertUserRoleSQL, String insertRolePermissionSQL) Create an instance of the user helper with custom queries.
Completable	createHashedUser(String username, String hash) Insert a user into a database.
Completable	createRolePermission(String role, String permission) Insert a role permission into a database.
Completable	createUser(String username, String password) Insert a user into a database.
Completable	createUserRole(String username, String role) Insert a user role into a database.
boolean	equals(Object o)
SqlUserUtil	getDelegate()
int	hashCode()
static SqlUserUtil	newInstance(SqlUserUtil arg)
Completable	rxCreateHashedUser(String username, String hash) Insert a user into a database.
Completable	rxCreateRolePermission(String role, String permission) Insert a role permission into a database.
Completable	rxCreateUser(String username, String password) Insert a user into a database.
Completable	rxCreateUserRole(String username, String role) Insert a user role into a database.
String	toString()

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<SqlUserUtil> __TYPE_ARG

Constructor Detail

SqlUserUtil

public SqlUserUtil(SqlUserUtil delegate)

SqlUserUtil

public SqlUserUtil(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public SqlUserUtil getDelegate()

create

public static SqlUserUtil create(SqlClient client)

Create an instance of the user helper.

Parameters:

client - the client with write rights to the database.

Returns:

the instance

create

public static SqlUserUtil create(SqlClient client,
                                 String insertUserSQL,
                                 String insertUserRoleSQL,
                                 String insertRolePermissionSQL)

Create an instance of the user helper with custom queries.

Parameters:

client - the client with write rights to the database.

insertUserSQL -

insertUserRoleSQL -

insertRolePermissionSQL -

Returns:

the instance

createUser

public Completable createUser(String username,
                              String password)

Insert a user into a database.

Parameters:

username - the username to be set

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

Returns:

fluent self

rxCreateUser

public Completable rxCreateUser(String username,
                                String password)

Insert a user into a database.

Parameters:

username - the username to be set

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

Returns:

fluent self

createHashedUser

public Completable createHashedUser(String username,
                                    String hash)

Insert a user into a database.

Parameters:

username - the username to be set

hash - the password hash, as result of HashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)

Returns:

fluent self

rxCreateHashedUser

public Completable rxCreateHashedUser(String username,
                                      String hash)

Insert a user into a database.

Parameters:

username - the username to be set

hash - the password hash, as result of HashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)

Returns:

fluent self

createUserRole

public Completable createUserRole(String username,
                                  String role)

Insert a user role into a database.

Parameters:

username - the username to be set

role - a to be set

Returns:

fluent self

rxCreateUserRole

public Completable rxCreateUserRole(String username,
                                    String role)

Insert a user role into a database.

Parameters:

username - the username to be set

role - a to be set

Returns:

fluent self

createRolePermission

public Completable createRolePermission(String role,
                                        String permission)

Insert a role permission into a database.

Parameters:

role - a to be set

permission - the permission to be set

Returns:

fluent self

rxCreateRolePermission

public Completable rxCreateRolePermission(String role,
                                          String permission)

Insert a role permission into a database.

Parameters:

role - a to be set

permission - the permission to be set

Returns:

fluent self

newInstance

public static SqlUserUtil newInstance(SqlUserUtil arg)