ca.nrc.widar.mccc.crm
Class CrmLog

java.lang.Object
  ca.nrc.widar.mccc.crm.CrmLog

public class CrmLog
extends java.lang.Object

WIDAR/EVLA - CRM: CrmLog Class

CrmLog is a static class containing all methods used in writing information to the log file during CRM and CrmGui execution.

Copyright: National Research Council of Canada and Associated Universities Inc., 2010, 2011, 2012

Since:

1.0

Author:

Dave Del Rizzo (Dave.DelRizzo@nrc.gc.ca)

Nested Class Summary

static class

CrmLog.ErrorLevel The ErrorLevel enumeration Currently not entirely sure if all of these levels are used, but they mirror the levels used elsewhere in the MCCC software and Alerts (to some extent) so here they remain.

Constructor Summary

CrmLog()
Convenience constructor for CRM, allowing the CRM to be instantiated with the default value for crmHost.

Method Summary

static void	alert(java.lang.String message) Logs the provided message with a 'LOG_ALERT' status
static void	crit(java.lang.String message) Logs the provided message with a 'LOG_CRIT' status
static void	debug(java.lang.String message) Logs the provided message with a 'LOG_DEBUG' status
static void	emergency(java.lang.String message) Logs the provided message with a 'LOG_EMERG' status
static void	err(java.lang.String message) Logs the provided message with a 'LOG_ERR' status
static void	exception(CrmLog.ErrorLevel level, java.lang.String message, java.lang.Exception e) An Exception handling method used by all classes within the CRM package to log and display the particulars of an exception reported within the CRM system.
static void	info(java.lang.String message) Logs the provided message with a 'LOG_INFO' status
static void	message(CrmLog.ErrorLevel level, java.lang.String message) Logs the provided message with the provided status level
static void	notice(java.lang.String message) Logs the provided message with a 'LOG_NOTICE' status
static void	warning(java.lang.String message) Logs the provided message with a 'LOG_WARNING' status
static void	xmlErr(java.lang.String message) Logs the provided message with a 'LOG_ERR' status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrmLog

public CrmLog()

Convenience constructor for CRM, allowing the CRM to be instantiated with the default value for crmHost.

Method Detail

emergency

public static void emergency(java.lang.String message)

Logs the provided message with a 'LOG_EMERG' status

Parameters:

message - A string containing the message to be logged

alert

public static void alert(java.lang.String message)

Logs the provided message with a 'LOG_ALERT' status

Parameters:

message - A string containing the message to be logged

crit

public static void crit(java.lang.String message)

Logs the provided message with a 'LOG_CRIT' status

Parameters:

message - A string containing the message to be logged

err

public static void err(java.lang.String message)

Logs the provided message with a 'LOG_ERR' status

Parameters:

message - A string containing the message to be logged

xmlErr

public static void xmlErr(java.lang.String message)

Logs the provided message with a 'LOG_ERR' status

Parameters:

message - A string containing the message to be logged

warning

public static void warning(java.lang.String message)

Logs the provided message with a 'LOG_WARNING' status

Parameters:

message - A string containing the message to be logged

notice

public static void notice(java.lang.String message)

Logs the provided message with a 'LOG_NOTICE' status

Parameters:

message - A string containing the message to be logged

info

public static void info(java.lang.String message)

Logs the provided message with a 'LOG_INFO' status

Parameters:

message - A string containing the message to be logged

debug

public static void debug(java.lang.String message)

Logs the provided message with a 'LOG_DEBUG' status

Parameters:

message - A string containing the message to be logged

message

public static void message(CrmLog.ErrorLevel level,
                           java.lang.String message)

Logs the provided message with the provided status level

Parameters:

level - The CrmLog.ErrorLevel describing the severity of the message to be logged

message - A string containing the message to be logged

exception

public static void exception(CrmLog.ErrorLevel level,
                             java.lang.String message,
                             java.lang.Exception e)

An Exception handling method used by all classes within the CRM package to log and display the particulars of an exception reported within the CRM system.

Parameters:

level - The CrmLog.ErrorLevel for the Exception

mesasge - A String message describing the Exception over and above what is provided within the Exception itself

e - The Exception