com.goldencode.p2j.util

Interface LegacyLogManager

All Superinterfaces:

CommonHandle, InstantiatingProcedure, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon, LegacyDsLogManager

All Known Implementing Classes:

LegacyDsLogManagerImpl, LegacyLogManagerImpl

public interface LegacyLogManager
extends CommonHandle, InstantiatingProcedure, PseudoWidget

Exposes the following methods or attributes from the LOG-MANAGER system handles:

Attribute or Method	API
ENTRY-TYPES-LIST	getEntryTypesList()
LOG-ENTRY-TYPES	getLogEntryTypes(), setLogEntryTypes(character)
LOGFILE-NAME	getLogFileName(), setLogFileName(character)
LOGGING-LEVEL	getLoggingLevel(), setLoggingLevel(integer)
LOG-THRESHOLD	getLogThreshold()
NUM-LOG-FILES	getNumLogFiles()
CLEAR-LOG()	clearLog()
CLOSE-LOG()	closeLog()
WRITE-MESSAGE()	writeMessage(character), writeMessage(character, character)

This interface is used as a returned type by the handle.unwrapLogManager() API, which, depending on the handle's state, it either returns an LegacyLogManager instance or a dynamic proxy using handle.invalidAttrAccessProxy.

Method Summary

Modifier and Type	Method and Description
logical	clearLog() Deletes all messages from the currently open log file or deletes all log files in the sequence if rotation is enabled.
logical	close(boolean isProcedureCall, boolean closeWriteExecutor) Closes the currently open log file.
logical	closeLog() Closes the currently open log file.
character	getEntryTypesList() Provides the comma-separated list of currently valid entry types that can be assigned to the setLogEntryTypes(java.lang.String).
character	getLogEntryTypes() Provides the comma-separated list of entry types that are being actively used for logging.
character	getLogFileName() Obtains the file path to which log entries and stack traces are written.
integer	getLoggingLevel() Obtains the default logging level for all logging categories.
integer	getLogThreshold() Obtains the configured log file size in bytes at which the log file will be renamed and a new log file started.
integer	getNumLogFiles() Obtains the configured number of log files that will be stored in total (including both backed up log files and the current log).
void	initialize(LegacyLogManagerConfigs configs) Sets configs coming from command line.
void	setLogEntryTypes(character types) Modifies the list of log entry types that are being actively used for logging.
void	setLogEntryTypes(java.lang.String types) Modifies the list of log entry types that are being actively used for logging.
void	setLogFileName(character logFile) Assigns the file path to which log entries and stack traces are written.
void	setLogFileName(java.lang.String logFile) Assigns the file path to which log entries and stack traces are written.
void	setLoggingLevel(int level) Assigns the default logging level for all logging categories.
void	setLoggingLevel(integer level) Assigns the default logging level for all logging categories.
logical	writeMessage(character msg) Write a user defined message to the currently open log file using the default subsystem name "APPL".
logical	writeMessage(character msg, character subsys) Write a user defined message to the currently open log file using the given subsystem name.
logical	writeMessage(character msg, java.lang.String subsys) Write a user defined message to the currently open log file using the given subsystem name.
logical	writeMessage(java.lang.String msg) Write a user defined message to the currently open log file using the default subsystem name "APPL".
logical	writeMessage(java.lang.String msg, character subsys) Write a user defined message to the currently open log file using the given subsystem name.
logical	writeMessage(java.lang.String msg, java.lang.String subsys) Write a user defined message to the currently open log file using the given subsystem name.
logical	writeMessage(java.lang.String msg, java.lang.String subsys, java.lang.String[] callStack, int logLevel, long threadId) Write an automated message to the currently open log file using the given subsystem name.

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.InstantiatingProcedure

instantiatingProcedure

Method Detail

initialize

void initialize(LegacyLogManagerConfigs configs)

Sets configs coming from command line.

Parameters:

configs - Configs.

getEntryTypesList

character getEntryTypesList()

Provides the comma-separated list of currently valid entry types that can be assigned to the setLogEntryTypes(java.lang.String).

Returns:

The list of valid log entry types.

getLogEntryTypes

character getLogEntryTypes()

Provides the comma-separated list of entry types that are being actively used for logging.

Returns:

The list of active log entry types.

setLogEntryTypes

void setLogEntryTypes(java.lang.String types)

