TekH
222a5e24bf
- Replace DEXJobException with JobException base class - Flexible params-based detail collection - Automatic message formatting with visual separators - Optional null-handling for contextual details - Add JobHttpException for HTTP client failures - Properties: ClientLibrary, ClientMethod - Use case: ReC API, REST requests - Add JobSqlException for SQL query failures - Property: Query (virtual for customization) - Use case: Main/Check query execution - Comprehensive XML documentation for all exception classes
47 lines
2.3 KiB
C#
47 lines
2.3 KiB
C#
using System;
|
|
|
|
namespace ECMJobRunner.Application.Common.Exceptions
|
|
{
|
|
/// <summary>
|
|
/// Exception for HTTP client-related job failures (e.g., ReC API calls, REST requests)
|
|
/// Extends JobException with client library and method context
|
|
/// </summary>
|
|
public class JobHttpException : JobException
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of JobHttpException with HTTP client context
|
|
/// </summary>
|
|
/// <param name="jobName">Name of the job that failed (e.g., "ReC Request", "API Call")</param>
|
|
/// <param name="processName">Name of the process/stage being executed</param>
|
|
/// <param name="batchId">Unique batch identifier for tracking</param>
|
|
/// <param name="reason">Human-readable reason for the failure (nullable)</param>
|
|
/// <param name="clientLibrary">Name of the HTTP client library used (e.g., "ReC.Client", "HttpClient") (nullable)</param>
|
|
/// <param name="clientMethod">Name of the client method that failed (e.g., "ExecuteAsync", "PostAsync") (nullable)</param>
|
|
/// <param name="innerException">The underlying exception that caused the failure (nullable)</param>
|
|
/// <remarks>
|
|
/// Use this exception for HTTP-related failures such as:
|
|
/// - ReC API request failures
|
|
/// - REST API communication errors
|
|
/// - HTTP client timeout/network issues
|
|
/// - Authentication/authorization failures
|
|
/// </remarks>
|
|
public JobHttpException(string jobName, string processName, string batchId, string? reason, string? clientLibrary, string? clientMethod, Exception? innerException) : base(jobName, processName, batchId, reason, innerException,
|
|
("Client Library", clientLibrary, true),
|
|
("Client Method", clientMethod, true))
|
|
{
|
|
ClientLibrary = clientLibrary;
|
|
ClientMethod = clientMethod;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the name of the HTTP client library that was used (e.g., "ReC.Client", "HttpClient")
|
|
/// </summary>
|
|
public string? ClientLibrary { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the name of the client method that failed (e.g., "ExecuteAsync", "PostAsync")
|
|
/// </summary>
|
|
public string? ClientMethod { get; }
|
|
}
|
|
}
|