CliServiceImpl (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.core.CliServiceImpl

所有已实现的接口:

CliService, Lifecycle<CliOptions>
```
public class CliServiceImpl
extends Object
implements CliService
```
Cli service implementation.

作者:

boyan (boyan@alibaba-inc.com), jiachun.fjc

构造器概要

构造器
构造器和说明

CliServiceImpl()

构造器
构造器和说明
`CliServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Status`	`addLearners(String groupId, Configuration conf, List<PeerId> learners)` Add some new learners into the replicating group which consists of \|conf\|.
`Status`	`addPeer(String groupId, Configuration conf, PeerId peer)` Add a new peer into the replicating group which consists of \|conf\|.
`Status`	`changePeers(String groupId, Configuration conf, Configuration newPeers)` Gracefully change the peers of the replication group.
`List<PeerId>`	`getAliveLearners(String groupId, Configuration conf)` Ask all alive learners of the replication group.
`List<PeerId>`	`getAlivePeers(String groupId, Configuration conf)` Ask all alive peers of the replication group.
`CliClientService`	`getCliClientService()`
`Status`	`getLeader(String groupId, Configuration conf, PeerId leaderId)` Get the leader of the replication group.
`List<PeerId>`	`getLearners(String groupId, Configuration conf)` Ask all learners of the replication group.
`List<PeerId>`	`getPeers(String groupId, Configuration conf)` Ask all peers of the replication group.
`boolean`	`init(CliOptions opts)` Initialize the service.
`Status`	`learner2Follower(String groupId, Configuration conf, PeerId learner)` Converts the specified learner to follower of \|conf\|.
`Status`	`rebalance(Set<String> balanceGroupIds, Configuration conf, Map<String,PeerId> rebalancedLeaderIds)` Balance the number of leaders.
`Status`	`removeLearners(String groupId, Configuration conf, List<PeerId> learners)` Remove some learners from the replicating group which consists of \|conf\|.
`Status`	`removePeer(String groupId, Configuration conf, PeerId peer)` Remove a peer from the replicating group which consists of \|conf\|.
`Status`	`resetLearners(String groupId, Configuration conf, List<PeerId> learners)` Update learners set in the replicating group which consists of \|conf\|.
`Status`	`resetPeer(String groupId, PeerId peerId, Configuration newPeers)` Reset the peer set of the target peer.
`void`	`shutdown()` Dispose the resources for service.
`Status`	`snapshot(String groupId, PeerId peer)` Ask the peer to dump a snapshot immediately.
`Status`	`transferLeader(String groupId, Configuration conf, PeerId peer)` Transfer the leader of the replication group to the target peer

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CliServiceImpl
```
public CliServiceImpl()
```
- 方法详细资料
  - init
```
public boolean init(CliOptions opts)
```
    从接口复制的说明: Lifecycle
    
    Initialize the service.
    
    指定者:
    
    init 在接口中 Lifecycle<CliOptions>
    
    返回:
    
    true when successes.
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: Lifecycle
    
    Dispose the resources for service.
    
    指定者:
    
    shutdown 在接口中 Lifecycle<CliOptions>
  - addPeer
```
public Status addPeer(String groupId,
                      Configuration conf,
                      PeerId peer)
```
    从接口复制的说明: CliService
    
    Add a new peer into the replicating group which consists of |conf|. return OK status when success.
    
    指定者:
    
    addPeer 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - peer to add
    
    返回:
    
    operation status
  - removePeer
```
public Status removePeer(String groupId,
                         Configuration conf,
                         PeerId peer)
```
    从接口复制的说明: CliService
    
    Remove a peer from the replicating group which consists of |conf|. return OK status when success.
    
    指定者:
    
    removePeer 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - peer to remove
    
    返回:
    
    operation status
  - changePeers
```
public Status changePeers(String groupId,
                          Configuration conf,
                          Configuration newPeers)
```
    从接口复制的说明: CliService
    
    Gracefully change the peers of the replication group.
    
    指定者:
    
    changePeers 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    newPeers - new peers to change
    
    返回:
    
    operation status
  - resetPeer
```
public Status resetPeer(String groupId,
                        PeerId peerId,
                        Configuration newPeers)
```
    从接口复制的说明: CliService
    
    Reset the peer set of the target peer.
    
    指定者:
    
    resetPeer 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    peerId - target peer
    
    newPeers - new peers to reset
    
    返回:
    
    operation status
  - addLearners
```
public Status addLearners(String groupId,
                          Configuration conf,
                          List<PeerId> learners)
```
    从接口复制的说明: CliService
    
    Add some new learners into the replicating group which consists of |conf|. return OK status when success.
    
    指定者:
    
    addLearners 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to add
    
    返回:
    
    operation status
  - removeLearners
```
public Status removeLearners(String groupId,
                             Configuration conf,
                             List<PeerId> learners)
```
    从接口复制的说明: CliService
    
    Remove some learners from the replicating group which consists of |conf|. return OK status when success.
    
    指定者:
    
    removeLearners 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to remove
    
    返回:
    
    operation status
  - learner2Follower
```
public Status learner2Follower(String groupId,
                               Configuration conf,
                               PeerId learner)
```
    从接口复制的说明: CliService
    
    Converts the specified learner to follower of |conf|. return OK status when success.
    
    指定者:
    
    learner2Follower 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learner - learner peer
    
    返回:
    
    operation status
  - resetLearners
```
public Status resetLearners(String groupId,
                            Configuration conf,
                            List<PeerId> learners)
```
    从接口复制的说明: CliService
    
    Update learners set in the replicating group which consists of |conf|. return OK status when success.
    
    指定者:
    
    resetLearners 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    learners - learner peers to set
    
    返回:
    
    operation status
  - transferLeader
```
public Status transferLeader(String groupId,
                             Configuration conf,
                             PeerId peer)
```
    从接口复制的说明: CliService
    
    Transfer the leader of the replication group to the target peer
    
    指定者:
    
    transferLeader 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - current configuration
    
    peer - target peer of new leader
    
    返回:
    
    operation status
  - snapshot
```
public Status snapshot(String groupId,
                       PeerId peer)
```
    从接口复制的说明: CliService
    
    Ask the peer to dump a snapshot immediately.
    
    指定者:
    
    snapshot 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    peer - target peer
    
    返回:
    
    operation status
  - getLeader
```
public Status getLeader(String groupId,
                        Configuration conf,
                        PeerId leaderId)
```
    从接口复制的说明: CliService
    
    Get the leader of the replication group.
    
    指定者:
    
    getLeader 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - configuration
    
    leaderId - id of leader
    
    返回:
    
    operation status
  - getPeers
```
public List<PeerId> getPeers(String groupId,
                             Configuration conf)
```
    从接口复制的说明: CliService
    
    Ask all peers of the replication group.
    
    指定者:
    
    getPeers 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all peers of the replication group
  - getAlivePeers
```
public List<PeerId> getAlivePeers(String groupId,
                                  Configuration conf)
```
    从接口复制的说明: CliService
    
    Ask all alive peers of the replication group.
    
    指定者:
    
    getAlivePeers 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all alive peers of the replication group
  - getLearners
```
public List<PeerId> getLearners(String groupId,
                                Configuration conf)
```
    从接口复制的说明: CliService
    
    Ask all learners of the replication group.
    
    指定者:
    
    getLearners 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all learners of the replication group
  - getAliveLearners
```
public List<PeerId> getAliveLearners(String groupId,
                                     Configuration conf)
```
    从接口复制的说明: CliService
    
    Ask all alive learners of the replication group.
    
    指定者:
    
    getAliveLearners 在接口中 CliService
    
    参数:
    
    groupId - the raft group id
    
    conf - target peers configuration
    
    返回:
    
    all alive learners of the replication group
  - rebalance
```
public Status rebalance(Set<String> balanceGroupIds,
                        Configuration conf,
                        Map<String,PeerId> rebalancedLeaderIds)
```
    从接口复制的说明: CliService
    
    Balance the number of leaders.
    
    指定者:
    
    rebalance 在接口中 CliService
    
    参数:
    
    balanceGroupIds - all raft group ids to balance
    
    conf - configuration of all nodes
    
    rebalancedLeaderIds - the result of all balanced leader ids
    
    返回:
    
    operation status
  - getCliClientService
```
public CliClientService getCliClientService()
```

类 CliServiceImpl

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CliServiceImpl

方法详细资料

init

shutdown

addPeer

removePeer

changePeers

resetPeer

addLearners

removeLearners

learner2Follower

resetLearners

transferLeader

snapshot

getLeader

getPeers

getAlivePeers

getLearners

getAliveLearners

rebalance

getCliClientService