org.opendaylight.controller.cluster.raft.messages.RequestVote Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation
Controller documentation
There is a newer version: 10.0.4
/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.raft.messages;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

/**
 * Invoked by candidates to gather votes (§5.2).
 */
public final class RequestVote extends AbstractRaftRPC {
    @java.io.Serial
    private static final long serialVersionUID = -6967509186297108657L;

    // candidate requesting vote
    private final String candidateId;

    // index of candidate’s last log entry (§5.4)
    private final long lastLogIndex;

    // term of candidate’s last log entry (§5.4)
    private final long lastLogTerm;

    public RequestVote(final long term, final String candidateId, final long lastLogIndex, final long lastLogTerm) {
        super(term);
        this.candidateId = candidateId;
        this.lastLogIndex = lastLogIndex;
        this.lastLogTerm = lastLogTerm;
    }

    public String getCandidateId() {
        return candidateId;
    }

    public long getLastLogIndex() {
        return lastLogIndex;
    }

    public long getLastLogTerm() {
        return lastLogTerm;
    }

    @Override
    public String toString() {
        return "RequestVote [term=" + getTerm()
                + ", candidateId=" + candidateId
                + ", lastLogIndex=" + lastLogIndex
                + ", lastLogTerm=" + lastLogTerm
                + "]";
    }

    @Override
    Object writeReplace() {
        return new RV(this);
    }

    @Deprecated(since = "7.0.0", forRemoval = true)
    private static class Proxy implements Externalizable {
        @java.io.Serial
        private static final long serialVersionUID = 1L;

        private RequestVote requestVote;

        // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
        // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
        @SuppressWarnings("checkstyle:RedundantModifier")
        public Proxy() {
        }

        @Override
        public void writeExternal(final ObjectOutput out) {
            throw new UnsupportedOperationException();
        }

        @Override
        public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
            long term = in.readLong();
            String candidateId = (String) in.readObject();
            long lastLogIndex = in.readLong();
            long lastLogTerm = in.readLong();

            requestVote = new RequestVote(term, candidateId, lastLogIndex, lastLogTerm);
        }

        @java.io.Serial
        private Object readResolve() {
            return requestVote;
        }
    }
}