baseclient.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. // MinIO C++ Library for Amazon S3 Compatible Cloud Storage
  2. // Copyright 2022 MinIO, Inc.
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. //
  8. // http://www.apache.org/licenses/LICENSE-2.0
  9. //
  10. // Unless required by applicable law or agreed to in writing, software
  11. // distributed under the License is distributed on an "AS IS" BASIS,
  12. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. // See the License for the specific language governing permissions and
  14. // limitations under the License.
  15. #ifndef _MINIO_S3_BASE_CLIENT_H
  16. #define _MINIO_S3_BASE_CLIENT_H
  17. #include "args.h"
  18. #include "config.h"
  19. #include "request.h"
  20. #include "response.h"
  21. #include "select.h"
  22. namespace minio {
  23. namespace s3 {
  24. utils::Multimap GetCommonListObjectsQueryParams(std::string& delimiter,
  25. std::string& encoding_type,
  26. unsigned int max_keys,
  27. std::string& prefix);
  28. /**
  29. * Base client to perform S3 APIs.
  30. */
  31. class BaseClient {
  32. protected:
  33. BaseUrl& base_url_;
  34. creds::Provider* provider_ = NULL;
  35. std::map<std::string, std::string> region_map_;
  36. bool debug_ = false;
  37. bool ignore_cert_check_ = false;
  38. std::string ssl_cert_file_;
  39. std::string user_agent_ = DEFAULT_USER_AGENT;
  40. public:
  41. BaseClient(BaseUrl& base_url, creds::Provider* provider = NULL);
  42. void Debug(bool flag) { debug_ = flag; }
  43. void IgnoreCertCheck(bool flag) { ignore_cert_check_ = flag; }
  44. void SetSslCertFile(std::string ssl_cert_file) {
  45. ssl_cert_file_ = ssl_cert_file;
  46. }
  47. error::Error SetAppInfo(std::string_view app_name,
  48. std::string_view app_version);
  49. void HandleRedirectResponse(std::string& code, std::string& message,
  50. int status_code, http::Method method,
  51. utils::Multimap headers, std::string& bucket_name,
  52. bool retry = false);
  53. Response GetErrorResponse(http::Response resp, std::string_view resource,
  54. http::Method method, std::string& bucket_name,
  55. std::string& object_name);
  56. Response execute(Request& req);
  57. Response Execute(Request& req);
  58. GetRegionResponse GetRegion(std::string& bucket_name, std::string& region);
  59. AbortMultipartUploadResponse AbortMultipartUpload(
  60. AbortMultipartUploadArgs args);
  61. BucketExistsResponse BucketExists(BucketExistsArgs args);
  62. CompleteMultipartUploadResponse CompleteMultipartUpload(
  63. CompleteMultipartUploadArgs args);
  64. CreateMultipartUploadResponse CreateMultipartUpload(
  65. CreateMultipartUploadArgs args);
  66. DeleteBucketEncryptionResponse DeleteBucketEncryption(
  67. DeleteBucketEncryptionArgs args);
  68. DisableObjectLegalHoldResponse DisableObjectLegalHold(
  69. DisableObjectLegalHoldArgs args);
  70. DeleteBucketLifecycleResponse DeleteBucketLifecycle(
  71. DeleteBucketLifecycleArgs args);
  72. DeleteBucketNotificationResponse DeleteBucketNotification(
  73. DeleteBucketNotificationArgs args);
  74. DeleteBucketPolicyResponse DeleteBucketPolicy(DeleteBucketPolicyArgs args);
  75. DeleteBucketReplicationResponse DeleteBucketReplication(
  76. DeleteBucketReplicationArgs args);
  77. DeleteBucketTagsResponse DeleteBucketTags(DeleteBucketTagsArgs args);
  78. DeleteObjectLockConfigResponse DeleteObjectLockConfig(
  79. DeleteObjectLockConfigArgs args);
  80. DeleteObjectTagsResponse DeleteObjectTags(DeleteObjectTagsArgs args);
  81. EnableObjectLegalHoldResponse EnableObjectLegalHold(
  82. EnableObjectLegalHoldArgs args);
  83. GetBucketEncryptionResponse GetBucketEncryption(GetBucketEncryptionArgs args);
  84. GetBucketLifecycleResponse GetBucketLifecycle(GetBucketLifecycleArgs args);
  85. GetBucketNotificationResponse GetBucketNotification(
  86. GetBucketNotificationArgs args);
  87. GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyArgs args);
  88. GetBucketReplicationResponse GetBucketReplication(
  89. GetBucketReplicationArgs args);
  90. GetBucketTagsResponse GetBucketTags(GetBucketTagsArgs args);
  91. GetBucketVersioningResponse GetBucketVersioning(GetBucketVersioningArgs args);
  92. GetObjectResponse GetObject(GetObjectArgs args);
  93. GetObjectLockConfigResponse GetObjectLockConfig(GetObjectLockConfigArgs args);
  94. GetObjectRetentionResponse GetObjectRetention(GetObjectRetentionArgs args);
  95. GetObjectTagsResponse GetObjectTags(GetObjectTagsArgs args);
  96. GetPresignedObjectUrlResponse GetPresignedObjectUrl(
  97. GetPresignedObjectUrlArgs args);
  98. GetPresignedPostFormDataResponse GetPresignedPostFormData(PostPolicy policy);
  99. IsObjectLegalHoldEnabledResponse IsObjectLegalHoldEnabled(
  100. IsObjectLegalHoldEnabledArgs args);
  101. ListBucketsResponse ListBuckets(ListBucketsArgs args);
  102. ListBucketsResponse ListBuckets();
  103. ListenBucketNotificationResponse ListenBucketNotification(
  104. ListenBucketNotificationArgs args);
  105. ListObjectsResponse ListObjectsV1(ListObjectsV1Args args);
  106. ListObjectsResponse ListObjectsV2(ListObjectsV2Args args);
  107. ListObjectsResponse ListObjectVersions(ListObjectVersionsArgs args);
  108. MakeBucketResponse MakeBucket(MakeBucketArgs args);
  109. PutObjectResponse PutObject(PutObjectApiArgs args);
  110. RemoveBucketResponse RemoveBucket(RemoveBucketArgs args);
  111. RemoveObjectResponse RemoveObject(RemoveObjectArgs args);
  112. RemoveObjectsResponse RemoveObjects(RemoveObjectsApiArgs args);
  113. SetBucketEncryptionResponse SetBucketEncryption(SetBucketEncryptionArgs args);
  114. SetBucketLifecycleResponse SetBucketLifecycle(SetBucketLifecycleArgs args);
  115. SetBucketNotificationResponse SetBucketNotification(
  116. SetBucketNotificationArgs args);
  117. SetBucketPolicyResponse SetBucketPolicy(SetBucketPolicyArgs args);
  118. SetBucketReplicationResponse SetBucketReplication(
  119. SetBucketReplicationArgs args);
  120. SetBucketTagsResponse SetBucketTags(SetBucketTagsArgs args);
  121. SetBucketVersioningResponse SetBucketVersioning(SetBucketVersioningArgs args);
  122. SetObjectLockConfigResponse SetObjectLockConfig(SetObjectLockConfigArgs args);
  123. SetObjectRetentionResponse SetObjectRetention(SetObjectRetentionArgs args);
  124. SetObjectTagsResponse SetObjectTags(SetObjectTagsArgs args);
  125. SelectObjectContentResponse SelectObjectContent(SelectObjectContentArgs args);
  126. StatObjectResponse StatObject(StatObjectArgs args);
  127. UploadPartResponse UploadPart(UploadPartArgs args);
  128. UploadPartCopyResponse UploadPartCopy(UploadPartCopyArgs args);
  129. }; // class BaseClient
  130. } // namespace s3
  131. } // namespace minio
  132. #endif // #ifndef __MINIO_S3_BASE_CLIENT_H