CLEANUP : Fix javadoc warnings in sal-akka-raft code
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / ClientRequestTracker.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.controller.cluster.raft;
10
11 import akka.actor.ActorRef;
12
13 public interface ClientRequestTracker {
14     /**
15      *
16      * @return the client actor that should be sent a response when consensus is achieved
17      */
18     ActorRef getClientActor();
19
20     /**
21      *
22      * @return the identifier of the object that is to be replicated. For example a transaction identifier in the case
23      * of a transaction
24      */
25     String getIdentifier();
26
27     /**
28      *
29      * @return the index of the log entry that is to be replicated
30      */
31     long getIndex();
32
33 }