io.atomix.raft.roles.RaftRole Maven / Gradle / Ivy
/*
* Copyright 2016-present Open Networking Foundation
* Copyright © 2020 camunda services GmbH ([email protected])
*
* 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 io.atomix.raft.roles;
import io.atomix.raft.RaftServer;
import io.atomix.raft.protocol.AppendRequest;
import io.atomix.raft.protocol.AppendResponse;
import io.atomix.raft.protocol.ConfigureRequest;
import io.atomix.raft.protocol.ConfigureResponse;
import io.atomix.raft.protocol.InstallRequest;
import io.atomix.raft.protocol.InstallResponse;
import io.atomix.raft.protocol.PollRequest;
import io.atomix.raft.protocol.PollResponse;
import io.atomix.raft.protocol.ReconfigureRequest;
import io.atomix.raft.protocol.ReconfigureResponse;
import io.atomix.raft.protocol.TransferRequest;
import io.atomix.raft.protocol.TransferResponse;
import io.atomix.raft.protocol.VoteRequest;
import io.atomix.raft.protocol.VoteResponse;
import io.atomix.utils.Managed;
import java.util.concurrent.CompletableFuture;
/** Raft role interface. */
public interface RaftRole extends Managed {
/**
* Returns the server state type.
*
* @return The server state type.
*/
RaftServer.Role role();
/**
* Handles a configure request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onConfigure(ConfigureRequest request);
/**
* Handles an install request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onInstall(InstallRequest request);
/**
* Handles a configure request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onReconfigure(ReconfigureRequest request);
/**
* Handles a transfer request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onTransfer(TransferRequest request);
/**
* Handles an append request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onAppend(AppendRequest request);
/**
* Handles a poll request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onPoll(PollRequest request);
/**
* Handles a vote request.
*
* @param request The request to handle.
* @return A completable future to be completed with the request response.
*/
CompletableFuture onVote(VoteRequest request);
}