Package redis.clients.jedis.commands

Interface AccessControlLogCommands

All Known Subinterfaces:
ControlCommands
All Known Implementing Classes:
Jedis
public interface AccessControlLogCommands
This class provides the interfaces necessary to interact with Access Control Lists (ACLs) within redis. These are the interfaces for string-based (i.e. decoded) interactions.
See Also:

  • Method Details

    • aclWhoAmI

      String aclWhoAmI()
      Returns the username used to authenticate the current connection.
      Returns:
      The username used for the current connection
      See Also:

    • aclGenPass

      String aclGenPass()
      Generate a random password
      Returns:
      A random password

    • aclGenPass

      String aclGenPass(int bits)
      Generate a random password
      Parameters:
      bits - the number of output bits
      Returns:
      A random password

    • aclList

      List<String> aclList()
      Returns the currently active ACL rules on the Redis Server
      Returns:
      An array of ACL rules
      See Also:

    • aclUsers

      List<String> aclUsers()
      Shows a list of all usernames currently configured with access control lists (ACL).
      Returns:
      list of users
      See Also:

    • aclGetUser

      AccessControlUser aclGetUser(String name)
      The command returns all the rules defined for an existing ACL user.
      Parameters:
      name - username
      Returns:
      a list of ACL rule definitions for the user.

    • aclSetUser

      String aclSetUser(String name)
      Create an ACL for the specified user with the default rules.
      Parameters:
      name - user who receives an acl
      Returns:
      A string containing OK on success
      See Also:

    • aclSetUser

      String aclSetUser(String name, String... keys)
      Create an ACL for the specified user, while specifying the rules.
      Parameters:
      name - user who receives an acl
      keys - the acl rules for the specified user
      Returns:
      A string containing OK on success
      See Also:

    • aclDelUser

      long aclDelUser(String name)
      Delete the specified user, from the ACL.
      Parameters:
      name - The username to delete
      Returns:
      The number of users delete
      See Also:

    • aclDelUser

      long aclDelUser(String name, String... names)
      Delete the specified users, from the ACL.
      Parameters:
      name - The username to delete
      names - Other usernames to delete
      Returns:
      The number of users delete
      See Also:

    • aclCat

      List<String> aclCat()
      Show the available ACL categories.
      Returns:
      the available ACL categories
      See Also:

    • aclCat

      List<String> aclCat(String category)
      Show the available ACLs for a given category.
      Parameters:
      category - The category for which to list available ACLs
      Returns:
      the available ACL categories
      See Also:

    • aclLog

      List<AccessControlLogEntry> aclLog()
      Shows the recent ACL security events.
      Returns:
      The list of recent security events
      See Also:

    • aclLog

      List<AccessControlLogEntry> aclLog(int limit)
      Shows the recent limit ACL security events.
      Parameters:
      limit - The number of results to return
      Returns:
      The list of recent security events
      See Also:

    • aclLogReset

      String aclLogReset()
      Reset the script event log
      Returns:
      The OK string

    • aclLoad

      String aclLoad()
      This function tells Redis to reload its external ACL rules, when Redis is configured with an external ACL file
      Returns:
      OK or error text
      See Also:

    • aclSave

      String aclSave()
      Save the currently defined in-memory ACL to disk.
      Returns:
      OK on success
      See Also:

    • aclDryRun

      String aclDryRun(String username, String command, String... args)

    • aclDryRun

      String aclDryRun(String username, CommandArguments commandArgs)