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:

Redis ACL Guide

Method Summary

Modifier and Type	Method and Description
List<String>	aclCat() Show the available ACL categories.
List<String>	aclCat(String category) Show the available ACLs for a given category.
long	aclDelUser(String name) Delete the specified user, from the ACL.
long	aclDelUser(String name, String... names) Delete the specified users, from the ACL.
String	aclDryRun(String username, CommandArguments commandArgs)
String	aclDryRun(String username, String command, String... args)
String	aclGenPass() Generate a random password
String	aclGenPass(int bits) Generate a random password
AccessControlUser	aclGetUser(String name) The command returns all the rules defined for an existing ACL user.
List<String>	aclList() 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<AccessControlLogEntry>	aclLog() Shows the recent ACL security events.
List<AccessControlLogEntry>	aclLog(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(String name) Create an ACL for the specified user with the default rules.
String	aclSetUser(String name, String... keys) Create an ACL for the specified user, while specifying the rules.
List<String>	aclUsers() Shows a list of all usernames currently configured with access control lists (ACL).
String	aclWhoAmI() Returns the username used to authenticate the current connection.

Method Detail

aclWhoAmI

String aclWhoAmI()

Returns the username used to authenticate the current connection.

Returns:

The username used for the current connection

See Also:

ACL WHOAMI

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:

ACL LIST

aclUsers

List<String> aclUsers()

Shows a list of all usernames currently configured with access control lists (ACL).

Returns:

list of users

See Also:

ACL USERS

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:

ACL SETUSER

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:

ACL SETUSER

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:

ACL DELUSER

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:

ACL DELUSER

aclCat

List<String> aclCat()

Show the available ACL categories.

Returns:

the available ACL categories

See Also:

ACL CAT

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:

ACL CAT

aclLog

List<AccessControlLogEntry> aclLog()

Shows the recent ACL security events.

Returns:

The list of recent security events

See Also:

ACL LOG

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:

ACL LOG

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:

ACL LOAD

aclSave

String aclSave()

Save the currently defined in-memory ACL to disk.

Returns:

OK on success

See Also:

ACL SAVE

aclDryRun

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

aclDryRun

String aclDryRun(String username,
                 CommandArguments commandArgs)