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

Go to download

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

Redis Java client with features of In-Memory Data Grid

There is a newer version: 3.40.2

/**
 * 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 java.util.Collection;

/**
 * Redis Cluster nodes API interface
 *
 * @author Nikita Koksharov
 *
 */
public interface RedisCluster extends BaseRedisNodes {

    /**
     * Returns collection of Redis Master nodes belongs to this Redis Cluster.
     *
     * @return Redis Master nodes
     */
    Collection getMasters();

    /**
     * Returns Redis Master node by defined address.
     * 
     * Address example: redis://127.0.0.1:9233
     *
     * @return Redis Master node
     */
    RedisClusterMaster getMaster(String address);

    /**
     * Returns collection of Redis Slave nodes belongs to this Redis Cluster.
     *
     * @return Redis Slave nodes
     */
    Collection getSlaves();

    /**
     * Returns Redis Slave node by defined address.
     * 
     * Address example: redis://127.0.0.1:9233
     *
     * @return Redis Slave node
     */
    RedisClusterSlave getSlave(String address);

}