Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

Table of Contents

OpenEdge.Logging.LoggerBuilder

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 15, 2026
  • 6 minute read
    • OpenEdge
    • Version 12.8
    • Documentation
Namespace: OpenEdge.Logging
Type: Class LoggerBuilder
Parent Classes:
Progress.Lang.Object
OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Logging.LoggerBuilder

Inherits: OpenEdge.Core.Util.ConfigBuilder

Copyright (c) 2016-2021 by Progress Software Corporation. All rights reserved.
File:LoggerBuilder
Purpose:A factory for creating loggers
Author(s):pjudge
Created:Wed Nov 16 21:43:11 EST 2016
/* Private variable with the enum (int64) vaues in the OpenEdge.Logging.LogLevelEnum type. Used
when we get the default log-manager-based logger



Method Summary
  Options Name Purpose
  OpenEdge.Logging.LoggerBuilder AddFilter (character) /* Adds a filter to the logger being built @param character The filter name to add @return LoggerBuilder This builder object */
  OpenEdge.Logging.LoggerBuilder AddFilter (character, JsonObject) /* Adds a filter to the logger being built, with options in Json form @param character The filter name to add @param JsonObject The filter options @return LoggerBuilder This builder object */
  OpenEdge.Logging.LoggerBuilder AddFilter (ILoggerFilter) /* Adds a filter to the logger being built @param ILoggerFilter The filter to add @return LoggerBuilder This builder object */
  OpenEdge.Logging.LoggerBuilder Build (character) /* Returns a builder for a logger @param character The logger type @return LoggerBuilder A builder for that logger */
  OpenEdge.Logging.LoggerBuilder Build (character, BuilderRegistry) /* Returns a builder for a logger @param character The logger type @param BuilderRegistry A registry of Filter writers to user @return LoggerBuilder A builder for that logger */
  OpenEdge.Logging.ILogWriter BuildFilterLogger () /* Creates a default logger based that uses the config in this class @return ILogWriter A logger */
  CacheInstance (character, ILogWriter) /* Caches a logger instance for a logger name @param character The logger name @param ILogWriter The logger instance */
  ClearCache () /* Clears/empties the cache of logger instances */
  ClearExternalBuild (character) /* This method removes the logger being built if the builder-methods are called externally (in user code). If they are called internally, then @param character The method being checked: AddFilter and LogAt */
  LOGICAL FindLoggerInstance (buffer, character) /* Helper method to find the correct logger records @param buffer The Logger temp-table buffer @param character The logger name @return logical TRUE if a record for the logger can be found, FALSE otherwise */
  OpenEdge.Logging.LoggerBuilder FromConfig (JsonObject) /* Adds JSON configuration for loggers, filters and builders @param JsonObject The JSON configuration for a logger @return LoggerBuilder This builder object */
  OpenEdge.Logging.ILogWriter GetCachedInstance (character) /* Returns a cached logger instance. @param character The logger name @param ILogWriter An instance of ILogWriter for the given logger, or UNKNOWN if not cached */
  OpenEdge.Logging.ILogWriter GetLogger (character) /** Returns a logger (ILogWriter) @param character The logger name @return ILogWriter An instance of the default logger */
  OpenEdge.Logging.ILogWriter GetLogger (handle) /** Returns a logger (ILogWriter). @param handle The procedure for which to find a logger @return ILogWriter An instance of the default logger */
  OpenEdge.Logging.ILogWriter GetLogger (Class) /** Returns a logger (ILogWriter). @param P.L.Class The typename for which to find a logger @return ILogWriter An instance of the default logger */
  OpenEdge.Logging.ILogWriter GetLoggerInstance () /* Constructs the actual logger instance @return ILogWriter A new or cached logged */
  LOGICAL IsCached (character) /* Indicates whether a cached instance of a logger exists. @param character The logger name @return logical TRUE if there's a valid instance of ILogWriter for the given logger name */
  OpenEdge.Logging.LoggerBuilder LogAt (LogLevelEnum) /* Sets the log level for this logger. @param LogLevelEnum the level to log at @return LoggerBuilder This builder object */
  LogMessage (character, LogLevelEnum) /* Logs error/messages that are written before a logger instance is successfully built. ONLY for use by the LoggerBuilder, Logger and other classes in this package(hence PACKAGE-PROTECTED). This is intentionally a very primitive log writer. Messages are written to the first location found by the algorithm below 1. If a log-manager exists, write there. This will always be the case on a server (PASOE or Classic A/S & WS) 2. The session's temp-dir in a file called loggerbuilder.log Messages are APPENDED to the output file @param character The message to write @param LogLevelEnum The level of the message */
  LOGICAL RemoveFromCache (character) /* Removes an instance record for a logger. Does not do anything to the logger itself (since it may be in use) @param character The logger name @return logical TRUE if the instance record was removed */
  LOGICAL RemoveGroupFromCache (character) /* Removes a group of loggers from the cache. This is for cases where we know the group / partial name but not the individual loggers that share that config. The group name has a '.' appended to try to enfore the 'groupness', and not delete any individual cached loggers @param character The logger group name. @return logical TRUE if the any logger instance records were removed */

Constructor Summary
  Options Name Purpose
  LoggerBuilder () /* Static constructor */
  LoggerBuilder (character) /* Constructor @param character The logger type being built */

Property Summary
  Options Name Purpose
  CHARACTER DefaultLogger
  OpenEdge.Logging.ILogWriter Logger
  CHARACTER LoggerType
  OpenEdge.Core.Util.BuilderRegistry Registry


Method Detail
Top

OpenEdge.Logging.LoggerBuilder AddFilter (character)

