Package io.lettuce.core.api.async
Interface RedisAclAsyncCommands<K,V>
-
- All Known Subinterfaces:
RedisAdvancedClusterAsyncCommands<K,V>
,RedisAsyncCommands<K,V>
,RedisClusterAsyncCommands<K,V>
,RedisClusterPubSubAsyncCommands<K,V>
,RedisPubSubAsyncCommands<K,V>
- All Known Implementing Classes:
AbstractRedisAsyncCommands
,RedisAdvancedClusterAsyncCommandsImpl
,RedisAsyncCommandsImpl
,RedisClusterPubSubAsyncCommandsImpl
,RedisPubSubAsyncCommandsImpl
public interface RedisAclAsyncCommands<K,V>
Asynchronous executed commands for the ACL-API.- Since:
- 6.1
- Author:
- Mikhael Sokolov
- Generated class:
- by io.lettuce.apigenerator.CreateAsyncApi
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RedisFuture<Set<AclCategory>>
aclCat()
The command shows the available ACL categories if called without arguments.RedisFuture<Set<CommandType>>
aclCat(AclCategory category)
The command shows all the Redis commands in the specified category.RedisFuture<Long>
aclDeluser(String... usernames)
Delete all the specified ACL users and terminate all the connections that are authenticated with such users.RedisFuture<String>
aclDryRun(String username, RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.RedisFuture<String>
aclDryRun(String username, String command, String... args)
Simulate the execution of a given command by a given user.RedisFuture<String>
aclGenpass()
The command generates a password.RedisFuture<String>
aclGenpass(int bits)
The command generates a password.RedisFuture<List<Object>>
aclGetuser(String username)
The command returns all the rules defined for an existing ACL user.RedisFuture<List<String>>
aclList()
The command shows the currently active ACL rules in the Redis server.RedisFuture<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.RedisFuture<List<Map<String,Object>>>
aclLog()
The command shows a list of recent ACL security events.RedisFuture<List<Map<String,Object>>>
aclLog(int count)
The command shows a list of recent ACL security events.RedisFuture<String>
aclLogReset()
The command clears ACL security events.RedisFuture<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.RedisFuture<String>
aclSetuser(String username, AclSetuserArgs setuserArgs)
Create an ACL user with the specified rules or modify the rules of an existing user.RedisFuture<List<String>>
aclUsers()
The command shows a list of all the usernames of the currently configured users in the Redis ACL system.RedisFuture<String>
aclWhoami()
The command shows a list of all the usernames of the currently configured users in the Redis ACL system.
-
-
-
Method Detail
-
aclCat
RedisFuture<Set<AclCategory>> aclCat()
The command shows the available ACL categories if called without arguments.- Returns:
- List<AclCategory> a list of ACL categories or
-
aclCat
RedisFuture<Set<CommandType>> aclCat(AclCategory category)
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
RedisFuture<Long> aclDeluser(String... usernames)
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
-
aclDryRun
RedisFuture<String> aclDryRun(String username, String command, String... args)
Simulate the execution of a given command by a given user.- Parameters:
username
- the specified usernamecommand
- the specified commandargs
- the specified args of command- Returns:
- String reply: OK on success.
- Since:
- 6.2
-
aclDryRun
RedisFuture<String> aclDryRun(String username, RedisCommand<K,V,?> command)
Simulate the execution of a given command by a given user.- Parameters:
username
- the specified usernamecommand
- the specified command to inspect- Returns:
- String reply: OK on success.
- Since:
- 6.2
-
aclGenpass
RedisFuture<String> aclGenpass()
The command generates a password.- Returns:
- String bulk-string-reply 64 bytes string password representing 256 bits of pseudorandom data.
-
aclGenpass
RedisFuture<String> aclGenpass(int bits)
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
RedisFuture<List<Object>> aclGetuser(String username)
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
RedisFuture<List<String>> aclList()
The command shows the currently active ACL rules in the Redis server.- Returns:
- List<String> a list of strings.
-
aclLoad
RedisFuture<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
RedisFuture<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
RedisFuture<List<Map<String,Object>>> aclLog(int count)
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
RedisFuture<String> aclLogReset()
The command clears ACL security events.- Returns:
- String simple-string-reply OK if the security log was cleared.
-
aclSave
RedisFuture<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
RedisFuture<String> aclSetuser(String username, AclSetuserArgs setuserArgs)
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
RedisFuture<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
RedisFuture<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.
-
-