Module lettuce.core
Interface NodeSelectionAclAsyncCommands<K,V>
public interface NodeSelectionAclAsyncCommands<K,V>
Asynchronous executed commands on a node selection for the ACL-API.
- Since:
- 6.1
- Author:
- Mikhael Sokolov
- Generated class:
- by io.lettuce.apigenerator.CreateAsyncNodeSelectionClusterApi
-
Method Summary
Modifier and Type Method Description AsyncExecutions<Set<AclCategory>>aclCat()The command shows the available ACL categories if called without arguments.AsyncExecutions<Set<CommandType>>aclCat(AclCategory category)The command shows all the Redis commands in the specified category.AsyncExecutions<Long>aclDeluser(String... usernames)Delete all the specified ACL users and terminate all the connections that are authenticated with such users.AsyncExecutions<String>aclGenpass()The command generates a password.AsyncExecutions<String>aclGenpass(int bits)The command generates a password.AsyncExecutions<List<Object>>aclGetuser(String username)The command returns all the rules defined for an existing ACL user.AsyncExecutions<List<String>>aclList()The command shows the currently active ACL rules in the Redis server.AsyncExecutions<String>aclLoad()When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file.AsyncExecutions<List<Map<String,Object>>>aclLog()The command shows a list of recent ACL security events.AsyncExecutions<List<Map<String,Object>>>aclLog(int count)The command shows a list of recent ACL security events.AsyncExecutions<String>aclLogReset()The command clears ACL security events.AsyncExecutions<String>aclSave()When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file.AsyncExecutions<String>aclSetuser(String username, AclSetuserArgs setuserArgs)Create an ACL user with the specified rules or modify the rules of an existing user.AsyncExecutions<List<String>>aclUsers()The command shows a list of all the usernames of the currently configured users in the Redis ACL system.AsyncExecutions<String>aclWhoami()The command shows a list of all the usernames of the currently configured users in the Redis ACL system.
-
Method Details
-
aclCat
AsyncExecutions<Set<AclCategory>> aclCat()The command shows the available ACL categories if called without arguments.- Returns:
- List<AclCategory> a list of ACL categories or
-
aclCat
The command shows all the Redis commands in the specified category.- Parameters:
category- the specified category- Returns:
- List<CommandType> a list of commands inside a given category
-
aclDeluser
Delete all the specified ACL users and terminate all the connections that are authenticated with such users.- Parameters:
usernames- the specified usernames- Returns:
- Long The number of users that were deleted
-
aclGenpass
AsyncExecutions<String> aclGenpass()The command generates a password.- Returns:
- String bulk-string-reply 64 bytes string password representing 256 bits of pseudorandom data.
-
aclGenpass
The command generates a password.- Parameters:
bits- amount of bits- Returns:
- String bulk-string-reply N/4 bytes string password representing N bits of pseudorandom data.
-
aclGetuser
The command returns all the rules defined for an existing ACL user.- Parameters:
username- the specified username- Returns:
- Map<String, Object> a map of ACL rule definitions for the user.
-
aclList
AsyncExecutions<List<String>> aclList()The command shows the currently active ACL rules in the Redis server.- Returns:
- List<String> a list of strings.
-
aclLoad
AsyncExecutions<String> aclLoad()When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file.- Returns:
- String simple-string-reply OK or error message.
-
aclLog
AsyncExecutions<List<Map<String,Object>>> aclLog()The command shows a list of recent ACL security events.- Returns:
- List<Map<K,Object>> list of security events.
-
aclLog
The command shows a list of recent ACL security events.- Parameters:
count- max count of events- Returns:
- List<Map<K, Object>> list of security events.
-
aclLogReset
AsyncExecutions<String> aclLogReset()The command clears ACL security events.- Returns:
- String simple-string-reply OK if the security log was cleared.
-
aclSave
AsyncExecutions<String> aclSave()When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file.- Returns:
- String simple-string-reply OK or error message.
-
aclSetuser
Create an ACL user with the specified rules or modify the rules of an existing user.- Parameters:
username- the specified usernamesetuserArgs- rules- Returns:
- String simple-string-reply OK or error message.
-
aclUsers
AsyncExecutions<List<String>> aclUsers()The command shows a list of all the usernames of the currently configured users in the Redis ACL system.- Returns:
- List<K> a list of usernames.
-
aclWhoami
AsyncExecutions<String> aclWhoami()The command shows a list of all the usernames of the currently configured users in the Redis ACL system.- Returns:
- K bulk-string-reply the username of the current connection.
-