/* Adds a filter to the logger being built
Parameters:
pcFilterName CHARACTER
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder This builder object
Top

OpenEdge.Logging.LoggerBuilder AddFilter (character, JsonObject)

/* Adds a filter to the logger being built, with options in Json form
Parameters:
pFilterName CHARACTER
 
pFilterOptions Progress.Json.ObjectModel.JsonObject
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder This builder object
Top

OpenEdge.Logging.LoggerBuilder AddFilter (ILoggerFilter)

/* Adds a filter to the logger being built
Parameters:
pFilter OpenEdge.Logging.Filter.ILoggerFilter
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder This builder object
Top

OpenEdge.Logging.LoggerBuilder Build (character)

/* Returns a builder for a logger
Parameters:
pcLoggerType CHARACTER
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder A builder for that logger
Top

OpenEdge.Logging.LoggerBuilder Build (character, BuilderRegistry)

/* Returns a builder for a logger
Parameters:
pcLoggerType CHARACTER
 
poBuilders OpenEdge.Core.Util.BuilderRegistry
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder A builder for that logger
Top

OpenEdge.Logging.ILogWriter BuildFilterLogger ()

/* Creates a default logger based that uses the config in this class
Returns OpenEdge.Logging.ILogWriter
  ILogWriter A logger
Top

CacheInstance (character, ILogWriter)

/* Caches a logger instance for a logger name
Parameters:
pLoggerName CHARACTER
 
pLogger OpenEdge.Logging.ILogWriter
 
Top

ClearCache ()

/* Clears/empties the cache of logger instances
Top

ClearExternalBuild (character)

/* This method removes the logger being built if the builder-methods are
called externally (in user code). If they are called internally, then
Parameters:
pMethodName CHARACTER
 
Top

LOGICAL FindLoggerInstance (buffer, character)

/* Helper method to find the correct logger records
Parameters:
pLogger buffer
 
pLoggerName CHARACTER
 
Returns LOGICAL
  logical TRUE if a record for the logger can be found, FALSE otherwise
Top

OpenEdge.Logging.LoggerBuilder FromConfig (JsonObject)

/* Adds JSON configuration for loggers, filters and builders
Parameters:
pJsonConfig Progress.Json.ObjectModel.JsonObject
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder This builder object
Top

OpenEdge.Logging.ILogWriter GetCachedInstance (character)

/* Returns a cached logger instance.
Parameters:
pLoggerName CHARACTER
 
Returns OpenEdge.Logging.ILogWriter
 
Top

OpenEdge.Logging.ILogWriter GetLogger (character)

Purpose: Returns a logger (ILogWriter)
Parameters:
pcLoggerType CHARACTER
 
Returns OpenEdge.Logging.ILogWriter
  ILogWriter An instance of the default logger
Top

OpenEdge.Logging.ILogWriter GetLogger (handle)

Purpose: Returns a logger (ILogWriter).
Parameters:
pLoggerType HANDLE
 
Returns OpenEdge.Logging.ILogWriter
  ILogWriter An instance of the default logger
Top

OpenEdge.Logging.ILogWriter GetLogger (Class)

Purpose: Returns a logger (ILogWriter).
Parameters:
poLoggerType Progress.Lang.Class
 
Returns OpenEdge.Logging.ILogWriter
  ILogWriter An instance of the default logger
Top

OpenEdge.Logging.ILogWriter GetLoggerInstance ()

/* Constructs the actual logger instance
Returns OpenEdge.Logging.ILogWriter
  ILogWriter A new or cached logged
Top

LOGICAL IsCached (character)

/* Indicates whether a cached instance of a logger exists.
Parameters:
pLoggerName CHARACTER
 
Returns LOGICAL
  logical TRUE if there's a valid instance of ILogWriter for the given logger name
Top

OpenEdge.Logging.LoggerBuilder LogAt (LogLevelEnum)

/* Sets the log level for this logger.
Parameters:
poLevel OpenEdge.Logging.LogLevelEnum
 
Returns OpenEdge.Logging.LoggerBuilder
  LoggerBuilder This builder object
Top

LogMessage (character, LogLevelEnum)

/* Logs error/messages that are written before a logger instance is successfully built.
ONLY for use by the LoggerBuilder, Logger and other classes in this package(hence PACKAGE-PROTECTED).
This is intentionally a very primitive log writer.
Messages are written to the first location found by the algorithm below
1. If a log-manager exists, write there. This will always be the case on a server (PASOE or Classic A/S & WS)
2. The session's temp-dir in a file called loggerbuilder.log
Messages are APPENDED to the output file
Parameters:
pMessage CHARACTER
 
pLevel OpenEdge.Logging.LogLevelEnum
 
Top

LOGICAL RemoveFromCache (character)

/* Removes an instance record for a logger. Does not do anything to the logger itself (since it may
be in use)
Parameters:
pLoggerName CHARACTER
 
Returns LOGICAL
  logical TRUE if the instance record was removed
Top

LOGICAL RemoveGroupFromCache (character)

/* Removes a group of loggers from the cache. This is for cases where we know the group / partial name
but not the individual loggers that share that config.
The group name has a '.' appended to try to enfore the 'groupness', and not delete any individual cached loggers
Parameters:
pLoggerName CHARACTER
 
Returns LOGICAL
  logical TRUE if the any logger instance records were removed


Constructor Detail
Top

STATIC LoggerBuilder ()

/* Static constructor
Top

LoggerBuilder (character)

/* Constructor
Parameters:
pcLoggerType CHARACTER
 


Property Detail
Top

CHARACTER DefaultLogger

Returns CHARACTER
 
Top

OpenEdge.Logging.ILogWriter Logger
Top

CHARACTER LoggerType

Returns CHARACTER
 
Top

OpenEdge.Core.Util.BuilderRegistry Registry


TitleResults for “How to create a CRG?”Also Available inAlert