org.apache.ratis.server.impl

Class RaftServerProxy

java.lang.Object

org.apache.ratis.server.impl.RaftServerProxy

All Implemented Interfaces:

Closeable, AutoCloseable, AdminAsynchronousProtocol, AdminProtocol, RaftClientAsynchronousProtocol, RaftClientProtocol, RpcType.Get, RaftServerAsynchronousProtocol, RaftServerProtocol, RaftServer

public class RaftServerProxy
extends Object
implements RaftServer

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ratis.server.RaftServer

RaftServer.Builder

Nested classes/interfaces inherited from interface org.apache.ratis.server.protocol.RaftServerProtocol

RaftServerProtocol.Op

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
CompletableFuture<RaftServerImpl>	addGroup(RaftGroup group)
org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto	appendEntries(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto request)
CompletableFuture<org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto>	appendEntriesAsync(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto request)
void	close()
boolean	containsGroup(RaftGroupId groupId)
ServerFactory	getFactory()
List<RaftGroupId>	getGroupIds()
GroupInfoReply	getGroupInfo(GroupInfoRequest request)
CompletableFuture<GroupInfoReply>	getGroupInfoAsync(GroupInfoRequest request)
GroupListReply	getGroupList(GroupListRequest request)
CompletableFuture<GroupListReply>	getGroupListAsync(GroupListRequest request)
Iterable<RaftGroup>	getGroups()
RaftPeerId	getId()
RaftServerImpl	getImpl(RaftGroupId groupId)
LifeCycle.State	getLifeCycleState()
RaftProperties	getProperties()
RpcType	getRpcType()
RaftServerRpc	getServerRpc()
RaftClientReply	groupManagement(GroupManagementRequest request)
CompletableFuture<RaftClientReply>	groupManagementAsync(GroupManagementRequest request)
org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto	installSnapshot(org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto request)
org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto	requestVote(org.apache.ratis.proto.RaftProtos.RequestVoteRequestProto request)
RaftClientReply	setConfiguration(SetConfigurationRequest request)
CompletableFuture<RaftClientReply>	setConfigurationAsync(SetConfigurationRequest request) Handle a raft configuration change request from client.
void	start() Start this server.
RaftClientReply	submitClientRequest(RaftClientRequest request)
CompletableFuture<RaftClientReply>	submitClientRequestAsync(RaftClientRequest request)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ratis.server.RaftServer

newBuilder

Field Detail

LOG

public static final org.slf4j.Logger LOG

Method Detail

getId

public RaftPeerId getId()

Specified by:

getId in interface RaftServer

Returns:

the server ID.

getGroupIds

public List<RaftGroupId> getGroupIds()

Specified by:

getGroupIds in interface RaftServer

Returns:

the group IDs the server is part of.

getGroups

public Iterable<RaftGroup> getGroups()
                              throws IOException

Specified by:

getGroups in interface RaftServer

Returns:

the groups the server is part of.

Throws:

IOException

getRpcType

public RpcType getRpcType()

Specified by:

getRpcType in interface RpcType.Get

getFactory

public ServerFactory getFactory()

Specified by:

getFactory in interface RaftServer

Returns:

the factory for creating server components.

getProperties

public RaftProperties getProperties()

Specified by:

getProperties in interface RaftServer

Returns:

the server properties.

getServerRpc

public RaftServerRpc getServerRpc()

containsGroup

public boolean containsGroup(RaftGroupId groupId)

addGroup

public CompletableFuture<RaftServerImpl> addGroup(RaftGroup group)

getImpl

public RaftServerImpl getImpl(RaftGroupId groupId)
                       throws IOException

Throws:

IOException

getLifeCycleState

public LifeCycle.State getLifeCycleState()

Specified by:

getLifeCycleState in interface RaftServer

start

public void start()
           throws IOException

Description copied from interface: RaftServer

Start this server.

Specified by:

start in interface RaftServer

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

submitClientRequestAsync

public CompletableFuture<RaftClientReply> submitClientRequestAsync(RaftClientRequest request)

Specified by:

submitClientRequestAsync in interface RaftClientAsynchronousProtocol

submitClientRequest

public RaftClientReply submitClientRequest(RaftClientRequest request)
                                    throws IOException

Specified by:

submitClientRequest in interface RaftClientProtocol

Throws:

IOException

setConfiguration

public RaftClientReply setConfiguration(SetConfigurationRequest request)
                                 throws IOException

Specified by:

setConfiguration in interface RaftClientProtocol

Throws:

IOException

groupManagement

public RaftClientReply groupManagement(GroupManagementRequest request)
                                throws IOException

Specified by:

groupManagement in interface AdminProtocol

Throws:

IOException

groupManagementAsync

public CompletableFuture<RaftClientReply> groupManagementAsync(GroupManagementRequest request)

Specified by:

groupManagementAsync in interface AdminAsynchronousProtocol

getGroupList

public GroupListReply getGroupList(GroupListRequest request)

Specified by:

getGroupList in interface AdminProtocol

getGroupListAsync

public CompletableFuture<GroupListReply> getGroupListAsync(GroupListRequest request)

Specified by:

getGroupListAsync in interface AdminAsynchronousProtocol

getGroupInfo

public GroupInfoReply getGroupInfo(GroupInfoRequest request)
                            throws IOException

Specified by:

getGroupInfo in interface AdminProtocol

Throws:

IOException

getGroupInfoAsync

public CompletableFuture<GroupInfoReply> getGroupInfoAsync(GroupInfoRequest request)

Specified by:

getGroupInfoAsync in interface AdminAsynchronousProtocol

setConfigurationAsync

public CompletableFuture<RaftClientReply> setConfigurationAsync(SetConfigurationRequest request)

Handle a raft configuration change request from client.

Specified by:

setConfigurationAsync in interface RaftClientAsynchronousProtocol

requestVote

public org.apache.ratis.proto.RaftProtos.RequestVoteReplyProto requestVote(org.apache.ratis.proto.RaftProtos.RequestVoteRequestProto request)
                                                                    throws IOException

Specified by:

requestVote in interface RaftServerProtocol

Throws:

IOException

appendEntriesAsync

public CompletableFuture<org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto> appendEntriesAsync(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto request)

Specified by:

appendEntriesAsync in interface RaftServerAsynchronousProtocol

appendEntries

public org.apache.ratis.proto.RaftProtos.AppendEntriesReplyProto appendEntries(org.apache.ratis.proto.RaftProtos.AppendEntriesRequestProto request)
                                                                        throws IOException

Specified by:

appendEntries in interface RaftServerProtocol

Throws:

IOException

installSnapshot

public org.apache.ratis.proto.RaftProtos.InstallSnapshotReplyProto installSnapshot(org.apache.ratis.proto.RaftProtos.InstallSnapshotRequestProto request)
                                                                            throws IOException

Specified by:

installSnapshot in interface RaftServerProtocol

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object