Namespace: OpenEdge.Logging
Type: Class Logger
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object
Implements: OpenEdge.Logging.ILogWriter, OpenEdge.Logging.Format.ISupportFormatting


/* *************************************************************************************************************************
Copyright (c) 2016-2017, 2019 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:Logger
Purpose:Public logger implementation
Author(s):pjudge
Created:2016-11-10
Notes:* This implementation is the only implementation of the ILogWriter.
It acts as a facade to a ILoggerImplementation which may be
a single type or a facade/decorator or filter chain.



Method Summary
  Options Name Purpose
  Debug (character) /* Log for a simple message @param character The message to log. */
  Debug (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Debug (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Debug (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Debug (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Debug (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  LOGICAL Equals (Object) /* Compares two instances Loggers are equal iff - they have the same obejct reference ('handle'), or - they are both instances of OpenEdge.Logging.Logger and the Name property value is identical on both (= match) @param P.L.Object @return logical TRUE if these are the same logger object */
  Error (character) /* Log for a simple message @param character The message to log. */
  Error (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Error (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Error (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Error (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Error (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  ExtractMessageTokens (LogMessage) /* Extracts tokens from the message text and adds them to the message's context. @param LogMessage The current message to parse */
  Fatal (character) /* Log for a simple message @param character The message to log. */
  Fatal (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Fatal (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Fatal (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Fatal (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Fatal (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  Info (character) /* Log for a simple message @param character The message to log. */
  Info (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Info (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Info (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Info (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Info (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  Trace (character) /* Log for a simple message @param character The message to log. */
  Trace (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Trace (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Trace (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Trace (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Trace (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  Warn (character) /* Log for a simple message @param character The message to log. */
  Warn (character, character) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. */
  Warn (character, character, Error) /* Log for a group and a simple message @param character The message group for this message @param character The message to log. @param Progress.Lang.Error An error to log */
  Warn (character, Error) /* Log for a simple message @param character The message to log. @param Progress.Lang.Error An error to log */
  Warn (LogMessage) /* Log for a simple message @param LogMessage The message to log. */
  Warn (LogMessage, Error) /* Log for a message and error @param LogMessage The message to log. @param Progress.Lang.Error An error to log */
  WriteMessage (LogLevelEnum, LogMessage, Error) /* Writes a log message @param LogMessage the message to be written */

Constructor Summary
  Options Name Purpose
  Logger (character, LogLevelEnum, ILoggerFilter[]) /* Constructor @param character The name of this logger implementation @param LogLevelEnum The level we're logging at @param LoggerFilterList A list of filters to format and write the log data */
  Logger (character, LogLevelEnum, LoggerFilterList) /* Constructor --- USE FOR BACKWARDS COMPATIBILITLY ONLY --- @param character The name of this logger implementation @param LogLevelEnum The level we're logging at @param LoggerFilterList A list of filters to format and write the log data */

Property Summary
  Options Name Purpose
  CHARACTER Format
  OpenEdge.Logging.Filter.ILoggerFilter LogFilters
  OpenEdge.Logging.LogLevelEnum LogLevel
  CHARACTER Name
  CHARACTER ShortName


Method Detail
Top

Debug (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Debug (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Debug (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Debug (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Debug (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Debug (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

LOGICAL Equals (Object)

/* Compares two instances
Loggers are equal iff
- they have the same obejct reference ('handle'), or
- they are both instances of OpenEdge.Logging.Logger and
the Name property value is identical on both (= match)
Parameters:
poRef Progress.Lang.Object
 
Returns LOGICAL
  logical TRUE if these are the same logger object
Top

Error (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Error (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Error (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Error (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Error (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Error (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

ExtractMessageTokens (LogMessage)

/* Extracts tokens from the message text and adds them to the message's context.
Parameters:
pMessage OpenEdge.Logging.LogMessage
 
Top

Fatal (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Fatal (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Fatal (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Fatal (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Fatal (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Fatal (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

Info (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Info (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Info (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Info (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Info (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Info (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

Trace (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Trace (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Trace (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Trace (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Trace (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Trace (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

Warn (character)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
Top

Warn (character, character)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
Top

Warn (character, character, Error)

/* Log for a group and a simple message
Parameters:
pcMessageGroup CHARACTER
 
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Warn (character, Error)

/* Log for a simple message
Parameters:
pcMessage CHARACTER
 
poError Progress.Lang.Error
 
Top

Warn (LogMessage)

/* Log for a simple message
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
Top

Warn (LogMessage, Error)

/* Log for a message and error
Parameters:
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 
Top

WriteMessage (LogLevelEnum, LogMessage, Error)

/* Writes a log message
Parameters:
poLogLevel OpenEdge.Logging.LogLevelEnum
 
poMessage OpenEdge.Logging.LogMessage
 
poError Progress.Lang.Error
 


Constructor Detail
Top

Logger (character, LogLevelEnum, ILoggerFilter[])

/* Constructor
Parameters:
pcName CHARACTER
 
poLevel OpenEdge.Logging.LogLevelEnum
 
poLogFilters OpenEdge.Logging.Filter.ILoggerFilter
 
Top

Logger (character, LogLevelEnum, LoggerFilterList)

/* Constructor
Parameters:
pcName CHARACTER
 
poLevel OpenEdge.Logging.LogLevelEnum
 
poLogFilters OpenEdge.Logging.Filter.LoggerFilterList
 


Property Detail
Top

CHARACTER Format

Returns CHARACTER
 
Top

OpenEdge.Logging.Filter.ILoggerFilter LogFilters

Returns OpenEdge.Logging.Filter.ILoggerFilter
 
Top

OpenEdge.Logging.LogLevelEnum LogLevel

Returns OpenEdge.Logging.LogLevelEnum
 
Top

CHARACTER Name

Returns CHARACTER
 
Top

CHARACTER ShortName

Returns CHARACTER