commit f72c054ce638810897130943a8a2defeb47f594e
author Zhiyi Zhang <zhiyi@cs.ucla.edu> Thu Mar 16 14:45:30 2017 -0700
committer Zhiyi Zhang <zhiyi@cs.ucla.edu> Thu Mar 16 14:45:30 2017 -0700
tree 69f5d73db58251ab721d6c35a1848b95a41ab7ae
parent 23564c854d96abdaec056b8ed71f88f000e74819

Remove genChallengeInfo and add genSelectParamsJson and genValidateParamsJson

Change-Id: Ic389fcaf52a713ff5b0fefe7025a5630d7b0f7cc

src/challenge-module.hpp

diff --git a/src/challenge-module.hpp b/src/challenge-module.hpp
index 1cc22ad..7e36d4c 100644
--- a/src/challenge-module.hpp
+++ b/src/challenge-module.hpp
@@ -58,6 +58,7 @@
   static unique_ptr<ChallengeModule>
   createChallengeModule(const std::string& ChallengeType);
 
+  // For CA
   /**
    * @brief Handle the challenge related interest and update certificate request.
    * @note Should be used by CA Module
@@ -73,6 +74,7 @@
   JsonSection
   handleChallengeRequest(const Interest& interest, CertificateRequest& request);
 
+  // For Client
   /**
    * @brief Get requirements for requester before sending SELECT interest.
    * @note Should be used by Client Module
@@ -105,28 +107,45 @@
   getRequirementForValidate(const std::string& status);
 
   /**
-   * @brief Generate ChallengeInfo part for SELECT and VALIDATE interest.
+   * @brief Generate ChallengeInfo part for SELECT interest.
    * @note Should be used by Client Module
    *
    * After requester provides required information, client should invoke the function to
    * generate the ChallengeInfo part of the interest.
    *
-   * @param interestType of the request
    * @param status of the challenge
    * @param paramList contains all the input from requester
    * @return the JSON file of ChallengeInfo
    */
   JsonSection
-  genRequestChallengeInfo(const std::string& interestType, const std::string& status,
-                          const std::list<std::string>& paramList);
+  genSelectParamsJson(const std::string& status, const std::list<std::string>& paramList);
+
+  /**
+   * @brief Generate ChallengeInfo part for VALIDATE interest.
+   * @note Should be used by Client Module
+   *
+   * After requester provides required information, client should invoke the function to
+   * generate the ChallengeInfo part of the interest.
+   *
+   * @param status of the challenge
+   * @param paramList contains all the input from requester
+   * @return the JSON file of ChallengeInfo
+   */
+  JsonSection
+  genValidateParamsJson(const std::string& status, const std::list<std::string>& paramList);
 
 PUBLIC_WITH_TESTS_ELSE_PROTECTED:
+  // For CA
   virtual JsonSection
   processSelectInterest(const Interest& interest, CertificateRequest& request) = 0;
 
   virtual JsonSection
   processValidateInterest(const Interest& interest, CertificateRequest& request) = 0;
 
+  virtual JsonSection
+  processStatusInterest(const Interest& interest, const CertificateRequest& request);
+
+  // For Client
   virtual std::list<std::string>
   getSelectRequirements() = 0;
 
@@ -134,12 +153,12 @@
   getValidateRequirements(const std::string& status) = 0;
 
   virtual JsonSection
-  genChallengeInfo(const std::string& interestType, const std::string& status,
-                   const std::list<std::string>& paramList) = 0;
+  doGenSelectParamsJson(const std::string& status, const std::list<std::string>& paramList) = 0;
 
   virtual JsonSection
-  processStatusInterest(const Interest& interest, const CertificateRequest& request);
+  doGenValidateParamsJson(const std::string& status, const std::list<std::string>& paramList) = 0;
 
+  // Helpers
   static JsonSection
   getJsonFromNameComponent(const Name& name, int pos);