refactor(DirectorySearchService): Methoden asynchron gemacht

DigitalData.Core.Abstractions/Application/IDirectorySearchService.cs

@@ -13,14 +13,82 @@ namespace DigitalData.Core.Abstractions.Application
 
         Dictionary<string, string> CustomSearchFilters { get; }
 
-        bool ValidateCredentials(string dirEntryUsername, string dirEntryPassword);
+        /// <summary>
+        /// Creates the connections to the server and returns a Boolean value that specifies
+        /// whether the specified username and password are valid.
+        /// </summary>
+        /// <param name="userName">The username that is validated on the server. See the Remarks section
+        /// for more information on the format of userName.</param>
+        /// <param name="password">The password that is validated on the server.</param>
+        /// <returns>True if the credentials are valid; otherwise, false.</returns>
+        bool ValidateCredentials(string userName, string password);
 
+        /// <summary>
+        /// Creates the connections to the server asynchronously and returns a Boolean value that specifies
+        /// whether the specified username and password are valid.
+        /// </summary>
+        /// <param name="userName">The username that is validated on the server. See the Remarks section
+        /// for more information on the format of userName.</param>
+        /// <param name="password">The password that is validated on the server.</param>
+        /// <returns>True if the credentials are valid; otherwise, false.</returns>
+        Task<bool> ValidateCredentialsAsync(string userName, string password);
+
+        /// <summary>
+        /// Finds all directory entries matching the specified filter.
+        /// </summary>
+        /// <param name="searchRoot">The search root.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
         DataResult<IEnumerable<ResultPropertyCollection>> FindAll(DirectoryEntry searchRoot, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties);
 
+        /// <summary>
+        /// Finds all directory entries matching the specified filter asynchronously.
+        /// </summary>
+        /// <param name="searchRoot">The search root.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
+        Task<DataResult<IEnumerable<ResultPropertyCollection>>> FindAllAsync(DirectoryEntry searchRoot, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties);
+
+        /// <summary>
+        /// Finds all directory entries matching the specified filter, using the user cache.
+        /// </summary>
+        /// <param name="username">The username.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
         DataResult<IEnumerable<ResultPropertyCollection>> FindAllByUserCache(string username, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties);
 
+        /// <summary>
+        /// Finds all directory entries matching the specified filter asynchronously, using the user cache.
+        /// </summary>
+        /// <param name="username">The username.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
+        Task<DataResult<IEnumerable<ResultPropertyCollection>>> FindAllByUserCacheAsync(string username, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties);
+
+        /// <summary>
+        /// Sets the search root in the cache.
+        /// </summary>
+        /// <param name="username">The directory entry username.</param>
+        /// <param name="password">The directory entry password.</param>
         void SetSearchRootCache(string username, string password);
 
+        /// <summary>
+        /// Gets the search root from the cache.
+        /// </summary>
+        /// <param name="username">The directory entry username.</param>
+        /// <returns>The cached <see cref="DirectoryEntry"/> if found; otherwise, null.</returns>
         DirectoryEntry? GetSearchRootCache(string username);
     }
 }

DigitalData.Core.Application/DirectorySearchService.cs

@@ -8,6 +8,7 @@ using Microsoft.Extensions.Options;
 
 namespace DigitalData.Core.Application
 {
+    //TODO: rename as DirectorySearcher
     [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "<Pending>")]
     public class DirectorySearchService : IDirectorySearchService
     {
@@ -45,17 +46,31 @@ namespace DigitalData.Core.Application
         }
 
         /// <summary>
-        /// Validates the credentials of a directory entry.
+        /// Creates the connections to the server and returns a Boolean value that specifies
+        /// whether the specified username and password are valid.
         /// </summary>
-        /// <param name="dirEntryUsername">The directory entry username.</param>
+        /// <param name="userName">The username that is validated on the server. See the Remarks section
-        /// <param name="dirEntryPassword">The directory entry password.</param>
+        /// for more information on the format of userName.</param>
+        /// <param name="password">The password that is validated on the server.</param>
         /// <returns>True if the credentials are valid; otherwise, false.</returns>
-        public bool ValidateCredentials(string dirEntryUsername, string dirEntryPassword)
+        public bool ValidateCredentials(string userName, string password)
         {
             using var context = new PrincipalContext(ContextType.Domain, ServerName, Root);
-            return context.ValidateCredentials(dirEntryUsername, dirEntryPassword);
+            return context.ValidateCredentials(userName, password);
         }
 
