Namespace: OpenEdge.Logging.Writer
Class
FileLogWriterBuilder
Parent classes:
Inherits: OpenEdge.Logging.Filter.LogFilterBuilder

Copyright (c) 2016-2019 by Progress Software Corporation. All rights reserved.
File:FileLogFilterBuilder
Purpose:Builds a (named) file logger
Author(s):pjudge
Created:2016-11-14
Notes:* Token substitutions are allowed for file names
the token format is ${<token>}, where
token = group "." arg




Method Summary
Options Name Purpose
OpenEdge.Logging.Filter.LogFilterBuilder Append (logical) /** Indicates whether to append to the log @param character The filename to write to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
LOGICAL AppendArrayCharacterValue (character, character) /** Appends a character value to an array (convenience) @param character The option name @param character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Build (character) /** Returns log writer build for a logging type @param character The Filter type for which to build the logger @return LogFilterBuilder The entity writer builder to use */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Build (character, BuilderRegistry) /** Returns log writer build for a logging type. To find a filter builder, i. Look in the registry for the filter type. If not found, ii. Look for the default ('*') builder in the registry. If not found, iii. Use this type (LogFilterBuilder) @param character The Filter type for which to build the logger @param BuilderRegistry A registry of Filter writers to user @return LogFilterBuilder The entity writer builder to use */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Build (Class) /** Returns log writer build for a logging type @param P.L.Class The Filter type for which to build the logger @return LogFilterBuilder The entity writer builder to use */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
ClearOptions () /** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL FindConfigRecord (buffer, character) /** Internal helper method to perform the find. This method attempts to find a record using the input buffer. @param buffer The buffer of the ConfigOption table. @param character The config name @return logical True if a config record was found. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Logging.Filter.LogFilterBuilder FormatAs (character) /** Sets a format string for a filter @param character The filename to write to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder FromRegistry (BuilderRegistry) /** Sets the logging level for the logger @param BuilderRegistry The registry containing the map of log writers @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Progress.Lang.Class GetFilterType (character) /** Returns a filter writer from a registry; either the optional one set via loggerFilterRegistry or the default LoggerFilterRegistry:Registry. It's the caller's responsibility to invoke and use the filter type returned. @return Progress.Lang.Class The type of the filter writer. */
Overrides OpenEdge.Logging.Filter.LogFilterBuilder:GetFilterType (character)
DATETIME-TZ GetOptionDateTimeValue (character) /** Returns an option's datetime value @param character The option name @return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL GetOptionLogicalValue (character) /** Returns an option's logical value @param character The option name @return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LONGCHAR GetOptionLongcharValue (character) /** Returns an option's longchar value @param character The option name @return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DECIMAL GetOptionNumericValue (character) /** Returns an option's decimal value @param character The option name @return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
Object GetOptionObjectValue (character) /** Returns an option's object value @param character The option name @return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringArrayValue (character) /** Returns an option's character array value @param character The option name @return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringValue (character) /** Returns an option's character value @param character The option name @return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL HasOption (character) /** Checks whether a config option already exists @param character The option name @return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Logging.Filter.ILoggerFilter NewFilter () /* Creates the instance. @return ILoggerFilter A filter instance */
Overrides OpenEdge.Logging.Filter.LogFilterBuilder:NewFilter ()
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, character) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param character The value of the option (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, decimal) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param decimal The value of the option (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, int64) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param int64 The value of the option (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, logical) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param logical The value of the option (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, Object) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param Object The value of the option (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder Options (JsonObject) /** Adds or overwrites an option for the logger filter. @param JsonObject The Filter options (can be anything) @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character[]) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, datetime-tz) /** Stores a datetime-tzvalue as an option @param character The option name @param datetime-tz the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, decimal) /** Stores an numeric value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, logical) /** Stores a logical value as an option @param character The option name @param logical the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, Object) /** Stores an object value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (Class, Object) /** Stores an object value as an option @param Progress.Lang>Class The option name (as a type) @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (character) /** Sets the output destination @param character The filename to write to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (FileOutputStream) /** Sets the output destination @param FileOutputStream The filename to write to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (JsonArray) /** Sets the output destination @param JsonArray The object to write into to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (OutputStream) /** Sets the output destination @param OutputStream The filename to write to @return LogFilterBuilder This builder object. */
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder

Constructor Summary
Options Name Purpose
FileLogWriterBuilder (character) /* Constructor */

Property Summary
Options Name Purpose
OpenEdge.Logging.Filter.ILoggerFilter Filter
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
CHARACTER FilterType
Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
CHARACTER illegalChars


Method Detail
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Append (logical)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Indicates whether to append to the log
Parameters:
plAppendToLog LOGICAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PROTECTED LOGICAL AppendArrayCharacterValue (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Appends a character value to an array (convenience)
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Build (character)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Returns log writer build for a logging type
Parameters:
pcFilterType CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Build (character, BuilderRegistry)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Returns log writer build for a logging type.
To find a filter builder,
i. Look in the registry for the filter type. If not found,
ii. Look for the default ('*') builder in the registry. If not found,
iii. Use this type (LogFilterBuilder)
Parameters:
pcFilterType CHARACTER
poWriters BuilderRegistry
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Build (Class)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Returns log writer build for a logging type
Parameters:
pfilterType Progress.Lang.Class
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

PROTECTED ClearOptions ()

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Clears all options for this builder
Top

PROTECTED LOGICAL FindConfigRecord (buffer, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
Parameters:
pConfig buffer
pName CHARACTER
Returns LOGICAL
logical True if a config record was found.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder FormatAs (character)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets a format string for a filter
Parameters:
pcFormat CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder FromRegistry (BuilderRegistry)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets the logging level for the logger
Parameters:
poLoggerFilterRegistry BuilderRegistry
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PROTECTED Progress.Lang.Class GetFilterType (character)

Overrides OpenEdge.Logging.Filter.LogFilterBuilder:GetFilterType (character)
Purpose: Returns a filter writer from a registry; either the optional one set via loggerFilterRegistry or
the default LoggerFilterRegistry:Registry. It's the caller's responsibility to invoke and
use the filter type returned.
Parameters:
filterTypeName CHARACTER
Returns Progress.Lang.Class
Progress.Lang.Class The type of the filter writer.
Top

PROTECTED DATETIME-TZ GetOptionDateTimeValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's datetime value
Parameters:
pcName CHARACTER
Returns DATETIME-TZ
datetime-tz the value
Top

PROTECTED LOGICAL GetOptionLogicalValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's logical value
Parameters:
pcName CHARACTER
Returns LOGICAL
logical the value
Top

PROTECTED LONGCHAR GetOptionLongcharValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's longchar value
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar the value
Top

PROTECTED DECIMAL GetOptionNumericValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's decimal value
Parameters:
pcName CHARACTER
Returns DECIMAL
decimal the value
Top

PROTECTED Object GetOptionObjectValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns Object
Object the value
Top

PROTECTED CHARACTER GetOptionStringArrayValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character array value
Parameters:
pcName CHARACTER
Returns CHARACTER
character[] the value
Top

PROTECTED CHARACTER GetOptionStringValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value
Top

PROTECTED LOGICAL HasOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Checks whether a config option already exists
Parameters:
pcConfigName CHARACTER
Returns LOGICAL
logical True if the named configuration option exists
Top

PROTECTED OpenEdge.Logging.Filter.ILoggerFilter NewFilter ()

Overrides OpenEdge.Logging.Filter.LogFilterBuilder:NewFilter ()
/* Creates the instance.
Returns OpenEdge.Logging.Filter.ILoggerFilter
ILoggerFilter A filter instance
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Option (character, character)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Option (character, decimal)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue DECIMAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Option (character, int64)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue INT64
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Option (character, logical)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue LOGICAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Option (character, Object)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue Object
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder Options (JsonObject)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Adds or overwrites an option for the logger filter.
Parameters:
poValue Progress.Json.ObjectModel.JsonObject
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PROTECTED LOGICAL RemoveOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Removes an option
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PROTECTED LOGICAL SetOption (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, character[])

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, datetime-tz)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a datetime-tzvalue as an option
Parameters:
pcName CHARACTER
ptValue DATETIME-TZ
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, decimal)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an numeric value as an option
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, logical)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a logical value as an option
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pcName CHARACTER
poValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (Class, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pName Progress.Lang.Class
pValue Object
Returns LOGICAL
logical True is the option was overwritten
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (character)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets the output destination
Parameters:
pcLogFile CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (FileOutputStream)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets the output destination
Parameters:
poLogFile Progress.IO.FileOutputStream
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (JsonArray)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets the output destination
Parameters:
pLog JsonArray
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

PUBLIC OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (OutputStream)

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Purpose: Sets the output destination
Parameters:
poOutput OutputStream
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.


Constructor Detail
Top

PUBLIC FileLogWriterBuilder (character)

/* Constructor
Parameters:
filterName CHARACTER


Property Detail
Top

PUBLIC OpenEdge.Logging.Filter.ILoggerFilter Filter

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Returns OpenEdge.Logging.Filter.ILoggerFilter
Top

PUBLIC CHARACTER FilterType

Inherited from OpenEdge.Logging.Filter.LogFilterBuilder
Returns CHARACTER
Top

PROTECTED CHARACTER illegalChars

Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0