Package io.lettuce.core

Class AclSetuserArgs.Builder

java.lang.Object

io.lettuce.core.AclSetuserArgs.Builder

Enclosing class:

AclSetuserArgs

public static class AclSetuserArgs.Builder
extends Object

Builder entry points for AclSetuserArgs.

Method Summary

Modifier and Type	Method	Description
static AclSetuserArgs	addCategory(AclCategory category)	Creates new AclSetuserArgs and adds all the commands in the specified category to the list of commands the user is able to execute.
static AclSetuserArgs	addCommand(CommandType command)	Creates new AclSetuserArgs and adds this command to the list of the commands the user can call.
static AclSetuserArgs	addCommand(CommandType command, ProtocolKeyword subCommand)	Creates new AclSetuserArgs and adds the specified command to the list of the commands the user can execute.
static AclSetuserArgs	addHashedPassword(String hashedPassword)	Creates new AclSetuserArgs and adds the specified hashed password to the list of user passwords.
static AclSetuserArgs	addPassword(String password)	Creates new AclSetuserArgs and adds the specified clear text password as an hashed password in the list of the users passwords.
static AclSetuserArgs	allChannels()	Creates new AclSetuserArgs and allows the user to access all the Pub/Sub channels.
static AclSetuserArgs	allCommands()	Creates new AclSetuserArgs and adds all the commands there are in the server.
static AclSetuserArgs	allKeys()	Creates new AclSetuserArgs and allows the user to access all the keys.
static AclSetuserArgs	channelPattern(String channelPattern)	Creates new AclSetuserArgs and adds accessible channel pattern.
static AclSetuserArgs	keyPattern(String keyPattern)	Creates new AclSetuserArgs and adds accessible key pattern.
static AclSetuserArgs	noCommands()	Creates new AclSetuserArgs and removes all the commands the user can execute.
static AclSetuserArgs	nopass()	Creates new AclSetuserArgs and sets the user as a "no password".
static AclSetuserArgs	off()	Creates new AclSetuserArgs and set user inactive.
static AclSetuserArgs	on()	Creates new AclSetuserArgs and set user active.
static AclSetuserArgs	removeCategory(AclCategory category)	Creates new AclSetuserArgs and removes all the commands in the specified category to the list of commands the user is able to execute.
static AclSetuserArgs	removeCommand(CommandType command)	Creates new AclSetuserArgs and removes this command to the list of the commands the user can call.
static AclSetuserArgs	removeCommand(CommandType command, ProtocolKeyword subCommand)	Creates new AclSetuserArgs and removes the specified command to the list of the commands the user can execute.
static AclSetuserArgs	removeHashedPassword(String hashedPassword)	Creates new AclSetuserArgs and removes the specified hashed password to the list of user passwords.
static AclSetuserArgs	removePassword(String password)	Creates new AclSetuserArgs and removes the specified clear text password as an hashed password in the list of the users passwords.
static AclSetuserArgs	reset()	Creates new AclSetuserArgs and removes any capability from the user.
static AclSetuserArgs	resetChannels()	Creates new AclSetuserArgs and removes all channel patterns from the list of Pub/Sub channel patterns the user can access.
static AclSetuserArgs	resetKeys()	Creates new AclSetuserArgs and removes all the key patterns from the list of key patterns the user can access.
static AclSetuserArgs	resetpass()	Creates new AclSetuserArgs and sets the user as having no associated passwords.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

on

public static AclSetuserArgs on()

Creates new AclSetuserArgs and set user active.

Returns:

new AclSetuserArgs and set user active.

See Also:

AclSetuserArgs.on()

off

public static AclSetuserArgs off()

Creates new AclSetuserArgs and set user inactive.

Returns:

new AclSetuserArgs and set user inactive.

See Also:

AclSetuserArgs.off()

keyPattern

public static AclSetuserArgs keyPattern(String keyPattern)

Creates new AclSetuserArgs and adds accessible key pattern.

Parameters:

keyPattern - accessible key pattern

Returns:

new AclSetuserArgs and adds accessible key pattern.

See Also:

AclSetuserArgs.keyPattern(String)

allKeys

public static AclSetuserArgs allKeys()

Creates new AclSetuserArgs and allows the user to access all the keys.

Returns:

new AclSetuserArgs and allows the user to access all the keys.

See Also:

AclSetuserArgs.allKeys()

resetKeys

public static AclSetuserArgs resetKeys()

Creates new AclSetuserArgs and removes all the key patterns from the list of key patterns the user can access.

Returns:

new AclSetuserArgs and removes all the key patterns from the list of key patterns the user can access.

See Also:

AclSetuserArgs.resetKeys()

channelPattern

public static AclSetuserArgs channelPattern(String channelPattern)

Creates new AclSetuserArgs and adds accessible channel pattern.

Parameters:

channelPattern - accessible channel pattern

Returns:

new AclSetuserArgs and adds accessible channel pattern.

See Also:

AclSetuserArgs.channelPattern(String)

allChannels

public static AclSetuserArgs allChannels()

Creates new AclSetuserArgs and allows the user to access all the Pub/Sub channels.

Returns:

new AclSetuserArgs and allows the user to access all the Pub/Sub channels.

See Also:

AclSetuserArgs.allChannels()

resetChannels

public static AclSetuserArgs resetChannels()

