[Folderwatcher] Add Azure blob storage containers monitoring support by goopilot · Pull Request #14926 · openhab/openhab-addons

goopilot · 2023-05-02T21:13:37Z

Signed-off-by: Alexandr Salamatov goopilot@gmail.com

Added support for monitoring of Azure blob storage containers

goopilot · 2023-05-02T21:26:16Z

...folderwatcher/src/main/java/org/openhab/binding/folderwatcher/internal/api/AzureActions.java

+        DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
+        // This returns extra character before <xml. Need to find out why
+        String sResponse = contentResponse.getContentAsString();
+        InputSource is = new InputSource(new StringReader(sResponse.substring(sResponse.indexOf("<"))));


I'm doing this, but I don't like it.
The reason why I'm doing this that Azure in the HTTP response has some additional character before <?xml statement. So the DOM parser fails.

Wireshark also shows it:

Did anybody experience that and if yes, what is the best solution?

@wborn did you experience similar issue with Azure?

Not really, maybe it's a BOM?

https://en.m.wikipedia.org/wiki/Byte_order_mark

lolodomo · 2024-05-25T12:50:39Z

I added the tag "work in progress" as "WIP" is still in the PR title.
Let us know when this is no more "work in progress".

lsiepel · 2024-09-29T18:27:20Z

Gentle ping @goopilot after 1.5 years without visible progress i wonder if you need any support and if we can bring this PR to the finish line.

goopilot · 2024-09-30T02:40:52Z

Gentle ping @goopilot after 1.5 years without visible progress i wonder if you need any support and if we can bring this PR to the finish line.

Thanks for reminding me, I'll work on it this month

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot · 2025-01-10T17:15:49Z

@lsiepel could you have a look at it? I'm done with it.

lsiepel · 2025-01-10T23:55:01Z

@lsiepel could you have a look at it? I'm done with it.

Currently away, will try to look at it in the next week

lsiepel

Thanks for adding Azure blob. Overall looks good, but do have some comments. Please also update the readme documentation.

lsiepel · 2025-02-19T12:02:34Z

...folderwatcher/src/main/java/org/openhab/binding/folderwatcher/internal/api/AzureActions.java

+
+    public List<String> listBlob(String prefix, Map<String, String> headers, Map<String, String> params)
+            throws Exception {
+


Suggested change

...folderwatcher/src/main/java/org/openhab/binding/folderwatcher/internal/api/AzureActions.java

...atcher/src/main/java/org/openhab/binding/folderwatcher/internal/api/auth/AWS4SignerBase.java

lsiepel · 2025-02-19T12:09:01Z

...rc/main/java/org/openhab/binding/folderwatcher/internal/handler/AzureBlobWatcherHandler.java

+        }
+
+        try {
+            previousBlobListing = WatcherCommon.initStorage(currentBlobListingFile,


This method needs to return fast and it looks like this initStorage is blocking. If so it should run in a async thread.

@lsiepel The idea was that if storage (in this case it's a file) can't be created, then thing should fail initialization phase. But if I run it in the thread, then thing will be initiated before storage is created. Would you suggest to do storage init in a different function?

Both can still be achieved. A common procedure is like this:

Validat the configuration

set the thing state to unknown

Start an scheduledtask that initilizes/authenticates etc the connection, form within that task:

Set the thing state accordingly

Schedule the refreshAzureBlobInformation task if all is ok.

this way the initialize method exits fast, sets the thing to unknonw and whenever the authentication finishes, the thing state is set to online/offline etc.

@lsiepel Thanks, I pushed changes, please have a look

lsiepel · 2025-02-19T12:09:26Z

...rc/main/java/org/openhab/binding/folderwatcher/internal/handler/AzureBlobWatcherHandler.java

+
+        if (refreshAzureBlobInformation()) {
+            if (config.pollIntervalAzure > 0) {
+                executionJob = scheduler.scheduleWithFixedDelay(this::refreshAzureBlobInformation,


Set the thing state to unknown just before you start the scheduled task.

This will be changed as part of the above comment (async init)

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot · 2025-03-21T17:44:47Z

@lsiepel could you have a look at it?

lsiepel · 2025-03-22T21:36:26Z

...rc/main/java/org/openhab/binding/folderwatcher/internal/handler/AzureBlobWatcherHandler.java

+
+        if (config.azureAnonymous) {
+            azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName);
+        } else {
+            azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName,
+                    config.azureAccessKey);
+        }
+        updateStatus(ThingStatus.UNKNOWN);
+        if (config.pollIntervalAzure > 0) {
+            executionJob = scheduler.scheduleWithFixedDelay(this::refreshAzureBlobInformation, 0,
+                    config.pollIntervalAzure, TimeUnit.SECONDS);
+        } else {
+            updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
+                    "Polling interval must be greater then 0 seconds");
+            return;
+        }


Improved implementation (might need spotless, as i wrote it here in github)

Suggested change

if (config.azureAnonymous) {

azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName);

} else {

azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName,

config.azureAccessKey);

}

updateStatus(ThingStatus.UNKNOWN);

if (config.pollIntervalAzure > 0) {

executionJob = scheduler.scheduleWithFixedDelay(this::refreshAzureBlobInformation, 0,

config.pollIntervalAzure, TimeUnit.SECONDS);

} else {

updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,

"Polling interval must be greater then 0 seconds");

return;

}

