Package io.lettuce.core.api.reactive

Interface RedisAclReactiveCommands<K,​V>

    • Method Detail

      • aclCat

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

      • aclCat

        Mono<Set<CommandType>> aclCat​(AclCategory category)
        The command shows all the Redis commands in the specified category.
        Parameters:
        category - the specified category
        Returns:
        CommandType a list of commands inside a given category

      • aclDeluser

        Mono<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

        Mono<String> aclDryRun​(String username,
                       String command,
                       String... args)
        Simulate the execution of a given command by a given user.
        Parameters:
        username - the specified username
        command - the specified command
        args - the specified args of command
        Returns:
        String reply: OK on success.
        Since:
        6.2

      • aclDryRun

        Mono<String> aclDryRun​(String username,
                       RedisCommand<K,​V,​?> command)
        Simulate the execution of a given command by a given user.
        Parameters:
        username - the specified username
        command - the specified command to inspect
        Returns:
        String reply: OK on success.
        Since:
        6.2

      • aclGenpass

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

      • aclGenpass

        Mono<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

        Mono<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

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

      • aclLoad

        Mono<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

        Flux<Map<String,​Object>> aclLog()
        The command shows a list of recent ACL security events.
        Returns:
        Map<K,Object> list of security events.

      • aclLog

        Flux<Map<String,​Object>> aclLog​(int count)
        The command shows a list of recent ACL security events.
        Parameters:
        count - max count of events
        Returns:
        Map<K, Object> list of security events.

      • aclLogReset

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

      • aclSave

        Mono<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

        Mono<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

        Flux<String> aclUsers()
        The command shows a list of all the usernames of the currently configured users in the Redis ACL system.
        Returns:
        K a list of usernames.

      • aclWhoami

        Mono<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.