|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
OpenEdge.Logging.LoggerBuilder AddFilter (ILoggerFilter)
|
/* Adds a filter to the logger being built
@param ILoggerFilter The filter to add
@return LoggerBuilder This builder object */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
AddToCache (character, ILogWriter)
|
/* Caches a logger instance for a logger name.
Checks the logger configuration as to whether the logger should be cached or not.
@param character The logger name
@param ILogWriter The logger instance */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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.LoggerBuilder Build (character)
|
/* Returns a builder for a logger
@param character The logger type
@return LoggerBuilder A builder for that logger */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
OpenEdge.Logging.ILogWriter BuildFilterLogger ()
|
/* Creates a default logger based that uses the config in this class
@return ILogWriter A logger */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
ClearCache ()
|
/* Clears/empties the cache of logger instances */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
ClearConfig ()
|
/* Clears all the current logger configurations */
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
ClearOptions ()
|
/** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Logging.ILogWriter FetchFromCache (character)
|
/* Returns a cached logger instance. If the logger should not be cached, then
the cache is not checked.
@param character The logger name
@param ILogWriter An instance of ILogWriter for the given logger, or UNKNOWN if not cached */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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.LogLevelEnum FindLevel (character)
|
/* Finds the log level for a logger to use, based on the logger type
Algorithm is
1) exact match
2) chop off the trailing .-delimited entry, repeating
3) find the logger defined as DEFAULT_LOGGER, folling steps 1 & 2
@param character The logger type to find
@return LogLevelEnum returns a log level , if any */
|
|
|
|
LOGICAL FindLogger (character, buffer)
|
/* Find a temp-table record/config for a logger to use
Algorithm is
1) exact match
2) chop off the trailing .-delimited entry, repeating
3) find the logger defined as DEFAULT_LOGGER, following steps 1 & 2
4) return a void logger (just to have a reference)
@param character The logger type to find
@param buffer A buffer reference to the logger temp-table
@return logical TRUE if a logger record was found. If TRUE, the
buffer will AVAILABLE; if false, not */
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
Progress.Lang.Class GetABLType (JsonObject, character)
|
/* Returns a type name from a property we expect to have a type. Basically resolving the
typeName / typeProperty values into an P.L.C
"definitions": {
"typeName": {
"type": "string",
"description": "An OOABL type name",
"pattern": "^[A-Za-z]+[A-Za-z$0-9-&#%.]+[A-Za-z$0-9-&#%]*$"
},
"typeProperty": {
"type": "object",
"properties": {
"type": {"$ref": "#/definitions/typeName"},
"hash": {
"type": "string",
"description": "A hash value to validate that the OOABL type is the expected version."
}
},
"required": ["type"]
},
"builderProperty": {
"oneOf": [
{"$ref": "#/definitions/typeProperty"},
{"$ref": "#/definitions/typeName"}
]
}
},
@param JsonObject The JSON containign the type property
@param character The name of the propert
@return P.L.Class A resolve ABL type name. May be unknown */
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
OpenEdge.Logging.ILogWriter GetLogger (character)
|
/** Returns a logger (ILogWriter)
@param character The logger name
@return ILogWriter An instance of the default logger */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
OpenEdge.Logging.ILogWriter GetLoggerInstance ()
|
/* Constructs the actual logger instance
@return ILogWriter A new or cached logged */
Overrides OpenEdge.Logging.LoggerBuilder:GetLoggerInstance ()
|
|
|
|
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
|
|
|
|
LOGICAL IsInCache (character)
|
/* Indicates whether a cached instance of a logger exists. If the logger should not be cached, then
returns false.
@param character The logger name
@return logical TRUE if there's a valid instance of ILogWriter for the given logger name */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
LoadConfig (JsonObject)
|
/* Loads logging configuration from JSON. Is an ADDITIVE operation - existing
config is not cleared. To remove existing config, call the ClearConfig()
static method.
@param JsonObject JSON representation of the lgging configuration */
|
|
|
|
OpenEdge.Logging.LoggerBuilder LogAt (LogLevelEnum)
|
/* Sets the log level for this logger.
@param LogLevelEnum the level to log at
@return LoggerBuilder This builder object */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
LogMessage (character, LogLevelEnum)
|
/* Logs error/messages that are written before a logger instance is successfully built.
ONLY for use by the LoggerBuilder (hence 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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
OpenEdge.Logging.LogLevelEnum LogMgrLevelToEnum (integer)
|
/* Returns an enum representing the current LOG-MANAGER LOGGING-LEVEL
@param integer The logging level
@return LogLevelEnum An enum value representing the logging level. If the input
is <0 or ?, the then default value is returned. If the input value is > the enumerated value,
then return the highest value */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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 */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
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.LoggerBuilder UseInstanceCache (logical)
|
/* Adds JSON configuration for loggers, filters and builders
@param logical TRUE if the cache is to be used
@return LoggerBuilder This builder object */
Inherited from OpenEdge.Logging.LoggerBuilder
|
|
|
|
ValidateFilter (character, character)
|
/* Ensures that a Filter type is the one we were expecting.
@param character (mandatory) The ABL Filter name used to process the event
@param character (optional) A hash used to verify the Filter's authenticity
@throws AppError If a hash is passed and the Filter type's hash does not match */
|