Mercurial > hg > orthanc-object-storage
changeset 94:1bc055199cd2
Added a description for all plugins
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 19 Dec 2022 09:52:58 +0100 |
| parents | 9b2a76fe987a |
| children | 33790e0000bb |
| files | Aws/AwsS3StoragePlugin.cpp Aws/AwsS3StoragePlugin.h Azure/AzureBlobStoragePlugin.cpp Azure/AzureBlobStoragePlugin.h Common/StoragePlugin.cpp Google/GoogleStoragePlugin.cpp Google/GoogleStoragePlugin.h NEWS |
| diffstat | 8 files changed, 25 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/Aws/AwsS3StoragePlugin.cpp Fri Dec 16 14:55:14 2022 +0100 +++ b/Aws/AwsS3StoragePlugin.cpp Mon Dec 19 09:52:58 2022 +0100 @@ -253,6 +253,10 @@ return "AWS S3 Storage"; } +const char* AwsS3StoragePluginFactory::GetStorageDescription() +{ + return "Stores the Orthanc storage area in AWS S3"; +} static std::unique_ptr<Aws::Crt::ApiHandle> api_; static std::unique_ptr<Aws::SDKOptions> sdkOptions_;
--- a/Aws/AwsS3StoragePlugin.h Fri Dec 16 14:55:14 2022 +0100 +++ b/Aws/AwsS3StoragePlugin.h Mon Dec 19 09:52:58 2022 +0100 @@ -24,6 +24,7 @@ { public: static const char* GetStoragePluginName(); + static const char* GetStorageDescription(); static IStorage* CreateStorage(const std::string& nameForLogs, const OrthancPlugins::OrthancConfiguration& orthancConfig); static const char* GetConfigurationSectionName() {return "AwsS3Storage";} };
--- a/Azure/AzureBlobStoragePlugin.cpp Fri Dec 16 14:55:14 2022 +0100 +++ b/Azure/AzureBlobStoragePlugin.cpp Mon Dec 19 09:52:58 2022 +0100 @@ -174,6 +174,12 @@ return "Azure Blob Storage"; } +const char* AzureBlobStoragePluginFactory::GetStorageDescription() +{ + return "Stores the Orthanc storage area in Azure Blob"; +} + + bool IsSasTokenAccountLevel(utility::string_t sasToken) { // Use cpprestsdk's utility::string_t here since the expected argument is the return value of
--- a/Azure/AzureBlobStoragePlugin.h Fri Dec 16 14:55:14 2022 +0100 +++ b/Azure/AzureBlobStoragePlugin.h Mon Dec 19 09:52:58 2022 +0100 @@ -25,6 +25,7 @@ { public: static const char* GetStoragePluginName(); + static const char* GetStorageDescription(); static IStorage* CreateStorage(const std::string& nameForLogs, const OrthancPlugins::OrthancConfiguration& orthancConfig); static const char* GetConfigurationSectionName() {return "AzureBlobStorage";} };
--- a/Common/StoragePlugin.cpp Fri Dec 16 14:55:14 2022 +0100 +++ b/Common/StoragePlugin.cpp Mon Dec 19 09:52:58 2022 +0100 @@ -527,6 +527,7 @@ OrthancPlugins::OrthancConfiguration orthancConfig; OrthancPlugins::LogWarning(std::string(StoragePluginFactory::GetStoragePluginName()) + " plugin is initializing"); + OrthancPluginSetDescription(context, StoragePluginFactory::GetStorageDescription()); /* Check the version of the Orthanc core */ if (OrthancPluginCheckVersion(context) == 0)
--- a/Google/GoogleStoragePlugin.cpp Fri Dec 16 14:55:14 2022 +0100 +++ b/Google/GoogleStoragePlugin.cpp Mon Dec 19 09:52:58 2022 +0100 @@ -233,6 +233,11 @@ return "Google Cloud Storage"; } +const char* GoogleStoragePluginFactory::GetStorageDescription() +{ + return "Stores the Orthanc storage area in Google Cloud"; +} + IStorage* GoogleStoragePluginFactory::CreateStorage(const std::string& nameForLogs, const OrthancPlugins::OrthancConfiguration& orthancConfig) { bool enableLegacyStorageStructure;
--- a/Google/GoogleStoragePlugin.h Fri Dec 16 14:55:14 2022 +0100 +++ b/Google/GoogleStoragePlugin.h Mon Dec 19 09:52:58 2022 +0100 @@ -27,6 +27,7 @@ { public: static const char* GetStoragePluginName(); + static const char* GetStorageDescription(); static IStorage* CreateStorage(const std::string& nameForLogs, const OrthancPlugins::OrthancConfiguration& orthancConfig); static const char* GetConfigurationSectionName() {return "GoogleCloudStorage";} };