Modifies the list of log entry types that are being actively used for logging.

Parameters:

types - The comma-separated list of active entry types.

setLogEntryTypes

void setLogEntryTypes(character types)

Modifies the list of log entry types that are being actively used for logging.

Parameters:

types - The comma-separated list of active entry types.

getLogFileName

character getLogFileName()

Obtains the file path to which log entries and stack traces are written.

Returns:

The file path.

setLogFileName

void setLogFileName(java.lang.String logFile)

Assigns the file path to which log entries and stack traces are written.

Parameters:

logFile - The log file path.

setLogFileName

void setLogFileName(character logFile)

Assigns the file path to which log entries and stack traces are written.

Parameters:

logFile - The log file path.

getLoggingLevel

integer getLoggingLevel()

Obtains the default logging level for all logging categories.

Returns:

The logging level.

setLoggingLevel

void setLoggingLevel(int level)

Assigns the default logging level for all logging categories.

There are 5 valid levels:

• 0 - no logging
• 1 - only errors
• 2 - basic, each entry type determines its own output but all types will generate some output
• 3 - verbose
• 4 - extended

Parameters:

level - The logging level to use by default.

setLoggingLevel

void setLoggingLevel(integer level)

Assigns the default logging level for all logging categories.

There are 5 valid levels:

• 0 - no logging
• 1 - only errors
• 2 - basic, each entry type determines its own output but all types will generate some output
• 3 - verbose
• 4 - extended

Parameters:

level - The logging level to use by default.

getLogThreshold

integer getLogThreshold()

Obtains the configured log file size in bytes at which the log file will be renamed and a new log file started.

Returns:

The maximum log file size.

getNumLogFiles

integer getNumLogFiles()

Obtains the configured number of log files that will be stored in total (including both backed up log files and the current log).

Returns:

The maximum number of log files.

clearLog

logical clearLog()

Deletes all messages from the currently open log file or deletes all log files in the sequence if rotation is enabled. At the end of the operation a new log file is open and system messages showing LOG-MANAGER configs are printed.

Returns:

true if the operation succeeded, or false otherwise.

closeLog

logical closeLog()

Closes the currently open log file. Additional logging will not be possible after this operation.

This method should not be used as a manual call, but only automatically from procedure execution. Use close(boolean, boolean) instead.

Returns:

true if the operation succeeded, or false otherwise.

close

logical close(boolean isProcedureCall,
              boolean closeWriteExecutor)

Closes the currently open log file. Additional logging will not be possible after this operation.

Parameters:

isProcedureCall - Flag to identify the method is called by the execution of a converted 4GL procedure.

closeWriteExecutor - Flag to identify the manager is not going to use write executor any more. In case of file being rotated or clearLog() called, this should be false.

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(java.lang.String msg)

Write a user defined message to the currently open log file using the default subsystem name "APPL".

Parameters:

msg - The message to write.

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(character msg)

Write a user defined message to the currently open log file using the default subsystem name "APPL".

Parameters:

msg - The message to write.

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(java.lang.String msg,
                     java.lang.String subsys)

Write a user defined message to the currently open log file using the given subsystem name.

Parameters:

msg - The message to write.

subsys - Subsystem name (up to 10 characters will be used).

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(character msg,
                     java.lang.String subsys)

Write a user defined message to the currently open log file using the given subsystem name.

Parameters:

msg - The message to write.

subsys - Subsystem name (up to 10 characters will be used).

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(java.lang.String msg,
                     character subsys)

Write a user defined message to the currently open log file using the given subsystem name.

Parameters:

msg - The message to write.

subsys - Subsystem name (up to 10 characters will be used).

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(character msg,
                     character subsys)

Write a user defined message to the currently open log file using the given subsystem name.

Returns:

true if the operation succeeded, or false otherwise.

writeMessage

logical writeMessage(java.lang.String msg,
                     java.lang.String subsys,
                     java.lang.String[] callStack,
                     int logLevel,
                     long threadId)

Write an automated message to the currently open log file using the given subsystem name.

Parameters:

msg - The message to write.

subsys - Subsystem name (up to 10 characters will be used).

callStack - The call stack.

logLevel - The log level.

threadId - The client thread id or server thread id for AppServer and WebSpeed.

Returns:

true if the operation succeeded, or false otherwise.