io.atomix.raft.protocol.PollResponse Maven / Gradle / Ivy
/*
* Copyright 2015-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.protocol;
import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import io.atomix.raft.RaftError;
import java.util.Objects;
/**
* Server poll response.
*
* Poll responses are sent by active servers in response to poll requests by followers to
* indicate whether the responding server would vote for the requesting server if it were a
* candidate. This is indicated by the {@link #accepted()} field of the response.
*/
public class PollResponse extends AbstractRaftResponse {
private final long term;
private final boolean accepted;
public PollResponse(
final Status status, final RaftError error, final long term, final boolean accepted) {
super(status, error);
this.term = term;
this.accepted = accepted;
}
/**
* Returns a new poll response builder.
*
* @return A new poll response builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* Returns the responding node's current term.
*
* @return The responding node's current term.
*/
public long term() {
return term;
}
/**
* Returns a boolean indicating whether the poll was accepted.
*
* @return Indicates whether the poll was accepted.
*/
public boolean accepted() {
return accepted;
}
@Override
public int hashCode() {
return Objects.hash(getClass(), status, term, accepted);
}
@Override
public boolean equals(final Object object) {
if (object instanceof PollResponse) {
final PollResponse response = (PollResponse) object;
return response.status == status && response.term == term && response.accepted == accepted;
}
return false;
}
@Override
public String toString() {
if (status == Status.OK) {
return toStringHelper(this)
.add("status", status)
.add("term", term)
.add("accepted", accepted)
.toString();
} else {
return toStringHelper(this).add("status", status).add("error", error).toString();
}
}
/** Poll response builder. */
public static class Builder extends AbstractRaftResponse.Builder {
private long term = -1;
private boolean accepted;
/**
* Sets the response term.
*
* @param term The response term.
* @return The poll response builder.
* @throws IllegalArgumentException if {@code term} is not positive
*/
public Builder withTerm(final long term) {
checkArgument(term >= 0, "term must be positive");
this.term = term;
return this;
}
/**
* Sets whether the poll was granted.
*
* @param accepted Whether the poll was granted.
* @return The poll response builder.
*/
public Builder withAccepted(final boolean accepted) {
this.accepted = accepted;
return this;
}
@Override
public PollResponse build() {
validate();
return new PollResponse(status, error, term, accepted);
}
@Override
protected void validate() {
super.validate();
if (status == Status.OK) {
checkArgument(term >= 0, "term must be positive");
}
}
}
}