io.lettuce.core.MigrateArgs Maven / Gradle / Ivy
Show all versions of lettuce-core Show documentation
/*
* Copyright 2011-Present, Redis Ltd. and Contributors
* All rights reserved.
*
* Licensed under the MIT License.
*
* This file contains contributions from third-party contributors
* licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.lettuce.core;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import io.lettuce.core.internal.LettuceAssert;
import io.lettuce.core.protocol.CommandArgs;
import io.lettuce.core.protocol.CommandKeyword;
import io.lettuce.core.protocol.CommandType;
/**
* Argument list builder for the Redis MIGRATE command. Static import the
* methods from {@link Builder} and chain the method calls: {@code copy().auth("foobar")}.
*
* {@link MigrateArgs} is a mutable object and instances should be used only once to avoid shared mutable state.
*
* @author Mark Paluch
* @author dengliming
*/
public class MigrateArgs implements CompositeArgument {
private boolean copy = false;
private boolean replace = false;
List keys = new ArrayList<>();
private char[] password;
private char[] username;
/**
* Builder entry points for {@link MigrateArgs}.
*/
public static class Builder {
/**
* Utility constructor.
*/
private Builder() {
}
/**
* Creates new {@link MigrateArgs} and enabling {@literal COPY}.
*
* @return new {@link MigrateArgs} with {@literal COPY} enabled.
* @see MigrateArgs#copy()
*/
public static MigrateArgs copy() {
return new MigrateArgs().copy();
}
/**
* Creates new {@link MigrateArgs} and enabling {@literal REPLACE}.
*
* @return new {@link MigrateArgs} with {@literal REPLACE} enabled.
* @see MigrateArgs#replace()
*/
public static MigrateArgs replace() {
return new MigrateArgs().replace();
}
/**
* Creates new {@link MigrateArgs} setting a {@code key} to migrate.
*
* @param key must not be {@code null}.
* @return new {@link MigrateArgs} for {@code key} to migrate.
* @see MigrateArgs#key(Object)
*/
public static MigrateArgs key(K key) {
return new MigrateArgs().key(key);
}
/**
* Creates new {@link MigrateArgs} setting {@code keys} to migrate.
*
* @param keys must not be {@code null}.
* @return new {@link MigrateArgs} for {@code keys} to migrate.
* @see MigrateArgs#keys(Object[])
*/
@SafeVarargs
public static MigrateArgs keys(K... keys) {
return new MigrateArgs().keys(keys);
}
/**
* Creates new {@link MigrateArgs} setting {@code keys} to migrate.
*
* @param keys must not be {@code null}.
* @return new {@link MigrateArgs} for {@code keys} to migrate.
* @see MigrateArgs#keys(Iterable)
*/
public static MigrateArgs keys(Iterable keys) {
return new MigrateArgs().keys(keys);
}
/**
* Creates new {@link MigrateArgs} with {@code AUTH} (target authentication) enabled.
*
* @return new {@link MigrateArgs} with {@code AUTH} (target authentication) enabled.
* @since 4.4.5
* @see MigrateArgs#auth(CharSequence)
*/
public static MigrateArgs auth(CharSequence password) {
return new MigrateArgs().auth(password);
}
/**
* Creates new {@link MigrateArgs} with {@code AUTH2} (target authentication) enabled.
*
* @return new {@link MigrateArgs} with {@code AUTH2} (target authentication) enabled.
* @since 6.1
* @see MigrateArgs#auth2(CharSequence, CharSequence)
*/
public static MigrateArgs auth2(CharSequence username, CharSequence password) {
return new MigrateArgs().auth2(username, password);
}
/**
* Creates new {@link MigrateArgs} with {@code AUTH} (target authentication) enabled.
*
* @return new {@link MigrateArgs} with {@code AUTH} (target authentication) enabled.
* @since 4.4.5
* @see MigrateArgs#auth(char[])
*/
public static MigrateArgs auth(char[] password) {
return new MigrateArgs().auth(password);
}
}
/**
* Do not remove the key from the local instance by setting {@code COPY}.
*
* @return {@code this} {@link MigrateArgs}.
*/
public MigrateArgs copy() {
this.copy = true;
return this;
}
/**
* Replace existing key on the remote instance by setting {@code REPLACE}.
*
* @return {@code this} {@link MigrateArgs}.
*/
public MigrateArgs replace() {
this.replace = true;
return this;
}
/**
* Migrate a single {@code key}.
*
* @param key must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
*/
public MigrateArgs key(K key) {
LettuceAssert.notNull(key, "Key must not be null");
this.keys.add(key);
return this;
}
/**
* Migrate one or more {@code keys}.
*
* @param keys must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
*/
@SafeVarargs
public final MigrateArgs keys(K... keys) {
LettuceAssert.notEmpty(keys, "Keys must not be empty");
this.keys.addAll(Arrays.asList(keys));
return this;
}
/**
* Migrate one or more {@code keys}.
*
* @param keys must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
*/
public MigrateArgs keys(Iterable keys) {
LettuceAssert.notNull(keys, "Keys must not be null");
for (K key : keys) {
this.keys.add(key);
}
return this;
}
/**
* Set {@literal AUTH} {@code password} option.
*
* @param password must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
* @since 4.4.5
*/
public MigrateArgs auth(CharSequence password) {
LettuceAssert.notNull(password, "Password must not be null");
char[] chars = new char[password.length()];
for (int i = 0; i < password.length(); i++) {
chars[i] = password.charAt(i);
}
this.password = chars;
return this;
}
/**
* Set {@literal AUTH2} {@code username} and {@code password} option.
*
* @param username must not be {@code null}.
* @param password must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
* @since 6.1
*/
public MigrateArgs auth2(CharSequence username, CharSequence password) {
LettuceAssert.notNull(username, "Username must not be null");
LettuceAssert.notNull(password, "Password must not be null");
char[] chars = new char[username.length()];
for (int i = 0; i < username.length(); i++) {
chars[i] = username.charAt(i);
}
this.username = chars;
return auth(password);
}
/**
* Set {@literal AUTH} {@code password} option.
*
* @param password must not be {@code null}.
* @return {@code this} {@link MigrateArgs}.
* @since 4.4.5
*/
public MigrateArgs auth(char[] password) {
LettuceAssert.notNull(password, "Password must not be null");
this.password = Arrays.copyOf(password, password.length);
return this;
}
@SuppressWarnings("unchecked")
public void build(CommandArgs args) {
if (copy) {
args.add(CommandKeyword.COPY);
}
if (replace) {
args.add(CommandKeyword.REPLACE);
}
if (password != null) {
if (username != null) {
args.add(CommandType.AUTH2).add(username);
} else {
args.add(CommandType.AUTH);
}
args.add(password);
}
if (keys.size() > 1) {
args.add(CommandType.KEYS);
args.addKeys((List) keys);
}
}
}