+        /// <summary>
+        /// Creates the connections to the server asynchronously and returns a Boolean value that specifies
+        /// whether the specified username and password are valid.
+        /// </summary>
+        /// <param name="userName">The username that is validated on the server. See the Remarks section
+        /// for more information on the format of userName.</param>
+        /// <param name="password">The password that is validated on the server.</param>
+        /// <returns>True if the credentials are valid; otherwise, false.</returns>
+        public Task<bool> ValidateCredentialsAsync(string userName, string password) => Task.Run(()
+            => ValidateCredentials(userName, password));
+
+        //TODO: remove unnecessary DataResult
         /// <summary>
         /// Finds all directory entries matching the specified filter.
         /// </summary>
@@ -69,7 +84,7 @@ namespace DigitalData.Core.Application
         {
             List<ResultPropertyCollection> list = new();
 
-            var searcher = new DirectorySearcher()
+            using var searcher = new DirectorySearcher()
             {
                 Filter = filter,
                 SearchScope = searchScope,
@@ -94,6 +109,18 @@ namespace DigitalData.Core.Application
             return Result.Success<IEnumerable<ResultPropertyCollection>>(list);
         }
 
+        /// <summary>
+        /// Finds all directory entries matching the specified filter asynchronously.
+        /// </summary>
+        /// <param name="searchRoot">The search root.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
+        public Task<DataResult<IEnumerable<ResultPropertyCollection>>> FindAllAsync(DirectoryEntry searchRoot, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties) => Task.Run(()
+            => FindAll(searchRoot, filter, searchScope, sizeLimit, properties));
+
         /// <summary>
         /// Finds all directory entries matching the specified filter, using the user cache.
         /// </summary>
@@ -113,27 +140,39 @@ namespace DigitalData.Core.Application
             return FindAll(searchRoot, filter, searchScope, sizeLimit, properties);
         }
 
+        /// <summary>
+        /// Finds all directory entries matching the specified filter asynchronously, using the user cache.
+        /// </summary>
+        /// <param name="username">The username.</param>
+        /// <param name="filter">The search filter.</param>
+        /// <param name="searchScope">The search scope.</param>
+        /// <param name="sizeLimit">The size limit.</param>
+        /// <param name="properties">The properties to load.</param>
+        /// <returns>A <see cref="DataResult{T}"/> containing the results.</returns>
+        public Task<DataResult<IEnumerable<ResultPropertyCollection>>> FindAllByUserCacheAsync(string username, string filter, SearchScope searchScope = SearchScope.Subtree, int sizeLimit = 5000, params string[] properties) => Task.Run(()
+            => FindAllByUserCache(username, filter, searchScope, sizeLimit, properties));
+
         /// <summary>
         /// Sets the search root in the cache.
         /// </summary>
-        /// <param name="dirEntryUsername">The directory entry username.</param>
+        /// <param name="username">The directory entry username.</param>
-        /// <param name="dirEntryPassword">The directory entry password.</param>
+        /// <param name="password">The directory entry password.</param>
-        public void SetSearchRootCache(string dirEntryUsername, string dirEntryPassword)
+        public void SetSearchRootCache(string username, string password)
         {
             if (_userCacheExpiration is DateTimeOffset cacheExpiration)
-                _memoryCache.Set(key: dirEntryUsername, new DirectoryEntry(path: SearchRootPath, username: dirEntryUsername, password: dirEntryPassword), absoluteExpiration: cacheExpiration);
+                _memoryCache.Set(key: username, new DirectoryEntry(path: SearchRootPath, username: username, password: password), absoluteExpiration: cacheExpiration);
             else
-                _memoryCache.Set(key: dirEntryUsername, new DirectoryEntry(path: SearchRootPath, username: dirEntryUsername, password: dirEntryPassword));
+                _memoryCache.Set(key: username, new DirectoryEntry(path: SearchRootPath, username: username, password: password));
         }
 
         /// <summary>
         /// Gets the search root from the cache.
         /// </summary>
-        /// <param name="dirEntryUsername">The directory entry username.</param>
+        /// <param name="username">The directory entry username.</param>
         /// <returns>The cached <see cref="DirectoryEntry"/> if found; otherwise, null.</returns>
-        public DirectoryEntry? GetSearchRootCache(string dirEntryUsername)
+        public DirectoryEntry? GetSearchRootCache(string username)
         {
-            _memoryCache.TryGetValue(dirEntryUsername, out DirectoryEntry? root);
+            _memoryCache.TryGetValue(username, out DirectoryEntry? root);
             return root;
         }
     }