From 3a43320fa5f404fa95e32c8a7453964dc3f7c9c8 Mon Sep 17 00:00:00 2001 From: Nuvindu Date: Tue, 13 Aug 2024 14:30:03 +0530 Subject: [PATCH] Update description in LDAP BBEs --- .../ldap-add-remove-entry/ldap_add_remove_entry.bal | 13 ++++++++----- .../ldap-add-remove-entry/ldap_add_remove_entry.md | 2 +- .../ldap-search-entry copy/ldap_search_entry.bal | 11 ++++++----- .../ldap-search-entry copy/ldap_search_entry.md | 2 +- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal b/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal index aec27e9279..1d31fee65c 100644 --- a/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal +++ b/examples/ldap-add-remove-entry/ldap_add_remove_entry.bal @@ -1,16 +1,18 @@ -import ballerina/ldap; import ballerina/io; +import ballerina/ldap; public function main() returns error? { - ldap:Client ldap = check new({ + // Initializes a new LDAP client with credentials. + ldap:Client ldapClient = check new ({ hostName: "localhost", port: 389, domainName: "cn=admin,dc=example,dc=com", password: "adminpassword" }); - ldap:LdapResponse addResponse = check ldap->add( - "cn=user,dc=example,dc=com", + // Adds an entry to the directory server. + ldap:LdapResponse addResponse = check ldapClient->add( + "cn=user,dc=example,dc=com", { "objectClass": ["top", "person"], "sn": "user", @@ -19,6 +21,7 @@ public function main() returns error? { ); io:println("Add Response: ", addResponse.resultCode); - ldap:LdapResponse deleteResponse = check ldap->delete("cn=user,dc=example,dc=com"); + // Deletes an entry from the directory server. + ldap:LdapResponse deleteResponse = check ldapClient->delete("cn=user,dc=example,dc=com"); io:println("Delete Response: ", deleteResponse.resultCode); } diff --git a/examples/ldap-add-remove-entry/ldap_add_remove_entry.md b/examples/ldap-add-remove-entry/ldap_add_remove_entry.md index 97f297da42..ba92341023 100644 --- a/examples/ldap-add-remove-entry/ldap_add_remove_entry.md +++ b/examples/ldap-add-remove-entry/ldap_add_remove_entry.md @@ -1,4 +1,4 @@ -# LDAP Client - Add/Remove entries +# LDAP client - Add/Remove entries The `ldap:Client` connects to a directory server and performs various operations on directories. Currently, it supports the generic LDAP operations; `add`, `modify`, `modifyDN`, `compare`, `search`, `searchWithType`, `delete`, and `close`. diff --git a/examples/ldap-search-entry copy/ldap_search_entry.bal b/examples/ldap-search-entry copy/ldap_search_entry.bal index a37163a911..c452c5d928 100644 --- a/examples/ldap-search-entry copy/ldap_search_entry.bal +++ b/examples/ldap-search-entry copy/ldap_search_entry.bal @@ -1,19 +1,20 @@ -import ballerina/ldap; import ballerina/io; +import ballerina/ldap; public function main() returns error? { - ldap:Client ldap = check new({ + // Initialized a new LDAP client. + ldap:Client ldapClient = check new ({ hostName: "localhost", port: 389, domainName: "cn=admin,dc=example,dc=com", password: "adminpassword" }); - ldap:SearchResult searchResult = check ldap->search( - "cn=user,dc=example,dc=com", + // Searches for an entry in the directory server. + ldap:SearchResult searchResult = check ldapClient->search( + "cn=user,dc=example,dc=com", "(sn=user)", ldap:SUB ); - io:println("Search Response: ", searchResult.resultCode); } diff --git a/examples/ldap-search-entry copy/ldap_search_entry.md b/examples/ldap-search-entry copy/ldap_search_entry.md index fcbda0379c..9dac6f852c 100644 --- a/examples/ldap-search-entry copy/ldap_search_entry.md +++ b/examples/ldap-search-entry copy/ldap_search_entry.md @@ -1,4 +1,4 @@ -# LDAP Client - Seacrh for an entry +# LDAP client - Seacrh for an entry The `ldap:Client` connects to a directory server and performs various operations on directories. Currently, it supports the main LDAP operations; `add`, `modify`, `modifyDN`, `compare`, `search`, `searchWithType`, `delete`, and `close`.