Module lettuce.core
Package io.lettuce.core.api.sync

Interface RedisAclCommands<K,​V>

All Known Subinterfaces:
RedisAdvancedClusterCommands<K,​V>, RedisClusterCommands<K,​V>, RedisClusterPubSubCommands<K,​V>, RedisCommands<K,​V>, RedisPubSubCommands<K,​V>
public interface RedisAclCommands<K,​V>
Synchronous executed commands for the ACL-API.
Since:
6.1
Author:
Mikhael Sokolov
Generated class:
by io.lettuce.apigenerator.CreateSyncApi

  • Method Summary

    Modifier and Type Method Description
    Set<AclCategory> aclCat()
    The command shows the available ACL categories if called without arguments.
    Set<CommandType> aclCat​(AclCategory category)
    The command shows all the Redis commands in the specified category.
    Long aclDeluser​(String... usernames)
    Delete all the specified ACL users and terminate all the connections that are authenticated with such users.
    String aclGenpass()
    The command generates a password.
    String aclGenpass​(int bits)
    The command generates a password.
    List<Object> aclGetuser​(String username)
    The command returns all the rules defined for an existing ACL user.
    List<String> aclList()
    The command shows the currently active ACL rules in the Redis server.
    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.
    List<Map<String,​Object>> aclLog()
    The command shows a list of recent ACL security events.
    List<Map<String,​Object>> aclLog​(int count)
    The command shows a list of recent ACL security events.
    String aclLogReset()
    The command clears ACL security events.
    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.
    String aclSetuser​(String username, AclSetuserArgs setuserArgs)
    Create an ACL user with the specified rules or modify the rules of an existing user.
    List<String> aclUsers()
    The command shows a list of all the usernames of the currently configured users in the Redis ACL system.
    String aclWhoami()
    The command shows a list of all the usernames of the currently configured users in the Redis ACL system.

  • Method Details

    • aclCat

      Set<AclCategory> aclCat()
      The command shows the available ACL categories if called without arguments.
      Returns:
      List<AclCategory> a list of ACL categories or

    • aclCat

      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

      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

    • aclGenpass

      String aclGenpass()
      The command generates a password.
      Returns:
      String bulk-string-reply 64 bytes string password representing 256 bits of pseudorandom data.

    • aclGenpass

      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

      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

      List<String> aclList()
      The command shows the currently active ACL rules in the Redis server.
      Returns:
      List<String> a list of strings.

    • aclLoad

      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

      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

      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

      String aclLogReset()
      The command clears ACL security events.
      Returns:
      String simple-string-reply OK if the security log was cleared.

    • aclSave

      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

      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 username
      setuserArgs - rules
      Returns:
      String simple-string-reply OK or error message.

    • aclUsers

      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

      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.