Updates naming of logging provider

This commit is contained in:
Ryan Newington
2023-07-22 15:08:35 +10:00
parent ed679eba6b
commit feb6987657
12 changed files with 50 additions and 40 deletions
@@ -17,7 +17,7 @@ namespace Lithnet.CredentialProvider
private FieldInteractiveState interactiveState; private FieldInteractiveState interactiveState;
private string label; private string label;
private FieldOptions options; private FieldOptions options;
private protected ILogger logger; private protected ICredentialProviderLogger logger;
public event PropertyChangedEventHandler PropertyChanged; public event PropertyChangedEventHandler PropertyChanged;
private protected ControlBase(ControlBase source) private protected ControlBase(ControlBase source)
@@ -72,7 +72,7 @@ namespace Lithnet.CredentialProvider
internal ICredentialProviderCredential Credential { get; private set; } internal ICredentialProviderCredential Credential { get; private set; }
internal void SetLogger(ILoggerFactory loggerFactory) internal void SetLogger(ICredentialProviderLoggerFactory loggerFactory)
{ {
this.logger = loggerFactory.CreateLogger(this.GetType()); this.logger = loggerFactory.CreateLogger(this.GetType());
} }
@@ -11,7 +11,7 @@ namespace Lithnet.CredentialProvider
/// </summary> /// </summary>
public abstract partial class CredentialProviderBase public abstract partial class CredentialProviderBase
{ {
private readonly ILogger logger; private readonly ICredentialProviderLogger logger;
private ICredentialProviderEvents CredentialProviderEvents; private ICredentialProviderEvents CredentialProviderEvents;
private ICredentialProviderUserArray credentialProviderUsers; private ICredentialProviderUserArray credentialProviderUsers;
@@ -19,7 +19,7 @@ namespace Lithnet.CredentialProvider
private bool notifyOnTileCollectionChange; private bool notifyOnTileCollectionChange;
private List<CredentialTile> tiles; private List<CredentialTile> tiles;
internal ILoggerFactory LoggerFactory { get; } internal ICredentialProviderLoggerFactory LoggerFactory { get; }
/// <summary> /// <summary>
/// Gets the GUID of the credential provider /// 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 <c ref="ILoggerFactory"/> to enable credential provider logging /// Gets a logger factory. Override this method and provide an implementation of <c ref="ILoggerFactory"/> to enable credential provider logging
/// </summary> /// </summary>
/// <returns>An ILoggerFactory instance</returns> /// <returns>An ILoggerFactory instance</returns>
protected virtual ILoggerFactory GetLoggerFactory() { return TraceLoggerFactory.Instance; } protected virtual ICredentialProviderLoggerFactory GetLoggerFactory() { return TraceLoggerFactory.Instance; }
/// <summary> /// <summary>
/// Gets a value indicating if the credential provider supports the <c ref="UsageScenario"/> provided by LogonUI or CredUI /// Gets a value indicating if the credential provider supports the <c ref="UsageScenario"/> provided by LogonUI or CredUI
@@ -10,7 +10,7 @@ namespace Lithnet.CredentialProvider
public class CredentialProviderUser public class CredentialProviderUser
{ {
internal readonly ICredentialProviderUser User; internal readonly ICredentialProviderUser User;
private readonly ILogger logger; private readonly ICredentialProviderLogger logger;
private string qualifiedUserName; private string qualifiedUserName;
private string sid; private string sid;
private string userName; private string userName;
@@ -18,7 +18,7 @@ namespace Lithnet.CredentialProvider
private string logonStatus; private string logonStatus;
private string providerId; private string providerId;
internal CredentialProviderUser(ILoggerFactory loggerFactory, ICredentialProviderUser user) internal CredentialProviderUser(ICredentialProviderLoggerFactory loggerFactory, ICredentialProviderUser user)
{ {
this.User = user; this.User = user;
this.logger = loggerFactory.CreateLogger<CredentialProviderUser>(); this.logger = loggerFactory.CreateLogger<CredentialProviderUser>();
@@ -10,7 +10,7 @@ namespace Lithnet.CredentialProvider
/// <remarks>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</remarks> /// <remarks>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</remarks>
public abstract partial class CredentialTile public abstract partial class CredentialTile
{ {
private protected readonly ILogger logger; private protected readonly ICredentialProviderLogger logger;
private protected ICredentialProviderCredentialEvents events; private protected ICredentialProviderCredentialEvents events;
private protected ICredentialProviderCredentialEvents2 events2; private protected ICredentialProviderCredentialEvents2 events2;
@@ -7,9 +7,9 @@ namespace Lithnet.CredentialProvider.Interop
{ {
internal class CredentialSerializer internal class CredentialSerializer
{ {
private readonly ILogger logger; private readonly ICredentialProviderLogger logger;
public CredentialSerializer(ILoggerFactory loggerFactory) public CredentialSerializer(ICredentialProviderLoggerFactory loggerFactory)
{ {
this.logger = loggerFactory.CreateLogger<CredentialSerializer>(); this.logger = loggerFactory.CreateLogger<CredentialSerializer>();
} }
@@ -7,7 +7,7 @@ namespace Lithnet.CredentialProvider.Interop
internal static class InternalExtensions internal static class InternalExtensions
{ {
[Conditional("DEBUG")] [Conditional("DEBUG")]
internal static void LogWarningDebug(this ILogger logger, string message) internal static void LogWarningDebug(this ICredentialProviderLogger logger, string message)
{ {
logger.LogWarning(message); logger.LogWarning(message);
} }
@@ -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);
}
}
@@ -0,0 +1,11 @@
using System;
namespace Lithnet.CredentialProvider
{
public interface ICredentialProviderLoggerFactory
{
ICredentialProviderLogger CreateLogger(Type type);
ICredentialProviderLogger CreateLogger<T>();
}
}
@@ -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);
}
}
@@ -1,11 +0,0 @@
using System;
namespace Lithnet.CredentialProvider
{
public interface ILoggerFactory
{
ILogger CreateLogger(Type type);
ILogger CreateLogger<T>();
}
}
@@ -3,11 +3,11 @@ using System.Diagnostics;
namespace Lithnet.CredentialProvider namespace Lithnet.CredentialProvider
{ {
public class TraceLogger : ILogger public class TraceLogger : ICredentialProviderLogger
{ {
public void LogError(Exception ex, string v) 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) public void LogError(string v)
@@ -15,6 +15,11 @@ namespace Lithnet.CredentialProvider
Trace.TraceError(v); Trace.TraceError(v);
} }
public void LogInformation(string message)
{
Trace.TraceInformation(message);
}
public void LogTrace(string v) public void LogTrace(string v)
{ {
Trace.TraceInformation(v); Trace.TraceInformation(v);
@@ -2,20 +2,20 @@
namespace Lithnet.CredentialProvider namespace Lithnet.CredentialProvider
{ {
public class TraceLoggerFactory : ILoggerFactory public class TraceLoggerFactory : ICredentialProviderLoggerFactory
{ {
public ILogger CreateLogger(Type type) public ICredentialProviderLogger CreateLogger(Type type)
{ {
return new TraceLogger(); return new TraceLogger();
} }
public ILogger CreateLogger<T>() public ICredentialProviderLogger CreateLogger<T>()
{ {
return new TraceLogger(); return new TraceLogger();
} }
private static readonly TraceLoggerFactory loggerFactory = new TraceLoggerFactory(); private static readonly TraceLoggerFactory loggerFactory = new TraceLoggerFactory();
public static ILoggerFactory Instance => loggerFactory; public static ICredentialProviderLoggerFactory Instance => loggerFactory;
} }
} }