org.redisson.api.redisnode.RedisClusterNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

The newest version!

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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
 *
 *    http://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 org.redisson.api.redisnode;

import org.redisson.cluster.ClusterSlotRange;

import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Base Redis Cluster node API interface
 *
 * @author Nikita Koksharov
 *
 */
public interface RedisClusterNode extends RedisNode, RedisClusterNodeAsync {

    /**
     * Returns cluster information reported by this Redis node
     *
     * @return cluster information
     */
    Map clusterInfo();

    /**
     * Returns id of this Redis node
     *
     * @return Redis node Id
     */
    String clusterId();

    /**
     * Adds slots to this Redis node
     *
     * @param slots slots to add
     */
    void clusterAddSlots(int... slots);

    /**
     * Reconfigures this Redis node as replica of Redis node by defined id.
     *
     * @param nodeId Redis node Id
     */
    void clusterReplicate(String nodeId);

    /**
     * Removes Redis node by defined id from Cluster
     *
     * @param nodeId
     */
    void clusterForget(String nodeId);

    /**
     * Removes slots from this Redis node
     *
     * @param slots slots to remove
     */
    void clusterDeleteSlots(int... slots);

    /**
     * Counts keys in defined slot
     *
     * @param slot slot
     * @return keys amount
     */
    long clusterCountKeysInSlot(int slot);

    /**
     * Returns keys in defines slot limited by count
     *
     * @param slot slot
     * @param count limits keys amount
     * @return keys
     */
    List clusterGetKeysInSlot(int slot, int count);

    /**
     * Sets slot to this Redis node according to defined command
     *
     * @param slot slot
     * @param command slot command
     */
    void clusterSetSlot(int slot, SetSlotCommand command);

    /**
     * Sets slot to this Redis node according to defined command
     *
     * @param slot slot
     * @param command slot command
     * @param nodeId Redis node id
     */
    void clusterSetSlot(int slot, SetSlotCommand command, String nodeId);

    /**
     * Joins Redis node by the defined address to Cluster
     * 
     * Address example: redis://127.0.0.1:9233
     *
     * @param address Redis node address
     */
    void clusterMeet(String address);

    /**
     * Returns number of failure reports for Redis node by defined id
     *
     * @param nodeId Redis node id
     * @return amount of failure reports
     */
    long clusterCountFailureReports(String nodeId);

    /**
     * Removes all slots from this Redis node
     */
    void clusterFlushSlots();

    /**
     * Return Redis Cluster slots mapped to Redis nodes
     *
     * @return slots mapping
     */
    Map> clusterSlots();

}