upload_spooler_definition.h

Go to the documentation of this file.

#ifndef CVMFS_UPLOAD_SPOOLER_DEFINITION_H_
#define CVMFS_UPLOAD_SPOOLER_DEFINITION_H_

#include <string>

#include "compression/compression.h"
#include "crypto/hash.h"

namespace upload {

struct SpoolerDefinition {
  static const unsigned kDefaultMaxConcurrentUploads = 512;
  static const unsigned kDefaultNumUploadTasks = 1;
  static const char *kDriverNames[];  
  enum DriverType {
    S3,
    Local,
    Gateway,
    Mock,
    Unknown
  };

  SpoolerDefinition(
      const std::string &definition_string,
      const shash::Algorithms hash_algorithm,
      const zlib::Algorithms compression_algorithm = zlib::kZlibDefault,
      const bool generate_legacy_bulk_chunks = false,
      const bool use_file_chunking = false,
      const size_t min_file_chunk_size = 0,
      const size_t avg_file_chunk_size = 0,
      const size_t max_file_chunk_size = 0,
      const std::string &session_token_file = "",
      const std::string &key_file = "");

  bool IsValid() const { return valid_; }

  SpoolerDefinition Dup2DefaultCompression() const;

  DriverType driver_type;      
  std::string temporary_path;  

  std::string spooler_configuration;

  shash::Algorithms hash_algorithm;
  zlib::Algorithms compression_alg;
  bool generate_legacy_bulk_chunks;
  bool use_file_chunking;
  size_t min_file_chunk_size;
  size_t avg_file_chunk_size;
  size_t max_file_chunk_size;

  unsigned int number_of_concurrent_uploads;

  unsigned int num_upload_tasks;

  // The session_token_file parameter is only used for the HTTP driver
  std::string session_token_file;
  std::string key_file;

  bool valid_;
};

}  // namespace upload

#endif  // CVMFS_UPLOAD_SPOOLER_DEFINITION_H_