if (config.azureAccountName.isBlank() || config.azureContainerName.isBlank()) {

updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,

"Account name or container configuration is invalid");

return;

} else if (config.pollIntervalAzure == 0) {

updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,

"Polling interval must be greater then 0 seconds");

return;

}

if (config.azureAnonymous) {

azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName);

} else {

azure = new AzureActions(httpClientFactory, config.azureAccountName, config.azureContainerName,

config.azureAccessKey);

}

updateStatus(ThingStatus.UNKNOWN);

executionJob = scheduler.scheduleWithFixedDelay(this::refreshAzureBlobInformation, 0,

config.pollIntervalAzure, TimeUnit.SECONDS);

lsiepel

One minor thing is left to fix. Rewrite the init method so that it better checks the configuration. Otherwise LGTM

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot · 2025-04-23T22:59:48Z

@lsiepel omg, for some reason I was sure I did it a long time ago. Can you have a look now?

lsiepel

Thanks, LGTM

…penhab#14926) * Add Azure Thing Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot commented May 2, 2023

View reviewed changes

lolodomo added work in progress A PR that is not yet ready to be merged enhancement An enhancement or new feature for an existing add-on labels May 25, 2024

lsiepel added the awaiting feedback Awaiting feedback from the pull request author label Oct 26, 2024

goopilot force-pushed the azure branch 2 times, most recently from d1615d5 to 0f5d9d5 Compare January 10, 2025 16:42

Add Azure Thing

1a84167

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot force-pushed the azure branch from 0f5d9d5 to 1a84167 Compare January 10, 2025 17:05

lsiepel removed the awaiting feedback Awaiting feedback from the pull request author label Jan 10, 2025

lsiepel requested changes Feb 19, 2025

View reviewed changes

lsiepel removed the work in progress A PR that is not yet ready to be merged label Feb 19, 2025

lsiepel changed the title ~~[Folderwatcher] [WIP] Azure blob storage containers monitoring support~~ [Folderwatcher] Add Azure blob storage containers monitoring support Feb 19, 2025

Merge branch 'openhab:main' into azure

199c17b

goopilot force-pushed the azure branch 2 times, most recently from 3f76708 to 92a2d32 Compare February 26, 2025 02:54

code review adjustments

73c28c0

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

goopilot force-pushed the azure branch from 92a2d32 to 73c28c0 Compare February 26, 2025 02:57

lsiepel reviewed Mar 22, 2025

View reviewed changes

lsiepel requested changes Mar 22, 2025

View reviewed changes

Improved implementation

63cdb33

Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>

lsiepel approved these changes Apr 24, 2025

View reviewed changes

lsiepel merged commit c445d15 into openhab:main Apr 24, 2025
2 checks passed

lsiepel added this to the 5.0 milestone Apr 24, 2025

phenix1990 pushed a commit to phenix1990/openhab-addons that referenced this pull request Jul 31, 2025

[Folderwatcher] Add Azure blob storage containers monitoring support (o…

be16efc

…penhab#14926) * Add Azure Thing Signed-off-by: Alexandr Salamatov <goopilot@gmail.com>


		public List<String> listBlob(String prefix, Map<String, String> headers, Map<String, String> params)
		throws Exception {

Uh oh!

Comments

Conversation

goopilot commented May 2, 2023

Uh oh!

goopilot May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lolodomo commented May 25, 2024

Uh oh!

lsiepel commented Sep 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

goopilot commented Sep 30, 2024

Uh oh!

goopilot commented Jan 10, 2025

Uh oh!

lsiepel commented Jan 10, 2025

Uh oh!

lsiepel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lsiepel Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goopilot commented Mar 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lsiepel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goopilot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lsiepel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

goopilot May 2, 2023 •

edited

Loading

lsiepel commented Sep 29, 2024 •

edited

Loading

lsiepel Feb 21, 2025 •

edited

Loading

lsiepel left a comment •

edited

Loading

goopilot commented Apr 23, 2025 •

edited

Loading