ICat4Catalog.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/ICatalog.h"
#include "MantidAPI/ICatalogInfoService.h"
#include "MantidAPI/TableRow.h"
#include "MantidICat/CatalogSearchParam.h"
#include "MantidICat/ICat4/GSoapGenerated/ICat4ICATPortBindingProxy.h"
 
namespace Mantid {
namespace ICat {
class ICat4Catalog : public Mantid::API::ICatalog, public Mantid::API::ICatalogInfoService {
public:
  ICat4Catalog();
  API::CatalogSession_sptr login(const std::string &username, const std::string &password, const std::string &endpoint,
                                 const std::string &facility) override;
  void logout() override;
  void search(const CatalogSearchParam &inputs, Mantid::API::ITableWorkspace_sptr &outputws, const int &offset,
              const int &limit) override;
  int64_t getNumberOfSearchResults(const CatalogSearchParam &inputs) override;
  void myData(Mantid::API::ITableWorkspace_sptr &outputws) override;
  void getDataSets(const std::string &investigationId, Mantid::API::ITableWorkspace_sptr &outputws) override;
  void getDataFiles(const std::string &investigationId, Mantid::API::ITableWorkspace_sptr &outputws) override;
  void listInstruments(std::vector<std::string> &instruments) override;
  void listInvestigationTypes(std::vector<std::string> &invstTypes) override;
  const std::string getFileLocation(const long long &fileID) override;
  const std::string getDownloadURL(const long long &fileID) override;
  const std::string getUploadURL(const std::string &investigationID, const std::string &createFileName,
                                 const std::string &dataFileDescription) override;
  API::ITableWorkspace_sptr getPublishInvestigations() override;
  void keepAlive() override;
 
private:
  // Ensures human friendly error messages are provided to the user.
  void throwErrorMessage(ICat4::ICATPortBindingProxy &icat);
  // Defines the SSL authentication scheme.
  void setSSLContext(ICat4::ICATPortBindingProxy &icat);
  // Saves "MyData" query result to output workspace.
  void saveInvestigations(std::vector<ICat4::xsd__anyType *> response, API::ITableWorkspace_sptr &outputws);
  // Creates a search query string based on inputs provided by the user.
  std::string buildSearchQuery(const CatalogSearchParam &inputs);
  // Saves "DataFiles" result to output workspace.
  void saveDataFiles(std::vector<ICat4::xsd__anyType *> response, API::ITableWorkspace_sptr &outputws);
  // Saves "DataSets" information to the output workspace.
  void saveDataSets(const std::vector<ICat4::xsd__anyType *> &response, API::ITableWorkspace_sptr &outputws);
  // Convert a file size to human readable file format.
  std::string bytesToString(int64_t &fileSize);
  // Helper method that formats a given timestamp.
  std::string formatDateTime(const time_t &timestamp, const std::string &format);
  // Search the archive & obtain the dataset ID based on the investigationID.
  int64_t getMantidDatasetId(const std::string &investigationID);
  // Creates a dataset for an investigation (based on ID) named 'mantid' if it
  // does not already exist.
  int64_t createMantidDataset(const std::string &investigationID);
  // Sets the soap-endpoint & SSL context for the given ICAT proxy.
  void setICATProxySettings(ICat4::ICATPortBindingProxy &icat);
  // Returns the results of a search against ICAT for a given query.
  std::vector<ICat4::xsd__anyType *> performSearch(ICat4::ICATPortBindingProxy &icat, std::string query);
 
  // Is the desired accessType allowed for a specific bean?
  template <class T> bool isAccessAllowed(ICat4::ns1__accessType accessType, T &bean);
 
  // Stores the session details for a specific catalog.
  API::CatalogSession_sptr m_session;
 
  template <class T> void savetoTableWorkspace(T *input, Mantid::API::TableRow &table) {
    if (input) {
      table << *input;
    } else {
      table << "";
    }
  }
};
} // namespace ICat
} // namespace Mantid