Added dataFileDescription to getUploadURL. Refs #8742.

- Added implementation to icat4catalog's getUploadURL.
mantidproject · Jan 23, 2014 · e9940ca · e9940ca
1 parent 1fe04cb
commit e9940ca
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/ICatalog.h b/Code/Mantid/Framework/API/inc/MantidAPI/ICatalog.h
@@ -68,7 +68,7 @@ class DLLExport ICatalog
   /// get URLs of the files
   virtual void getDownloadURL(const long long& fileid,std::string&)=0;
   /// get URL of where to PUT (publish) files.
-  virtual const std::string getUploadURL(const std::string &, const std::string &)=0;
+  virtual const std::string getUploadURL(const std::string&,const std::string&,const std::string&)=0;
   /// keep alive
   virtual void keepAlive()=0;
   ///keep alive in minutes

diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Catalog.h b/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Catalog.h
@@ -65,7 +65,8 @@ namespace Mantid
       /// get urls
       virtual void getDownloadURL(const long long& fileid,std::string & fileLocation);
       /// get URL of where to PUT (publish) files.
-      virtual const std::string getUploadURL(const std::string &investigationID, const std::string &createFileName);
+      virtual const std::string getUploadURL(
+          const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription);
       /// keep alive
       virtual void keepAlive();
       /// keep alive in minutes

diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/ICat4/ICat4Catalog.h b/Code/Mantid/Framework/ICat/inc/MantidICat/ICat4/ICat4Catalog.h
@@ -65,7 +65,8 @@ namespace Mantid
         /// Get the url(s) based on the fileID.
         virtual void getDownloadURL(const long long& fileID,std::string & url);
         /// get URL of where to PUT (publish) files.
-        virtual const std::string getUploadURL(const std::string &investigationID, const std::string &createFileName);
+        virtual const std::string getUploadURL(
+            const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription);
         /// Keep current session alive
         virtual void keepAlive();
         /// Keep alive in minutes

diff --git a/Code/Mantid/Framework/ICat/src/ICat3/ICat3Catalog.cpp b/Code/Mantid/Framework/ICat/src/ICat3/ICat3Catalog.cpp
@@ -103,10 +103,12 @@ namespace Mantid
      * @param createFileName  :: The name to give to the file being saved.
      * @return URL to PUT datafiles to.
      */
-    const std::string ICat3Catalog::getUploadURL(const std::string &investigationID, const std::string &createFileName)
+    const std::string ICat3Catalog::getUploadURL(
+        const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription)
     {
       UNUSED_ARG(investigationID);
       UNUSED_ARG(createFileName);
+      UNUSED_ARG(dataFileDescription);
       throw std::runtime_error("ICat3Catalog does not support publishing.");
     }
 

diff --git a/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp b/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp
@@ -738,7 +738,8 @@ namespace Mantid
      * @param createFileName  :: The name to give to the file being saved.
      * @return URL to PUT datafiles to.
      */
-    const std::string ICat4Catalog::getUploadURL(const std::string &investigationID, const std::string &createFileName)
+    const std::string ICat4Catalog::getUploadURL(
+        const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription)
     {
       // Obtain the URL from the Facilities.xml file.
       std::string url = ConfigService::Instance().getFacility().catalogInfo().externalDownloadURL();
@@ -749,9 +750,10 @@ namespace Mantid
       if (sessionID.empty()) throw std::runtime_error("You are not currently logged into the cataloging system.");
       std::string name      = "&name="      + createFileName;
       std::string datasetId = "&datasetId=" + boost::lexical_cast<std::string>(getDatasetId(investigationID));
+      std::string description = "&description=" + dataFileDescription;
 
       // Add pieces of URL together.
-      url += ("put?" + session + name + datasetId + "&datafileFormatId=1");
+      url += ("put?" + session + name + datasetId + description + "&datafileFormatId=1");
       g_log.debug() << "ICat4Catalog::getUploadURL url is: " << url << std::endl;
       return url;
     }