Class MongoUserUtil
- java.lang.Object
-
- io.vertx.reactivex.ext.auth.mongo.MongoUserUtil
-
public class MongoUserUtil 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 theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<MongoUserUtil>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description MongoUserUtil(MongoUserUtil delegate)
MongoUserUtil(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MongoUserUtil
create(MongoClient client)
Create an instance of the user helper.static MongoUserUtil
create(MongoClient client, MongoAuthenticationOptions authenticationOptions, MongoAuthorizationOptions authorizationOptions)
Create an instance of the user helper with custom queries.MongoUserUtil
createHashedUser(String username, String hash)
Insert a user into a database.MongoUserUtil
createHashedUser(String username, String hash, Handler<AsyncResult<String>> resultHandler)
Insert a user into a database.MongoUserUtil
createUser(String username, String password)
Insert a user into a database.MongoUserUtil
createUser(String username, String password, Handler<AsyncResult<String>> resultHandler)
Insert a user into a database.MongoUserUtil
createUserRolesAndPermissions(String username, List<String> roles, List<String> permissions)
Insert a user role into a database.MongoUserUtil
createUserRolesAndPermissions(String username, List<String> roles, List<String> permissions, Handler<AsyncResult<String>> resultHandler)
Insert a user role into a database.boolean
equals(Object o)
MongoUserUtil
getDelegate()
int
hashCode()
static MongoUserUtil
newInstance(MongoUserUtil arg)
io.reactivex.Single<String>
rxCreateHashedUser(String username, String hash)
Insert a user into a database.io.reactivex.Single<String>
rxCreateUser(String username, String password)
Insert a user into a database.io.reactivex.Single<String>
rxCreateUserRolesAndPermissions(String username, List<String> roles, List<String> permissions)
Insert a user role into a database.String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<MongoUserUtil> __TYPE_ARG
-
-
Constructor Detail
-
MongoUserUtil
public MongoUserUtil(MongoUserUtil delegate)
-
MongoUserUtil
public MongoUserUtil(Object delegate)
-
-
Method Detail
-
getDelegate
public MongoUserUtil getDelegate()
-
create
public static MongoUserUtil create(MongoClient client)
Create an instance of the user helper.- Parameters:
client
- the client with write rights to the database.- Returns:
- the instance
-
create
public static MongoUserUtil create(MongoClient client, MongoAuthenticationOptions authenticationOptions, MongoAuthorizationOptions authorizationOptions)
Create an instance of the user helper with custom queries.- Parameters:
client
- the client with write rights to the database.authenticationOptions
-authorizationOptions
-- Returns:
- the instance
-
createUser
public MongoUserUtil createUser(String username, String password, Handler<AsyncResult<String>> resultHandler)
Insert a user into a database.- Parameters:
username
- the username to be setpassword
- the password in clear text, will be adapted following the definitions of the defined strategyresultHandler
- the ResultHandler will be provided with the result of the operation and the created user document identifier- Returns:
- fluent self
-
createUser
public MongoUserUtil createUser(String username, String password)
Insert a user into a database.- Parameters:
username
- the username to be setpassword
- the password in clear text, will be adapted following the definitions of the defined strategy- Returns:
- fluent self
-
rxCreateUser
public io.reactivex.Single<String> rxCreateUser(String username, String password)
Insert a user into a database.- Parameters:
username
- the username to be setpassword
- the password in clear text, will be adapted following the definitions of the defined strategy- Returns:
- fluent self
-
createHashedUser
public MongoUserUtil createHashedUser(String username, String hash, Handler<AsyncResult<String>> resultHandler)
Insert a user into a database.- Parameters:
username
- the username to be sethash
- the password hash, as result ofHashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
resultHandler
- the ResultHandler will be provided with the result of the operation and the created user document identifier- Returns:
- fluent self
-
createHashedUser
public MongoUserUtil createHashedUser(String username, String hash)
Insert a user into a database.- Parameters:
username
- the username to be sethash
- the password hash, as result ofHashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
- Returns:
- fluent self
-
rxCreateHashedUser
public io.reactivex.Single<String> rxCreateHashedUser(String username, String hash)
Insert a user into a database.- Parameters:
username
- the username to be sethash
- the password hash, as result ofHashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
- Returns:
- fluent self
-
createUserRolesAndPermissions
public MongoUserUtil createUserRolesAndPermissions(String username, List<String> roles, List<String> permissions, Handler<AsyncResult<String>> resultHandler)
Insert a user role into a database.- Parameters:
username
- the username to be setroles
- a to be setpermissions
- a to be setresultHandler
- the ResultHandler will be provided with the result of the operation and the created user document identifier- Returns:
- fluent self
-
createUserRolesAndPermissions
public MongoUserUtil createUserRolesAndPermissions(String username, List<String> roles, List<String> permissions)
Insert a user role into a database.- Parameters:
username
- the username to be setroles
- a to be setpermissions
- a to be set- Returns:
- fluent self
-
rxCreateUserRolesAndPermissions
public io.reactivex.Single<String> rxCreateUserRolesAndPermissions(String username, List<String> roles, List<String> permissions)
Insert a user role into a database.- Parameters:
username
- the username to be setroles
- a to be setpermissions
- a to be set- Returns:
- fluent self
-
newInstance
public static MongoUserUtil newInstance(MongoUserUtil arg)
-
-