Package redis.clients.jedis.commands

Interface AccessControlLogBinaryCommands

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

  • Method Summary

    Modifier and Type
    Method
    Description
    List<byte[]>
    aclCat(byte[] category)
    Show the available ACLs for a given category.
    List<byte[]>
    aclCatBinary()
    Show the available ACL categories.
    long
    aclDelUser(byte[] name)
    Delete the specified user, from the ACL.
    long
    aclDelUser(byte[] name, byte[]... names)
    Delete the specified users, from the ACL.
    byte[]
    aclDryRunBinary(byte[] username, byte[] command, byte[]... args)
     
    byte[]
    aclDryRunBinary(byte[] username, CommandArguments commandArgs)
     
    byte[]
    aclGenPassBinary()
    Generate a random password
    byte[]
    aclGenPassBinary(int bits)
    Generate a random password
    AccessControlUser
    aclGetUser(byte[] name)
    The command returns all the rules defined for an existing ACL user.
    List<byte[]>
    aclListBinary()
    Returns the currently active ACL rules on the Redis Server
    String
    aclLoad()
    This function tells Redis to reload its external ACL rules, when Redis is configured with an external ACL file
    List<byte[]>
    aclLogBinary()
    Shows the recent ACL security events.
    List<byte[]>
    aclLogBinary(int limit)
    Shows the recent limit ACL security events.
    String
    aclLogReset()
    Reset the script event log
    String
    aclSave()
    Save the currently defined in-memory ACL to disk.
    String
    aclSetUser(byte[] name)
    Create an ACL for the specified user with the default rules.
    String
    aclSetUser(byte[] name, byte[]... keys)
    Create an ACL for the specified user, while specifying the rules.
    List<byte[]>
    aclUsersBinary()
    Shows a list of all usernames currently configured with access control lists (ACL).
    byte[]
    aclWhoAmIBinary()
    Returns the username used to authenticate the current connection.

  • Method Details

    • aclWhoAmIBinary

      byte[] aclWhoAmIBinary()
      Returns the username used to authenticate the current connection.
      Returns:
      The username used for the current connection
      See Also:

    • aclGenPassBinary

      byte[] aclGenPassBinary()
      Generate a random password
      Returns:
      A random password
      See Also:

    • aclGenPassBinary

      byte[] aclGenPassBinary(int bits)
      Generate a random password
      Parameters:
      bits - the number of output bits
      Returns:
      A random password

    • aclListBinary

      List<byte[]> aclListBinary()
      Returns the currently active ACL rules on the Redis Server
      Returns:
      An array of ACL rules
      See Also:

    • aclUsersBinary

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

    • aclGetUser

      AccessControlUser aclGetUser(byte[] 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(byte[] 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(byte[] name, byte[]... 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(byte[] 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(byte[] name, byte[]... 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:

    • aclCatBinary

      List<byte[]> aclCatBinary()
      Show the available ACL categories.
      Returns:
      the available ACL categories
      See Also:

    • aclCat

      List<byte[]> aclCat(byte[] 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:

    • aclLogBinary

      List<byte[]> aclLogBinary()
      Shows the recent ACL security events.
      Returns:
      The list of recent security events
      See Also:

    • aclLogBinary

      List<byte[]> aclLogBinary(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
      See Also:

    • 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:

    • aclDryRunBinary

      byte[] aclDryRunBinary(byte[] username, byte[] command, byte[]... args)

    • aclDryRunBinary

      byte[] aclDryRunBinary(byte[] username, CommandArguments commandArgs)