GDAL
cpl_azure.h
1 /**********************************************************************
2  * Project: CPL - Common Portability Library
3  * Purpose: Microsoft Azure Storage Blob routines
4  * Author: Even Rouault <even.rouault at spatialys.com>
5  *
6  **********************************************************************
7  * Copyright (c) 2017, Even Rouault <even.rouault at spatialys.com>
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included
17  * in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  * DEALINGS IN THE SOFTWARE.
26  ****************************************************************************/
27 
28 #ifndef CPL_AZURE_INCLUDED_H
29 #define CPL_AZURE_INCLUDED_H
30 
31 #ifndef DOXYGEN_SKIP
32 
33 #ifdef HAVE_CURL
34 
35 #include <curl/curl.h>
36 #include "cpl_http.h"
37 #include "cpl_aws.h"
38 #include <map>
39 
40 class VSIAzureBlobHandleHelper final: public IVSIS3LikeHandleHelper
41 {
42  CPLString m_osURL;
43  CPLString m_osEndpoint;
44  CPLString m_osBlobEndpoint;
45  CPLString m_osBucket;
46  CPLString m_osObjectKey;
47  CPLString m_osStorageAccount;
48  CPLString m_osStorageKey;
49  bool m_bUseHTTPS;
50 
51  static bool GetConfiguration(CSLConstList papszOptions,
52  bool& bUseHTTPS,
53  CPLString& osEndpoint,
54  CPLString& osBlobEndpoint,
55  CPLString& osStorageAccount,
56  CPLString& osStorageKey);
57 
58  static CPLString BuildURL(const CPLString& osEndpoint,
59  const CPLString& osBlobEndpoint,
60  const CPLString& osStorageAccount,
61  const CPLString& osBucket,
62  const CPLString& osObjectKey,
63  bool bUseHTTPS);
64 
65  void RebuildURL() override;
66 
67  public:
68  VSIAzureBlobHandleHelper(const CPLString& osEndpoint,
69  const CPLString& osBlobEndpoint,
70  const CPLString& osBucket,
71  const CPLString& osObjectKey,
72  const CPLString& osStorageAccount,
73  const CPLString& osStorageKey,
74  bool bUseHTTPS);
75  ~VSIAzureBlobHandleHelper();
76 
77  static VSIAzureBlobHandleHelper* BuildFromURI(const char* pszURI,
78  const char* pszFSPrefix,
79  CSLConstList papszOptions = nullptr);
80 
81  struct curl_slist* GetCurlHeaders(const CPLString& osVerbosVerb,
82  const struct curl_slist* psExistingHeaders,
83  const void *pabyDataContent = nullptr,
84  size_t nBytesContent = 0) const override;
85 
86  const CPLString& GetURL() const override { return m_osURL; }
87 
88  CPLString GetSignedURL(CSLConstList papszOptions);
89 };
90 
91 
92 #endif /* HAVE_CURL */
93 
94 #endif /* #ifndef DOXYGEN_SKIP */
95 
96 #endif /* CPL_AZURE_INCLUDED_H */
Convenient string class based on std::string.
Definition: cpl_string.h:329
Interface for downloading HTTP, FTP documents.
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1186

Generated for GDAL by doxygen 1.8.8.