/**
* FUNCTION : GetErrorLevelString
* DESCRIPTION : Used for generating the log message, gets a string for the corresponding error level
* PARAMETERS : LoggingInfo.ErrorLevel errorLevel : The error level that is to be converted to a string
* RETURNS : String : The string version of errorLevel
*/
private string GetErrorLevelString(Definitions.LoggingInfo.ErrorLevel errorLevel)
{
string returnString = "";
int errorIntValue = (int)errorLevel;
switch (errorIntValue)
{
case 1:
returnString = "DEBUG";
break;
case 2:
returnString = "INFO ";
break;
case 3:
returnString = "WARN ";
break;
case 4:
returnString = "ERROR";
break;
case 5:
returnString = "FATAL";
break;
}
return(returnString);
}
/**
* FUNCTION : Logging
* DESCRIPTION : Initalizes a loggin class with one parameter, only that
* error level will be logged.
* PARAMETERS : LoggingInfo.ErrorLevel single : The only error level to be logged
* RETURNS : NONE
*/
public Logging(Definitions.LoggingInfo.ErrorLevel single)
{
logFile = Definitions.LoggingInfo.logFilePath;
MaxLevel = single;
MinLevel = single;
}
/**
* FUNCTION : Log
* DESCRIPTION : Log a message, and will not log if the message is blank or spaces.
* PARAMETERS : LoggingInfo.ErrorLevel errorLevel : The error level of the log to be logged
* string message : The messeage of the log
* RETURNS : NONE
*/
public void Log(Definitions.LoggingInfo.ErrorLevel errorLevel,
string message)
{
if (string.IsNullOrWhiteSpace(message) == false && CheckLevel(errorLevel) == true)
{
string logMessage = string.Format("{0} [{1}] - {2} {3}\n", GetErrorLevelString(errorLevel), DateTime.Now, message, GetStackTrace());
SaveToFile(logMessage);
}
}
/**
* FUNCTION : Log
* DESCRIPTION : Log when there is an exception and will not log if the message is blank or spaces.
* PARAMETERS : LoggingInfo.ErrorLevel errorLevel : The error level of the log to be logged
* string message : The messeage of the log
* Exception ex : The exception being logged
* RETURNS : NONE
*/
public void Log(Definitions.LoggingInfo.ErrorLevel errorLevel,
string message,
Exception ex)
{
if (string.IsNullOrWhiteSpace(message) == false)
{
Log(errorLevel,
message + Environment.NewLine + " Exception caught:" + Environment.NewLine + " " + ex.ToString());
}
}
/**
* FUNCTION : Logging
* DESCRIPTION : Initializes a logging class with two parameters
* only error levels equal to the max(first parameter)
* and min(second parameter) are logged. If the
* max is greater than the min then throw an exception
* PARAMETERS : LoggingInfo.ErrorLevel max : The max error level to be logged
* LoggingInfo.ErrorLevel min : The min error level to be logged
* RETURNS : NONE
*/
public Logging(Definitions.LoggingInfo.ErrorLevel max, Definitions.LoggingInfo.ErrorLevel min)
{
if (max < min)
{
throw new System.ArgumentException("The first argument value cannot be greater than the second argument, " +
"see LoggingInfo for LoggingInfo.ErrorLevel values.");
}
logFile = Definitions.LoggingInfo.logFilePath;
MaxLevel = max;
MinLevel = min;
}
/**
* FUNCTION : CheckLevel
* DESCRIPTION : Check that the error level is within the desired capture levels
* PARAMETERS : LoggingInfo.ErrorLevel level : The error level to be tested against
* the max and min error levels. If the logs error level is ALL or
* OFF then the method will throw an exception
* RETURNS : bool : true if the error level is between or equal to the max and min error levels
* : false if it is outside the max and min values
*/
private bool CheckLevel(Definitions.LoggingInfo.ErrorLevel level)
{
bool returnValue = false;
if (level == Definitions.LoggingInfo.ErrorLevel.ALL || level == Definitions.LoggingInfo.ErrorLevel.OFF)
{
throw new System.ArgumentException("A message being logged can not have an error level equal to OFF or ALL.");
}
else if (MinLevel <= level && level <= MaxLevel)
{
returnValue = true;
}
return(returnValue);
}
