Skip to content

Add Azure Storage Files connector and trigger samples - #159

Merged
niveathika merged 1 commit into
wso2:mainfrom
YasanPunch:docs/azure-files-samples
Aug 20, 2026
Merged

Add Azure Storage Files connector and trigger samples#159
niveathika merged 1 commit into
wso2:mainfrom
YasanPunch:docs/azure-files-samples

Conversation

@YasanPunch

@YasanPunch YasanPunch commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Purpose

The ballerinax/azure.storage.files connector and its file listener have no usage samples in the connector catalog under integrator-default-profile/connectors/. This PR adds them so the Azure Files connector and trigger are represented alongside the other connector samples.

Goals

Provide two minimal, self-contained samples that show the two ways the Azure Files connector is used:

  • Connector (client) sample — authenticate against a file share and perform a file operation.
  • Trigger (listener) sample — react to files appearing on a share.

Approach

Two new packages, both following the existing connector-sample conventions in this repo (same file skeleton, org = "wso2", distribution = "2201.13.1", [build-options] sticky = true, kebab-case title):

integrator-default-profile/connectors/azure.storage.files_connector_sample

  • config.balaccountName, accountKey, shareName as configurable values.
  • connections.bal — a final files:Client built from those values.
  • automation.bal — uploads a local file to /reports/q1-report.pdf and verifies it exists via hasFile, with on fail error logging.

integrator-default-profile/connectors/azure.storage.files_trigger_sample

  • config.bal — the same three configurable values.
  • main.bal — a files:Listener on the share (5s polling) with a service /incoming whose onFileJson remote function logs the payload; @files:FunctionConfig deletes the file after successful processing and moves it to /failed on error.

No credentials are committed — all auth values are configurable, and Config.toml is gitignored.

User stories

As a developer evaluating WSO2 Integrator, I want a runnable reference for the Azure Files connector and trigger so I can see the client setup, auth shape, and listener/FunctionConfig semantics without reading the connector API docs end to end.

Release note

Added Azure Storage Files connector and trigger samples to the connector sample catalog.

Documentation

N/A — connector samples in this directory are not separately documented; they are surfaced through the connector catalog.

Training

N/A

Certification

N/A — adding samples has no impact on certification exams.

Marketing

N/A

Automation tests

  • Unit tests

    None. Consistent with the rest of integrator-default-profile/connectors/, which ships no test packages.

  • Integration tests

    None. Both packages were verified to compile with bal build; each produces its executable successfully. Running them end to end requires a live Azure Storage account and file share.

Security checks

  • Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes
  • Ran FindSecurityBugs plugin and verified report? N/A — FindSecurityBugs targets Java; these are Ballerina packages with no Java source.
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes — accountName, accountKey and shareName are all configurable with no defaults, and each package's .gitignore excludes Config.toml.

Samples

The two packages added by this PR are themselves the samples. Neither is registered in .github/workflows/projects.json, so no Docker image is built or pushed for them — matching how every other connector sample in this directory is handled.

Related PRs

wso2/docs-integrator#617

Migrations (if applicable)

N/A

Test environment

  • Ballerina: built locally with Swan Lake 2201.13.5; packages pin distribution = "2201.13.1".
  • OS: macOS (Darwin 25.5.0).

Learning

Modelled the package layout and file split on the existing connector samples in this directory (e.g. github_connector_sample), and the listener's @files:FunctionConfig post-processing options (afterProcess, afterError.moveTo) on the ballerinax/azure.storage.files connector API.

@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c837dbfa-c4e8-4f6c-8792-82faa6f7a4d2


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@niveathika
niveathika merged commit 08b0288 into wso2:main Aug 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants