Merge pull request #1421 from ballerina-platform/listener-config

Make listener configuration as an included parameter

ballerina/Dependencies.toml

@@ -5,7 +5,7 @@
 
 [ballerina]
 dependencies-toml-version = "2"
-distribution-version = "2201.11.0-20241121-075100-c4c87cbc"
+distribution-version = "2201.11.0-20250127-101700-a4b67fe5"
 
 [[package]]
 org = "ballerina"

ballerina/listener_endpoint.bal

@@ -29,7 +29,7 @@ public isolated class Listener {
     #
     # + listenerConfig - Configurations for FTP listener
     # + return - `()` or else an `ftp:Error` upon failure to initialize the listener
-    public isolated function init(ListenerConfiguration listenerConfig) returns Error? {
+    public isolated function init(*ListenerConfiguration listenerConfig) returns Error? {
         self.config = listenerConfig.clone();
         lock {
             return initListener(self, self.config);

ballerina/tests/listener_endpoint_test.bal

@@ -226,20 +226,20 @@ public function testServerRegisterFailureEmptyUsername() returns error? {
 
 @test:Config {}
 public function testServerRegisterFailureInvalidUsername() returns error? {
-    Listener|Error invalidUsernameServer = new ({
-        protocol: FTP,
-        host: "127.0.0.1",
-        auth: {
+    Listener|Error invalidUsernameServer = new (
+        protocol = FTP,
+        host = "127.0.0.1",
+        auth = {
             credentials: {
                 username: "ballerina",
                 password: "wso2"
             }
         },
-        port: 21212,
-        path: "/home/in",
-        pollingInterval: 2,
-        fileNamePattern: "(.*).txt"
-    });
+        port = 21212,
+        path = "/home/in",
+        pollingInterval = 2,
+        fileNamePattern = "(.*).txt"
+    );
 
     if invalidUsernameServer is Error {
         test:assertEquals(invalidUsernameServer.message(), "Failed to initialize File server connector.");

changelog.md

@@ -3,6 +3,12 @@ This file contains all the notable changes done to the Ballerina Email package t
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+
+- [Change the listener configuration as an included parameter](https://github.com/ballerina-platform/ballerina-library/issues/7494)
+
 ## [2.11.0] - 2024-08-20
 
 ### Fixed

docs/spec/spec.md

@@ -365,7 +365,7 @@ An insecure FTP listener can be initialized by providing the mandatory `protocol
 #
 # + listenerConfig - Configurations for FTP listener
 # + return - `()` or else an `ftp:Error` upon failure to initialize the listener
-public isolated function init(ListenerConfiguration listenerConfig) returns Error?;
+public isolated function init(*ListenerConfiguration listenerConfig) returns Error?;
 ```
 #### 4.2.2. Secure Listener
 A secure listener can be initialized by providing `ftp:SFTP` as the protocol and by providing `ftp:Credentials`

examples/covid19-stat-publisher/processor/processor.bal

@@ -35,14 +35,14 @@ ftp:ClientConfiguration sftpClientConfig = {
     auth: authConfig
 };
 
-listener ftp:Listener secureRemoteServer = check new({
-    protocol: ftp:SFTP,
-    host: "localhost",
-    auth: authConfig,
-    port: 21213,
-    pollingInterval: 2,
-    fileNamePattern: "(.*).csv"
-});
+listener ftp:Listener secureRemoteServer = check new(
+    protocol = ftp:SFTP,
+    host = "localhost",
+    auth = authConfig,
+    port = 21213,
+    pollingInterval = 2,
+    fileNamePattern = "(.*).csv"
+);
 
 service "Covid19UpdateDownloader" on secureRemoteServer {