From feb6987657ed93786b5cd636130f54c3080abfa0 Mon Sep 17 00:00:00 2001 From: Ryan Newington Date: Sat, 22 Jul 2023 15:08:35 +1000 Subject: [PATCH] Updates naming of logging provider --- .../Controls/ControlBase.cs | 4 ++-- .../CredentialProviderBase.cs | 6 +++--- .../CredentialProviderUser.cs | 4 ++-- .../CredentialTile.cs | 2 +- .../Interop/CredentialSerializer.cs | 4 ++-- .../Interop/InternalExtensions.cs | 2 +- .../Logging/ICredentialProviderLogger.cs | 17 +++++++++++++++++ .../Logging/ICredentialProviderLoggerFactory.cs | 11 +++++++++++ .../Logging/ILogger.cs | 12 ------------ .../Logging/ILoggerFactory.cs | 11 ----------- .../Logging/TraceLogger.cs | 9 +++++++-- .../Logging/TraceLoggerFactory.cs | 8 ++++---- 12 files changed, 50 insertions(+), 40 deletions(-) create mode 100644 src/Lithnet.CredentialProvider/Logging/ICredentialProviderLogger.cs create mode 100644 src/Lithnet.CredentialProvider/Logging/ICredentialProviderLoggerFactory.cs delete mode 100644 src/Lithnet.CredentialProvider/Logging/ILogger.cs delete mode 100644 src/Lithnet.CredentialProvider/Logging/ILoggerFactory.cs diff --git a/src/Lithnet.CredentialProvider/Controls/ControlBase.cs b/src/Lithnet.CredentialProvider/Controls/ControlBase.cs index 508ebc7..d53d417 100644 --- a/src/Lithnet.CredentialProvider/Controls/ControlBase.cs +++ b/src/Lithnet.CredentialProvider/Controls/ControlBase.cs @@ -17,7 +17,7 @@ namespace Lithnet.CredentialProvider private FieldInteractiveState interactiveState; private string label; private FieldOptions options; - private protected ILogger logger; + private protected ICredentialProviderLogger logger; public event PropertyChangedEventHandler PropertyChanged; private protected ControlBase(ControlBase source) @@ -72,7 +72,7 @@ namespace Lithnet.CredentialProvider internal ICredentialProviderCredential Credential { get; private set; } - internal void SetLogger(ILoggerFactory loggerFactory) + internal void SetLogger(ICredentialProviderLoggerFactory loggerFactory) { this.logger = loggerFactory.CreateLogger(this.GetType()); } diff --git a/src/Lithnet.CredentialProvider/CredentialProviderBase.cs b/src/Lithnet.CredentialProvider/CredentialProviderBase.cs index 33637b8..b5f2a08 100644 --- a/src/Lithnet.CredentialProvider/CredentialProviderBase.cs +++ b/src/Lithnet.CredentialProvider/CredentialProviderBase.cs @@ -11,7 +11,7 @@ namespace Lithnet.CredentialProvider /// public abstract partial class CredentialProviderBase { - private readonly ILogger logger; + private readonly ICredentialProviderLogger logger; private ICredentialProviderEvents CredentialProviderEvents; private ICredentialProviderUserArray credentialProviderUsers; @@ -19,7 +19,7 @@ namespace Lithnet.CredentialProvider private bool notifyOnTileCollectionChange; private List tiles; - internal ILoggerFactory LoggerFactory { get; } + internal ICredentialProviderLoggerFactory LoggerFactory { get; } /// /// Gets the GUID of the credential provider @@ -71,7 +71,7 @@ namespace Lithnet.CredentialProvider /// Gets a logger factory. Override this method and provide an implementation of to enable credential provider logging /// /// An ILoggerFactory instance - protected virtual ILoggerFactory GetLoggerFactory() { return TraceLoggerFactory.Instance; } + protected virtual ICredentialProviderLoggerFactory GetLoggerFactory() { return TraceLoggerFactory.Instance; } /// /// Gets a value indicating if the credential provider supports the provided by LogonUI or CredUI diff --git a/src/Lithnet.CredentialProvider/CredentialProviderUser.cs b/src/Lithnet.CredentialProvider/CredentialProviderUser.cs index 636a378..86b5f86 100644 --- a/src/Lithnet.CredentialProvider/CredentialProviderUser.cs +++ b/src/Lithnet.CredentialProvider/CredentialProviderUser.cs @@ -10,7 +10,7 @@ namespace Lithnet.CredentialProvider public class CredentialProviderUser { internal readonly ICredentialProviderUser User; - private readonly ILogger logger; + private readonly ICredentialProviderLogger logger; private string qualifiedUserName; private string sid; private string userName; @@ -18,7 +18,7 @@ namespace Lithnet.CredentialProvider private string logonStatus; private string providerId; - internal CredentialProviderUser(ILoggerFactory loggerFactory, ICredentialProviderUser user) + internal CredentialProviderUser(ICredentialProviderLoggerFactory loggerFactory, ICredentialProviderUser user) { this.User = user; this.logger = loggerFactory.CreateLogger(); diff --git a/src/Lithnet.CredentialProvider/CredentialTile.cs b/src/Lithnet.CredentialProvider/CredentialTile.cs index 5e626a9..d4d5ec0 100644 --- a/src/Lithnet.CredentialProvider/CredentialTile.cs +++ b/src/Lithnet.CredentialProvider/CredentialTile.cs @@ -10,7 +10,7 @@ namespace Lithnet.CredentialProvider /// Inheriting from this class enables you to provide a v1 credential tile. V1 credential tiles were introduced in Windows Vista. These tiles are not personalized. See the Microsoft documentation on ICredentialProviderCredential for more information public abstract partial class CredentialTile { - private protected readonly ILogger logger; + private protected readonly ICredentialProviderLogger logger; private protected ICredentialProviderCredentialEvents events; private protected ICredentialProviderCredentialEvents2 events2; diff --git a/src/Lithnet.CredentialProvider/Interop/CredentialSerializer.cs b/src/Lithnet.CredentialProvider/Interop/CredentialSerializer.cs index 0ae4fea..b20e5fd 100644 --- a/src/Lithnet.CredentialProvider/Interop/CredentialSerializer.cs +++ b/src/Lithnet.CredentialProvider/Interop/CredentialSerializer.cs @@ -7,9 +7,9 @@ namespace Lithnet.CredentialProvider.Interop { internal class CredentialSerializer { - private readonly ILogger logger; + private readonly ICredentialProviderLogger logger; - public CredentialSerializer(ILoggerFactory loggerFactory) + public CredentialSerializer(ICredentialProviderLoggerFactory loggerFactory) { this.logger = loggerFactory.CreateLogger(); } diff --git a/src/Lithnet.CredentialProvider/Interop/InternalExtensions.cs b/src/Lithnet.CredentialProvider/Interop/InternalExtensions.cs index 88ff80e..a5ad9f2 100644 --- a/src/Lithnet.CredentialProvider/Interop/InternalExtensions.cs +++ b/src/Lithnet.CredentialProvider/Interop/InternalExtensions.cs @@ -7,7 +7,7 @@ namespace Lithnet.CredentialProvider.Interop internal static class InternalExtensions { [Conditional("DEBUG")] - internal static void LogWarningDebug(this ILogger logger, string message) + internal static void LogWarningDebug(this ICredentialProviderLogger logger, string message) { logger.LogWarning(message); } diff --git a/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLogger.cs b/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLogger.cs new file mode 100644 index 0000000..874a906 --- /dev/null +++ b/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLogger.cs @@ -0,0 +1,17 @@ +using System; + +namespace Lithnet.CredentialProvider +{ + public interface ICredentialProviderLogger + { + void LogError(Exception ex, string message); + + void LogError(string message); + + void LogTrace(string message); + + void LogInformation(string message); + + void LogWarning(string message); + } +} diff --git a/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLoggerFactory.cs b/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLoggerFactory.cs new file mode 100644 index 0000000..4f03efe --- /dev/null +++ b/src/Lithnet.CredentialProvider/Logging/ICredentialProviderLoggerFactory.cs @@ -0,0 +1,11 @@ +using System; + +namespace Lithnet.CredentialProvider +{ + public interface ICredentialProviderLoggerFactory + { + ICredentialProviderLogger CreateLogger(Type type); + + ICredentialProviderLogger CreateLogger(); + } +} diff --git a/src/Lithnet.CredentialProvider/Logging/ILogger.cs b/src/Lithnet.CredentialProvider/Logging/ILogger.cs deleted file mode 100644 index 3a03fc4..0000000 --- a/src/Lithnet.CredentialProvider/Logging/ILogger.cs +++ /dev/null @@ -1,12 +0,0 @@ -using System; - -namespace Lithnet.CredentialProvider -{ - public interface ILogger - { - void LogError(Exception ex, string v); - void LogError(string v); - void LogTrace(string v); - void LogWarning(string message); - } -} diff --git a/src/Lithnet.CredentialProvider/Logging/ILoggerFactory.cs b/src/Lithnet.CredentialProvider/Logging/ILoggerFactory.cs deleted file mode 100644 index aa42552..0000000 --- a/src/Lithnet.CredentialProvider/Logging/ILoggerFactory.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System; - -namespace Lithnet.CredentialProvider -{ - public interface ILoggerFactory - { - ILogger CreateLogger(Type type); - - ILogger CreateLogger(); - } -} diff --git a/src/Lithnet.CredentialProvider/Logging/TraceLogger.cs b/src/Lithnet.CredentialProvider/Logging/TraceLogger.cs index 7020dee..9e15ec1 100644 --- a/src/Lithnet.CredentialProvider/Logging/TraceLogger.cs +++ b/src/Lithnet.CredentialProvider/Logging/TraceLogger.cs @@ -3,11 +3,11 @@ using System.Diagnostics; namespace Lithnet.CredentialProvider { - public class TraceLogger : ILogger + public class TraceLogger : ICredentialProviderLogger { public void LogError(Exception ex, string v) { - Trace.TraceError(v + "\r\n\r\n" + ex?.ToString()); + Trace.TraceError($"{v}\r\n\r\n{ex?.ToString()}"); } public void LogError(string v) @@ -15,6 +15,11 @@ namespace Lithnet.CredentialProvider Trace.TraceError(v); } + public void LogInformation(string message) + { + Trace.TraceInformation(message); + } + public void LogTrace(string v) { Trace.TraceInformation(v); diff --git a/src/Lithnet.CredentialProvider/Logging/TraceLoggerFactory.cs b/src/Lithnet.CredentialProvider/Logging/TraceLoggerFactory.cs index 35ecac9..6b46753 100644 --- a/src/Lithnet.CredentialProvider/Logging/TraceLoggerFactory.cs +++ b/src/Lithnet.CredentialProvider/Logging/TraceLoggerFactory.cs @@ -2,20 +2,20 @@ namespace Lithnet.CredentialProvider { - public class TraceLoggerFactory : ILoggerFactory + public class TraceLoggerFactory : ICredentialProviderLoggerFactory { - public ILogger CreateLogger(Type type) + public ICredentialProviderLogger CreateLogger(Type type) { return new TraceLogger(); } - public ILogger CreateLogger() + public ICredentialProviderLogger CreateLogger() { return new TraceLogger(); } private static readonly TraceLoggerFactory loggerFactory = new TraceLoggerFactory(); - public static ILoggerFactory Instance => loggerFactory; + public static ICredentialProviderLoggerFactory Instance => loggerFactory; } }