org.apache.ratis.client.api

接口 AdminApi

public interface AdminApi

An API to support administration such as setting raft configuration and transferring leadership.

方法概要

限定符和类型	方法和说明
default RaftClientReply	setConfiguration(List<RaftPeer> serversInNewConf) The same as setConfiguration(serversInNewConf, Collections.emptyList()).
default RaftClientReply	setConfiguration(List<RaftPeer> serversInNewConf, List<RaftPeer> listenersInNewConf) Set the configuration request to the raft service.
default RaftClientReply	setConfiguration(RaftPeer[] serversInNewConf) The same as setConfiguration(Arrays.asList(serversInNewConf)).
default RaftClientReply	setConfiguration(RaftPeer[] serversInNewConf, RaftPeer[] listenersInNewConf) The same as setConfiguration(Arrays.asList(serversInNewConf), Arrays.asList(listenersInNewConf)).
RaftClientReply	setConfiguration(SetConfigurationRequest.Arguments arguments)
default RaftClientReply	transferLeadership(RaftPeerId newLeader, long timeoutMs) Transfer leadership to the given server.
RaftClientReply	transferLeadership(RaftPeerId newLeader, RaftPeerId leaderId, long timeoutMs)

方法详细资料

setConfiguration

RaftClientReply setConfiguration(SetConfigurationRequest.Arguments arguments)
                          throws IOException

抛出:

IOException

setConfiguration

default RaftClientReply setConfiguration(List<RaftPeer> serversInNewConf)
                                  throws IOException

The same as setConfiguration(serversInNewConf, Collections.emptyList()).

抛出:

IOException

setConfiguration

default RaftClientReply setConfiguration(RaftPeer[] serversInNewConf)
                                  throws IOException

The same as setConfiguration(Arrays.asList(serversInNewConf)).

抛出:

IOException

setConfiguration

default RaftClientReply setConfiguration(List<RaftPeer> serversInNewConf,
                                         List<RaftPeer> listenersInNewConf)
                                  throws IOException

Set the configuration request to the raft service.

抛出:

IOException

setConfiguration

default RaftClientReply setConfiguration(RaftPeer[] serversInNewConf,
                                         RaftPeer[] listenersInNewConf)
                                  throws IOException

The same as setConfiguration(Arrays.asList(serversInNewConf), Arrays.asList(listenersInNewConf)).

抛出:

IOException

transferLeadership

default RaftClientReply transferLeadership(RaftPeerId newLeader,
                                           long timeoutMs)
                                    throws IOException

Transfer leadership to the given server.

抛出:

IOException

transferLeadership

RaftClientReply transferLeadership(RaftPeerId newLeader,
                                   RaftPeerId leaderId,
                                   long timeoutMs)
                            throws IOException

抛出:

IOException