Creates new AclSetuserArgs and removes all channel patterns from the list of Pub/Sub channel patterns the user can access.

Returns:

new AclSetuserArgs and removes all channel patterns from the list of Pub/Sub channel patterns the user can access.

See Also:

AclSetuserArgs.resetChannels()

addCommand

public static AclSetuserArgs addCommand(CommandType command)

Creates new AclSetuserArgs and adds this command to the list of the commands the user can call.

Parameters:

command - accessible command

Returns:

new AclSetuserArgs and adds this command to the list of the commands the user can call.

See Also:

AclSetuserArgs.addCommand(CommandType)

addCommand

public static AclSetuserArgs addCommand(CommandType command,
                                        ProtocolKeyword subCommand)

Creates new AclSetuserArgs and adds the specified command to the list of the commands the user can execute.

Parameters:

command - accessible command

subCommand - accessible subcommand

Returns:

new AclSetuserArgs and adds the specified command to the list of the commands the user can execute.

See Also:

AclSetuserArgs.addCommand(CommandType, ProtocolKeyword)

allCommands

public static AclSetuserArgs allCommands()

Creates new AclSetuserArgs and adds all the commands there are in the server.

Returns:

new AclSetuserArgs and adds all the commands there are in the server.

See Also:

AclSetuserArgs.allCommands()

removeCommand

public static AclSetuserArgs removeCommand(CommandType command)

Creates new AclSetuserArgs and removes this command to the list of the commands the user can call.

Parameters:

command - inaccessible command

Returns:

new AclSetuserArgs and removes this command to the list of the commands the user can call.

See Also:

AclSetuserArgs.removeCommand(CommandType)

removeCommand

public static AclSetuserArgs removeCommand(CommandType command,
                                           ProtocolKeyword subCommand)

Creates new AclSetuserArgs and removes the specified command to the list of the commands the user can execute.

Parameters:

command - inaccessible command

subCommand - inaccessible subcommand

Returns:

new AclSetuserArgs and removes the specified command to the list of the commands the user can execute.

See Also:

AclSetuserArgs.removeCommand(CommandType, ProtocolKeyword)

noCommands

public static AclSetuserArgs noCommands()

Creates new AclSetuserArgs and removes all the commands the user can execute.

Returns:

new AclSetuserArgs and removes all the commands the user can execute.

See Also:

AclSetuserArgs.noCommands()

addCategory

public static AclSetuserArgs addCategory(AclCategory category)

Creates new AclSetuserArgs and adds all the commands in the specified category to the list of commands the user is able to execute.

Parameters:

category - specified category

Returns:

new AclSetuserArgs and adds all the commands in the specified category to the list of commands the user is able to execute.

See Also:

AclSetuserArgs.addCategory(AclCategory)

removeCategory

public static AclSetuserArgs removeCategory(AclCategory category)

Creates new AclSetuserArgs and removes all the commands in the specified category to the list of commands the user is able to execute.

Parameters:

category - specified category

Returns:

new AclSetuserArgs and removes all the commands in the specified category to the list of commands the user is able to execute.

See Also:

AclSetuserArgs.removeCategory(AclCategory)

nopass

public static AclSetuserArgs nopass()

Creates new AclSetuserArgs and sets the user as a "no password".

Returns:

new AclSetuserArgs and sets the user as a "no password".

See Also:

AclSetuserArgs.nopass()

resetpass

public static AclSetuserArgs resetpass()

Creates new AclSetuserArgs and sets the user as having no associated passwords.

Returns:

new AclSetuserArgs and sets the user as having no associated passwords.

See Also:

AclSetuserArgs.resetpass()

addPassword

public static AclSetuserArgs addPassword(String password)

Creates new AclSetuserArgs and adds the specified clear text password as an hashed password in the list of the users passwords.

Parameters:

password - clear text password

Returns:

new AclSetuserArgs and adds the specified clear text password as an hashed password in the list of the users passwords.

See Also:

AclSetuserArgs.addPassword(String)

addHashedPassword

public static AclSetuserArgs addHashedPassword(String hashedPassword)

Creates new AclSetuserArgs and adds the specified hashed password to the list of user passwords.

Parameters:

hashedPassword - hashed password

Returns:

new AclSetuserArgs and adds the specified hashed password to the list of user passwords.

See Also:

AclSetuserArgs.addHashedPassword(String)

removePassword

public static AclSetuserArgs removePassword(String password)

Creates new AclSetuserArgs and removes the specified clear text password as an hashed password in the list of the users passwords.

Parameters:

password - clear text password

Returns:

new AclSetuserArgs and removes the specified clear text password as an hashed password in the list of the users passwords.

See Also:

AclSetuserArgs.removePassword(String)

removeHashedPassword

public static AclSetuserArgs removeHashedPassword(String hashedPassword)

Creates new AclSetuserArgs and removes the specified hashed password to the list of user passwords.

Parameters:

hashedPassword - hashed password

Returns:

new AclSetuserArgs and removes the specified hashed password to the list of user passwords.

See Also:

AclSetuserArgs.removeHashedPassword(String)

reset

public static AclSetuserArgs reset()

Creates new AclSetuserArgs and removes any capability from the user.

Returns:

new AclSetuserArgs and removes any capability from the user.

See Also:

AclSetuserArgs.reset()