diff --git a/src/navigators/smart/communication/SystemMessage.java b/src/navigators/smart/communication/SystemMessage.java index 45bf7dc5e1c9b9bc8e78627aa91ab527ebd05539..0e16ab822afa4b9dc819baa086d2908d85be7437 100644 --- a/src/navigators/smart/communication/SystemMessage.java +++ b/src/navigators/smart/communication/SystemMessage.java @@ -47,7 +47,7 @@ public abstract class SystemMessage implements Externalizable { /** * Returns the ID of the process which sent the message - * @return + * @return ID of the process that sent the message */ public final int getSender() { return sender; diff --git a/src/navigators/smart/paxosatwar/Consensus.java b/src/navigators/smart/paxosatwar/Consensus.java index baddc047962dc41db9c7eb5b179e7584bc8cd937..7ab6c31e944653fe7718d517c07158064eaf92c0 100644 --- a/src/navigators/smart/paxosatwar/Consensus.java +++ b/src/navigators/smart/paxosatwar/Consensus.java @@ -25,9 +25,7 @@ import navigators.smart.tom.util.Logger; * * This class represents a Consensus Instance. * - * @param Type of the decided Object * - * @author unkown * @author Christian Spann */ public class Consensus { @@ -43,9 +41,7 @@ public class Consensus { /** * Creates a new instance of Consensus - * @param proposer The proposer role of PaW algorithm * @param eid The execution ID for this consensus - * @param startTime The consensus start time */ public Consensus(int eid) { this.eid = eid; diff --git a/src/navigators/smart/paxosatwar/executionmanager/Execution.java b/src/navigators/smart/paxosatwar/executionmanager/Execution.java index 3337f678ef84fb3c05a25f2374d7c09bcc2f01f0..a51896d2ff8c0bd5a6118c7f01d54b2637a0fac5 100644 --- a/src/navigators/smart/paxosatwar/executionmanager/Execution.java +++ b/src/navigators/smart/paxosatwar/executionmanager/Execution.java @@ -55,7 +55,6 @@ public class Execution { * * @param manager Execution manager for this execution * @param consensus Consensus instance to which this execution works for - * @param initialTimeout Initial timeout for rounds */ protected Execution(ExecutionManager manager, Consensus consensus) { this.manager = manager; diff --git a/src/navigators/smart/paxosatwar/executionmanager/ExecutionManager.java b/src/navigators/smart/paxosatwar/executionmanager/ExecutionManager.java index 4d3f6aefc4b30c913f1e94ff8798c735757d9cb2..9b84664cd6b30af9b864ef9e6530ede5b3dc1f4f 100644 --- a/src/navigators/smart/paxosatwar/executionmanager/ExecutionManager.java +++ b/src/navigators/smart/paxosatwar/executionmanager/ExecutionManager.java @@ -71,12 +71,10 @@ public final class ExecutionManager { /** * Creates a new instance of ExecutionManager * + * @param manager Reconfiguration Manager * @param acceptor Acceptor role of the PaW algorithm * @param proposer Proposer role of the PaW algorithm - * @param acceptors Process ID's of all replicas, including this one - * @param f Maximum number of replicas that can be faulty * @param me This process ID - * @param initialTimeout initial timeout for rounds */ public ExecutionManager(ReconfigurationManager manager, Acceptor acceptor, Proposer proposer, int me) { diff --git a/src/navigators/smart/paxosatwar/executionmanager/Round.java b/src/navigators/smart/paxosatwar/executionmanager/Round.java index da1e10582ca8de7f4ad5403593544225df724b5f..5f96e5a0a337a551c5de9d65cd503d27da6bdf94 100644 --- a/src/navigators/smart/paxosatwar/executionmanager/Round.java +++ b/src/navigators/smart/paxosatwar/executionmanager/Round.java @@ -56,9 +56,9 @@ public class Round implements Serializable { /** * Creates a new instance of Round for acceptors + * @param manager Reconfiguration Manager * @param parent Execution to which this round belongs * @param number Number of the round - * @param timeout Timeout duration for this round */ protected Round(ReconfigurationManager manager, Execution parent, int number) { this.execution = parent; diff --git a/src/navigators/smart/paxosatwar/roles/Acceptor.java b/src/navigators/smart/paxosatwar/roles/Acceptor.java index 2a627e48ac950f14ca9fc1600bde6efb87351a9a..bf8376354abd3634ac221f485343d9ebf607cdc4 100644 --- a/src/navigators/smart/paxosatwar/roles/Acceptor.java +++ b/src/navigators/smart/paxosatwar/roles/Acceptor.java @@ -52,8 +52,8 @@ public final class Acceptor { * Creates a new instance of Acceptor. * @param communication Replicas communication system * @param factory Message factory for PaW messages - * @param verifier Proof verifier - * @param conf TOM configuration + * @param lm Leader Module + * @param manager Reconfiguration Manager */ public Acceptor(ServerCommunicationSystem communication, MessageFactory factory, LeaderModule lm, ReconfigurationManager manager) { diff --git a/src/navigators/smart/paxosatwar/roles/Proposer.java b/src/navigators/smart/paxosatwar/roles/Proposer.java index 7b32c0b0b5e0bccf9c44ccf507c1ec29a03b08d7..543d0cab3e1413839d3e7999f72921df61e7e638 100644 --- a/src/navigators/smart/paxosatwar/roles/Proposer.java +++ b/src/navigators/smart/paxosatwar/roles/Proposer.java @@ -37,8 +37,7 @@ public class Proposer { * * @param communication Replicas communication system * @param factory Factory for PaW messages - * @param verifier Proof verifier - * @param conf TOM configuration + * @param manager Reconfiguration Manager */ public Proposer(ServerCommunicationSystem communication, MessageFactory factory, ReconfigurationManager manager) { diff --git a/src/navigators/smart/statemanagment/StateLog.java b/src/navigators/smart/statemanagment/StateLog.java index 4bace5e80d5ab96afe750b8a140140a5347992ef..ab2620b269f35c74c2891905824393ced8d82a7a 100644 --- a/src/navigators/smart/statemanagment/StateLog.java +++ b/src/navigators/smart/statemanagment/StateLog.java @@ -88,7 +88,7 @@ public class StateLog { /** * Sets the decision round for the last checkpoint - * @param lastCheckpointEid Decision round for the last checkpoint + * @param lastCheckpointRound Decision round for the last checkpoint */ public void setLastCheckpointRound(int lastCheckpointRound) { @@ -106,7 +106,7 @@ public class StateLog { /** * Sets the leader for the last checkpoint - * @param lastCheckpointEid Leader for the last checkpoint + * @param lastCheckpointLeader Leader for the last checkpoint */ public void setLastCheckpointLeader(int lastCheckpointLeader) { @@ -161,7 +161,6 @@ public class StateLog { * in the same order in which they are delivered to the application. Only * the 'k' batches received after the last checkpoint are supposed to be kept * @param batch The batch of messages to be kept. - * @return True if the batch was added to the log, false otherwise */ public void addMessageBatch(byte[] batch, int round, int leader) { diff --git a/src/navigators/smart/statemanagment/TransferableState.java b/src/navigators/smart/statemanagment/TransferableState.java index f60ca1bdea9dd385886ff2c7402b4958bbd76382..004f7e0ad1802810cb615804d146b11aff388b6e 100644 --- a/src/navigators/smart/statemanagment/TransferableState.java +++ b/src/navigators/smart/statemanagment/TransferableState.java @@ -43,7 +43,6 @@ public class TransferableState implements Serializable { * Constructs a TansferableState * This constructor should be used when there is a valid state to construct the object with * @param messageBatches Batches received since the last checkpoint. - * @param nextEid Execution ID for the last checkpoint * @param state State associated with the last checkpoint * @param stateHash Hash of the state associated with the last checkpoint */ diff --git a/src/navigators/smart/tom/ReplicaContext.java b/src/navigators/smart/tom/ReplicaContext.java index 15df7542e16adec2c9492ee9202dd4e9bfdd39ef..59f7c63ef845ea59b3a3e5cbd80ef06c6aa628b5 100644 --- a/src/navigators/smart/tom/ReplicaContext.java +++ b/src/navigators/smart/tom/ReplicaContext.java @@ -32,7 +32,7 @@ public class ReplicaContext { * send a message to one or more clients. * * @param targets the target receivers of the message - * @param sm the message to be sent + * @param msg the message to be sent */ public void sendMessage(int[] targets, TOMMessage msg) { cs.send(targets, msg); diff --git a/src/navigators/smart/tom/ServiceProxy.java b/src/navigators/smart/tom/ServiceProxy.java index b7ff950392bbd0a8c01602f48631498d94b518d0..8e50b7523a4f078b3f94b25ee627f8fbadd0ac5f 100644 --- a/src/navigators/smart/tom/ServiceProxy.java +++ b/src/navigators/smart/tom/ServiceProxy.java @@ -55,7 +55,6 @@ public class ServiceProxy extends TOMSender { /** * Constructor * - * @see bellow */ public ServiceProxy(int processId) { this(processId, null, null, null); @@ -64,7 +63,6 @@ public class ServiceProxy extends TOMSender { /** * Constructor * - * @see bellow */ public ServiceProxy(int processId, String configHome) { this(processId, configHome, null, null); @@ -73,7 +71,7 @@ public class ServiceProxy extends TOMSender { /** * Constructor * - * @param id Process id for this client (should be different from replicas) + * @param processId Process id for this client (should be different from replicas) * @param configHome Configuration directory for BFT-SMART * @param replyComparator used for comparing replies from different servers * to extract one returned by f+1 diff --git a/src/navigators/smart/tom/ServiceReplica.java b/src/navigators/smart/tom/ServiceReplica.java index 554242b91b65987272a652c23960f80b25145bad..fa467d15755f539e8c4e7b8538e3398a51e7422e 100644 --- a/src/navigators/smart/tom/ServiceReplica.java +++ b/src/navigators/smart/tom/ServiceReplica.java @@ -98,7 +98,7 @@ public abstract class ServiceReplica extends TOMReceiver implements Runnable { /** * Constructor * @param id Replica ID - * @param isToJoin: if true, the replica tries to join the system, otherwise it waits for TTP message + * @param isToJoin if true, the replica tries to join the system, otherwise it waits for TTP message * informing its join */ public ServiceReplica(int id, boolean isToJoin) { @@ -343,7 +343,7 @@ public abstract class ServiceReplica extends TOMReceiver implements Runnable { * therefore, ensure the determinism required in a replicated state machine. * * @param command the command issue by the client - * @param MessageContext msgCtx information related with the command + * @param msgCtx information related with the command * * @return the reply for the request issued by the client */ @@ -357,7 +357,7 @@ public abstract class ServiceReplica extends TOMReceiver implements Runnable { * sender. * * @param command the command issue by the client - * @param MessageContext msgCtx information related with the command + * @param msgCtx information related with the command * * @return the reply for the request issued by the client */ diff --git a/src/navigators/smart/tom/TOMReceiver.java b/src/navigators/smart/tom/TOMReceiver.java index 4597c253188b77034fc2efe72bf372340a979b10..4cc0c3556a189d679ad8d794f1574e156fd4671a 100644 --- a/src/navigators/smart/tom/TOMReceiver.java +++ b/src/navigators/smart/tom/TOMReceiver.java @@ -46,7 +46,7 @@ public abstract class TOMReceiver implements TOMRequestReceiver { * This method initializes the object * * @param cs Server side communication System - * @param conf Total order messaging configuration + * @param reconfManager Reconfiguration Manager */ public void init(ServerCommunicationSystem cs, ReconfigurationManager reconfManager, int lastExec, int lastLeader) { diff --git a/src/navigators/smart/tom/TOMSender.java b/src/navigators/smart/tom/TOMSender.java index d1ad1f7c733510860891bf4440a9540cceed37ed..12ad067ef2cc72c14a6dcd6ac3aa354ed71ae6ec 100644 --- a/src/navigators/smart/tom/TOMSender.java +++ b/src/navigators/smart/tom/TOMSender.java @@ -80,8 +80,7 @@ public abstract class TOMSender implements ReplyReceiver { * This method initializes the object * TODO: Perguntar se este metodo n pode antes ser protected (compila como protected, mas mesmo assim...) * - * @param cs Client side comunication system - * @param conf Client side comunication system configuration + * @param processId ID of the process * @param sequence Initial sequence number for data multicast * * @@ -102,8 +101,7 @@ public abstract class TOMSender implements ReplyReceiver { * This method initializes the object * TODO: Perguntar se este metodo n pode antes ser protected (compila como protected, mas mesmo assim...) * - * @param cs Client side comunication system - * @param conf Total order messaging configuration + * @param processId ID of the process */ public void init(int processId) { this.viewManager = new ViewManager(processId); @@ -151,7 +149,7 @@ public abstract class TOMSender implements ReplyReceiver { /** * Multicast a TOMMessage to the group of replicas * - * @param m Data to be multicast + * @param sm Message to be multicast */ public void TOMulticast(TOMMessage sm) { cs.send(useSignatures, this.viewManager.getCurrentViewProcesses(), sm); diff --git a/src/navigators/smart/tom/core/DeliveryThread.java b/src/navigators/smart/tom/core/DeliveryThread.java index 87988e937392b1e8a4603b812aca32f941205023..303f25f6b1ac7868de3a4c623ec4ba646e6a4405 100644 --- a/src/navigators/smart/tom/core/DeliveryThread.java +++ b/src/navigators/smart/tom/core/DeliveryThread.java @@ -48,7 +48,7 @@ public final class DeliveryThread extends Thread { * Creates a new instance of DeliveryThread * @param tomLayer TOM layer * @param receiver Object that receives requests from clients - * @param conf TOM configuration + * @param manager Reconfiguration Manager */ public DeliveryThread(TOMLayer tomLayer, TOMRequestReceiver receiver, ReconfigurationManager manager) { super("Delivery Thread"); diff --git a/src/navigators/smart/tom/core/TOMLayer.java b/src/navigators/smart/tom/core/TOMLayer.java index c6ef2d6e47b797077cce6f01fc72a4fdacc40815..2ea99c478d9c7fcc76255dabbd942ca42a5b822a 100644 --- a/src/navigators/smart/tom/core/TOMLayer.java +++ b/src/navigators/smart/tom/core/TOMLayer.java @@ -119,7 +119,7 @@ public final class TOMLayer extends Thread implements RequestReceiver { * @param lm Leader module * @param a Acceptor role of the PaW algorithm * @param cs Communication system between replicas - * @param conf TOM configuration + * @param recManager Reconfiguration Manager */ public TOMLayer(ExecutionManager manager, TOMRequestReceiver receiver, @@ -174,7 +174,7 @@ public final class TOMLayer extends Thread implements RequestReceiver { /** * Computes an hash for a TOM message - * @param message + * @param data Data from which to generate the hash * @return Hash for the specified TOM message */ public final byte[] computeHash(byte[] data) { @@ -401,9 +401,8 @@ public final class TOMLayer extends Thread implements RequestReceiver { * * TODO: verify timestamps and nonces * - * @param round the Round for which this value is being proposed * @param proposedValue the value being proposed - * @return + * @return Valid messages contained in the proposed value */ public TOMMessage[] checkProposedValue(byte[] proposedValue) { Logger.println("(TOMLayer.isProposedValueValid) starting"); diff --git a/src/navigators/smart/tom/core/messages/TOMMessage.java b/src/navigators/smart/tom/core/messages/TOMMessage.java index 61eec431a1ec9980f92c21714de64cc429f81050..1e59712e8bd5d0998a4ff12069387285c87354f5 100644 --- a/src/navigators/smart/tom/core/messages/TOMMessage.java +++ b/src/navigators/smart/tom/core/messages/TOMMessage.java @@ -125,7 +125,6 @@ public class TOMMessage extends SystemMessage implements Externalizable, Compara /** * Retrieves the debug info from the TOM layer - * @return The debug info from the TOM layer */ public void setDebugInfo(DebugInfo info) { this.info = info; diff --git a/src/navigators/smart/tom/demo/random/RandomServer.java b/src/navigators/smart/tom/demo/random/RandomServer.java index 3766d00bd167c19264d5a5b9397bf5cefa09e504..be6323a822b8f353dd0af2a0c082c15bffa5c88a 100644 --- a/src/navigators/smart/tom/demo/random/RandomServer.java +++ b/src/navigators/smart/tom/demo/random/RandomServer.java @@ -98,9 +98,9 @@ public final class RandomServer extends ServiceReplica { /** * Just return the current value of the counter. * - * @param command - * @param msgCtx - * @return + * @param command Command to b executed + * @param msgCtx Context of the message received + * @return Reply t obe sent to the client */ @Override public byte[] executeUnordered(byte[] command, MessageContext msgCtx) { diff --git a/src/navigators/smart/tom/leaderchange/CollectData.java b/src/navigators/smart/tom/leaderchange/CollectData.java index 274da844d16895336aa423d8effaccf55fc68577..42be14872b3ed46f3ee1e283138eb63e2d6caa94 100644 --- a/src/navigators/smart/tom/leaderchange/CollectData.java +++ b/src/navigators/smart/tom/leaderchange/CollectData.java @@ -54,7 +54,6 @@ public class CollectData implements Externalizable { * @param eid id da execucao * @param quorumWeaks ultimo valor recebido de um quorum bizantino de WEAKS * @param writeSet valores escritos pela replica - * @param signature assinatura da replica */ public CollectData(int pid, int eid, RoundValuePair quorumWeaks, HashSet writeSet) { diff --git a/src/navigators/smart/tom/leaderchange/LCManager.java b/src/navigators/smart/tom/leaderchange/LCManager.java index dda6585beb193d31e96f643fbe6a2736987ec64f..771e3e234f8614e03b006e8effb37acd754ff0bc 100644 --- a/src/navigators/smart/tom/leaderchange/LCManager.java +++ b/src/navigators/smart/tom/leaderchange/LCManager.java @@ -258,7 +258,7 @@ public class LCManager { /** * Defines the set of last eids related to a timestamp * @param ts timestamp for the last eid info - * @param colls a set of last eid data + * @param lasts a set of last eid data */ public void setLastEids(int ts, HashSet lasts) { @@ -268,7 +268,7 @@ public class LCManager { /** * Keep collect from an incoming SYNC message * @param ts the current timestamp - * @param collect the collect data + * @param signedCollect the signed collect data */ public void addCollect(int ts, SignedObject signedCollect) { @@ -391,19 +391,14 @@ public class LCManager { */ public boolean binds(int round, byte[] value, HashSet collects) { - /*System.out.println(value != null); - System.out.println(collects != null); - System.out.println(collects.size() > reconfManager.getCurrentViewN() - reconfManager.getCurrentViewF()); - System.out.println(quorumHighest(round, value, collects)); - System.out.println(certifiedValue(round, value, collects));*/ return (value != null && collects != null && collects.size() > (reconfManager.getCurrentViewN() - reconfManager.getCurrentViewF())) && quorumHighest(round, value, collects) && certifiedValue(round, value, collects); } /** * Devolve um valor que seja bind, que seja diferente de nulo e com round maior ou igual a zero - * @param collects - * @return + * @param collects Conjunto de collects de onde determinar o valor + * @return O valor bind */ public byte[] getBindValue(HashSet collects) { @@ -588,7 +583,7 @@ public class LCManager { /** * Fetchs a set of correctly signed and normalized collect data structures from the * specified original set of collects - * @param collects original set of collects + * @param signedObjects original set of signed collects * @param eid the eid to which to normalize the collects * @return a set of correctly signed and normalized collect data structures */