LegacyLogManagerImpl (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.LegacyLogManagerImpl

All Implemented Interfaces:

CommonHandle, Deletable, InstantiatingProcedure, LegacyLogManager, PseudoWidget, WrappedResource, Printable

Direct Known Subclasses:

LegacyDsLogManagerImpl
```
public class LegacyLogManagerImpl
extends HandleResource
implements LegacyLogManager
```
Implementation for the LOG-MANAGER system handle.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static interface`	`LegacyLogManagerImpl.FileName` Interface to unite all implementations in returning common file name attributes - file name prefix (clean name without number sequence or extension) and extension.
`private static class`	`LegacyLogManagerImpl.GenericFileName` A class for generic file names.
`static class`	`LegacyLogManagerImpl.LoggingLevel` Enumeration to list most commonly used logging entry types.
`private static class`	`LegacyLogManagerImpl.SequencedFileName` A parser for log file names including a sequence number for rotation.
`private static class`	`LegacyLogManagerImpl.SequencedFileNameMatcher` A matcher for log file names including certain prefix, extension and sequence number for rotation.
`static class`	`LegacyLogManagerImpl.SupportedEntryType` Enumeration to list all currently supported logging entry types.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<LegacyLogManagerImpl.SupportedEntryType,java.lang.Integer>`	`activatedTypeLevelPairs` The default entry type - logging level pairs.
`private LegacyLogManagerClientService`	`client` Client service.
`private long`	`clientProcessId` The client process id.
`private static java.text.SimpleDateFormat`	`DATETIME_FORMATTER` Formatter for date and time, used by WRITE-MESSAGE().
`private static int`	`HANDLE_CALL_LOGGING_LEVEL` Default logging level for handle execution of WRITE-MESSAGE().
`private boolean`	`isAppserver` A flag to indicate if running in an appserver.
`private java.util.concurrent.atomic.AtomicBoolean`	`isEnabled` Flag to indicate if LOG-MANAGER is enabled by configs.
`private java.util.concurrent.atomic.AtomicBoolean`	`isInitialized` A flag to indicate execution of the method initialize has completed.
`private static CentralLogger`	`LOG` A logger to write messages to server's log.
`private java.io.File`	`logFile` The log file path for clients or servers (AppServer and WebSpeed).
`private int`	`loggingLevel` The default logging level.
`private int`	`logThreshold` The default logging threshold.
`private java.io.FileWriter`	`logWriter` The file writer.
`private static int`	`MAX_LOG_FILE_THRESHOLD_BYTES` The maximum log file size threshold for roll over in bytes.
`private static int`	`MAX_NUM_LOG_FILES` The maximum number of log files for roll over.
`private int`	`maxInputCharacters` Max number of characters supported in one message.
`private static int`	`MIN_LOG_FILE_THRESHOLD_BYTES` The minimum log file size threshold for roll over in bytes.
`private static java.lang.String`	`NUMBER_REGEX` Regex to validate if a string can be parsed to a number.
`private int`	`numLogFiles` The default number of logging files.
`private java.util.concurrent.atomic.AtomicInteger`	`remoteFileSize` Counter for client-side log file size.
`private Session`	`session` Client session.
`private static java.lang.String`	`SUBSYS_APPSERVER_AGENT` Appserver subsystem code for WRITE-MESSAGE().
`private static java.lang.String`	`SUBSYS_DEFAULT` Default subsystem code for WRITE-MESSAGE().
`static java.lang.String`	`SUBSYS_EMPTY` Subsystem for log file header and error (level 1) messages.
`private static int`	`WRITE_MSG_SUBSYS_CHARS_COUNT` Number of characters of subsys column for WRITE-MESSAGE().
`private LegacyLogWriteExecutor`	`writeExecutor` A reference to the queue that handles writing log records.

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Constructor Summary

Constructors
Constructor and Description

LegacyLogManagerImpl(LegacyLogWriteExecutor writeExecutor)
Package private constructor to create an instance of a LOG-MANAGER.

Constructors
Constructor and Description
`LegacyLogManagerImpl(LegacyLogWriteExecutor writeExecutor)` Package private constructor to create an instance of a LOG-MANAGER.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) static void`	`cleanupRotation(java.io.File logFile, int numLogFiles)` Removes the sequenced log files with the same name in the same folder that exceed the max count of `numLogFiles`, while preserving the current log file and of its predecessors.
`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.
`private java.lang.String`	`createLogLine(int logLvl, java.lang.String subsys, java.lang.String msg, long threadId, java.util.Date date)` Formats the parameters to the 4GL log record format.
`private java.lang.String`	`createLogRecord(java.lang.String msg, java.lang.String subsys, java.lang.String[] callStack, int logLevel, long threadId, java.util.Date date)` Formats the input data as a log record.
`(package private) static boolean`	`deleteSequence(java.io.File logFile)` Deletes all files in the sequence in the same folder as the provided log file.
`private static int`	`findLastLogFileNumber(java.io.File dir, java.lang.String nameNoExt, java.lang.String ext)` This should reflect the 4GL logic to find the last file that has been written to.
`private static java.lang.String`	`formatFileName(LegacyLogManagerImpl.FileName fileName, int sequenceNumber)` Concatenates the file name, sequence and extension.
`private java.lang.String`	`formatSubsys(java.lang.String subsys)` Format the subsystem string.
`private static java.lang.String`	`formatSystemId(long id)` Format process or thread id.
`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)` Validates and sets configs coming from command line.
`private void`	`initialize(java.lang.String logFile, java.lang.String levelString, java.lang.String entryTypes, java.lang.Integer fileSize, java.lang.Integer numLogFiles, long clientProcessId, int maxInputCharacters, boolean isAppserver, boolean isAppServerLoggerInitialized)` Sets configs coming from command line.
`private boolean`	`isRotationEnabled()` Checks if file rotation is enabled.
`(package private) static boolean`	`isWritable(java.io.File file)` Checks if the folder exists and if the JVM process has rights to write to it.
`(package private) static java.io.File`	`makeSequencedLogFile(java.lang.String logFilePath, int logThreshold)` Adds a dot and a sequence number to the file name before the file extension.
`private static int`	`nextSequenceNumber(int lastNumber)` Get the next number in the sequence valid range.
`private void`	`recordOrShowWarning(int num, java.lang.String text, boolean prefix)` Manufacture a warning text based on the given parameters.
`private void`	`recordOrThrowError(int num, java.lang.String text, boolean prefix)` Raise an error condition and optionally record the given error.
`private void`	`resetEnabled()` Sets the isEnabled flag.
`private void`	`rotateLogFile()` Creates the next file in the sequence.
`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.
`private void`	`setLogFileName(boolean isProcedureCall, java.lang.String logFileConfig)` Assigns the file path to which log entries and stack traces are written.
`void`	`setLogFileName(character filePath)` Assigns the filename to which log entries and stack traces are written.
`void`	`setLogFileName(java.lang.String logFileConfig)` 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.
`private boolean`	`setLogThreshold(int fileSize)` Assigns the log file size threshold in bytes for rolling over to a new file.
`private boolean`	`setNumLogFiles(int numLogFiles)` Sets the number of log files that will be stored in total (including both backed up log files and the current log).
`private void`	`switchLogFile(java.io.File newLogFile)` Updates the field `logFile` for resolved path to the log File.
`boolean`	`valid()` This object is always valid for use.
`private boolean`	`writeLocal(java.lang.String logRecord)` Writes the log record to the log file server-side.
`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 from the given subsystem to the currently open log file.
`private logical`	`writeMessage(java.lang.String msg, java.lang.String subsys, java.lang.String[] callStack, int logLevel, long threadId, boolean isAutoLogging)` Write a user defined message from a handle WRITE-MESSAGE call or an automated message to the currently open log file using the given subsystem name.
`private boolean`	`writeRemote(java.lang.String logRecord, boolean isAutoLogging)` Writes the log record to the log file client-side.
`private void`	`writeSystemHeader()` Writes the system messages when a new file name is set.

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, delete, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, readOnlyError, readOnlyError, registerResource, resourceDelete, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

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

Methods inherited from interface com.goldencode.util.Printable
asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - SUBSYS_EMPTY
```
public static final java.lang.String SUBSYS_EMPTY
```
    Subsystem for log file header and error (level 1) messages.
    
    See Also:
    
    Constant Field Values
  - SUBSYS_DEFAULT
```
private static final java.lang.String SUBSYS_DEFAULT
```
    Default subsystem code for WRITE-MESSAGE().
    
    See Also:
    
    Constant Field Values
  - SUBSYS_APPSERVER_AGENT
```
private static final java.lang.String SUBSYS_APPSERVER_AGENT
```
    Appserver subsystem code for WRITE-MESSAGE().
    
    See Also:
    
    Constant Field Values
  - HANDLE_CALL_LOGGING_LEVEL
```
private static final int HANDLE_CALL_LOGGING_LEVEL
```
    Default logging level for handle execution of WRITE-MESSAGE().
  - WRITE_MSG_SUBSYS_CHARS_COUNT
```
private static final int WRITE_MSG_SUBSYS_CHARS_COUNT
```
    Number of characters of subsys column for WRITE-MESSAGE().
    
    See Also:
    
    Constant Field Values
  - DATETIME_FORMATTER
```
private static final java.text.SimpleDateFormat DATETIME_FORMATTER
```
    Formatter for date and time, used by WRITE-MESSAGE().
  - NUMBER_REGEX
```
private static final java.lang.String NUMBER_REGEX
```
    Regex to validate if a string can be parsed to a number.
    
    See Also:
    
    Constant Field Values
  - MIN_LOG_FILE_THRESHOLD_BYTES
```
private static final int MIN_LOG_FILE_THRESHOLD_BYTES
```
    The minimum log file size threshold for roll over in bytes.
    
    See Also:
    
    Constant Field Values
  - MAX_LOG_FILE_THRESHOLD_BYTES
```
private static final int MAX_LOG_FILE_THRESHOLD_BYTES
```
    The maximum log file size threshold for roll over in bytes.
    
    See Also:
    
    Constant Field Values
  - MAX_NUM_LOG_FILES
```
private static final int MAX_NUM_LOG_FILES
```
    The maximum number of log files for roll over.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final CentralLogger LOG
```
    A logger to write messages to server's log.
  - writeExecutor
```
private final LegacyLogWriteExecutor writeExecutor
```
    A reference to the queue that handles writing log records.
  - isInitialized
```
private final java.util.concurrent.atomic.AtomicBoolean isInitialized
```
    A flag to indicate execution of the method initialize has completed.
  - isEnabled
```
private java.util.concurrent.atomic.AtomicBoolean isEnabled
```
    Flag to indicate if LOG-MANAGER is enabled by configs.
  - maxInputCharacters
```
private int maxInputCharacters
```
    Max number of characters supported in one message.
  - isAppserver
```
private boolean isAppserver
```
    A flag to indicate if running in an appserver.
  - clientProcessId
```
private long clientProcessId
```
    The client process id.
  - logFile
```
private java.io.File logFile
```
    The log file path for clients or servers (AppServer and WebSpeed). Absolute path.
  - logWriter
```
private java.io.FileWriter logWriter
```
    The file writer.
  - activatedTypeLevelPairs
```
private final java.util.Map<LegacyLogManagerImpl.SupportedEntryType,java.lang.Integer> activatedTypeLevelPairs
```
    The default entry type - logging level pairs.
  - loggingLevel
```
private int loggingLevel
```
    The default logging level.
  - logThreshold
```
private int logThreshold
```
    The default logging threshold.
  - numLogFiles
```
private int numLogFiles
```
    The default number of logging files.
  - client
```
private LegacyLogManagerClientService client
```
    Client service.
  - session
```
private Session session
```
    Client session.
  - remoteFileSize
```
private java.util.concurrent.atomic.AtomicInteger remoteFileSize
```
    Counter for client-side log file size.
- Constructor Detail
  - LegacyLogManagerImpl
```
LegacyLogManagerImpl(LegacyLogWriteExecutor writeExecutor)
```
    Package private constructor to create an instance of a LOG-MANAGER.
    
    Parameters:
    
    writeExecutor - Reference to the executor that actually writes log messages.
- Method Detail
  - initialize
```
public void initialize(LegacyLogManagerConfigs configs)
```
    Validates and sets configs coming from command line.
    
    Specified by:
    
    initialize in interface LegacyLogManager
    
    Parameters:
    
    configs - Configs.
  - initialize
```
private void initialize(java.lang.String logFile,
                        java.lang.String levelString,
                        java.lang.String entryTypes,
                        java.lang.Integer fileSize,
                        java.lang.Integer numLogFiles,
                        long clientProcessId,
                        int maxInputCharacters,
                        boolean isAppserver,
                        boolean isAppServerLoggerInitialized)
```
    Sets configs coming from command line. They need to be set at once, because there are dependencies between them. The recipe for initialization requires the order of setters to be kept in a strict order.
    
    Parameters:
    
    logFile - File path for the log.
    
    levelString - Default logging level.
    
    entryTypes - List of comma-separated log entry types.
    
    fileSize - File size in bytes used as threshold for file roll over.
    
    numLogFiles - Max number of log files.
    
    clientProcessId - The id of the client process.
    
    maxInputCharacters - The max number of characters.
    
    isAppServerLoggerInitialized - A flag to indicate if the appserver logger has already been initialized in a different.
  - getEntryTypesList
```
public character getEntryTypesList()
```
    Provides the comma-separated list of currently valid entry types that can be assigned to the setLogEntryTypes(java.lang.String).
    
    Specified by:
    
    getEntryTypesList in interface LegacyLogManager
    
    Returns:
    
    The list of valid log entry types.
  - getLogEntryTypes
```
public character getLogEntryTypes()
```
    Provides the comma-separated list of entry types that are being actively used for logging.
    
    Specified by:
    
    getLogEntryTypes in interface LegacyLogManager
    
    Returns:
    
    The list of active log entry types.
  - setLogEntryTypes
```
public void setLogEntryTypes(java.lang.String types)
```
    Modifies the list of log entry types that are being actively used for logging.
    
    Specified by:
    
    setLogEntryTypes in interface LegacyLogManager
    
    Parameters:
    
    types - The comma-separated list of active entry types.
  - setLogEntryTypes
```
public void setLogEntryTypes(character types)
```
    Modifies the list of log entry types that are being actively used for logging.
    
    Specified by:
    
    setLogEntryTypes in interface LegacyLogManager
    
    Parameters:
    
    types - The comma-separated list of active entry types.
  - getLogFileName
```
public character getLogFileName()
```
    Obtains the file path to which log entries and stack traces are written.
    
    Specified by:
    
    getLogFileName in interface LegacyLogManager
    
    Returns:
    
    The log file path.
  - setLogFileName
```
public void setLogFileName(java.lang.String logFileConfig)
```
    Assigns the file path to which log entries and stack traces are written.
    
    Specified by:
    
    setLogFileName in interface LegacyLogManager
    
    Parameters:
    
    logFileConfig - The log file path.
  - setLogFileName
```
public void setLogFileName(character filePath)
```
    Assigns the filename to which log entries and stack traces are written.
    
    Specified by:
    
    setLogFileName in interface LegacyLogManager
    
    Parameters:
    
    filePath - The log file path.
  - getLoggingLevel
```
public integer getLoggingLevel()
```
    Obtains the default logging level for all logging categories.
    
    Specified by:
    
    getLoggingLevel in interface LegacyLogManager
    
    Returns:
    
    The logging level.
  - setLoggingLevel
```
public 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
    Specified by:
    
    setLoggingLevel in interface LegacyLogManager
    
    Parameters:
    
    level - The logging level to use by default.
  - setLoggingLevel
```
public 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
    Specified by:
    
    setLoggingLevel in interface LegacyLogManager
    
    Parameters:
    
    level - The logging level to use by default.
  - getLogThreshold
```
public integer getLogThreshold()
```
    Obtains the configured log file size in bytes at which the log file will be renamed and a new log file started.
    
    Specified by:
    
    getLogThreshold in interface LegacyLogManager
    
    Returns:
    
    The maximum log file size.
  - getNumLogFiles
```
public 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).
    
    Specified by:
    
    getNumLogFiles in interface LegacyLogManager
    
    Returns:
    
    The maximum number of log files.
  - clearLog
```
public 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.
    
    Specified by:
    
    clearLog in interface LegacyLogManager
    
    Returns:
    
    true if the operation succeeded, or false otherwise.
  - closeLog
```
public 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.
    
    Specified by:
    
    closeLog in interface LegacyLogManager
    
    Returns:
    
    true if the operation succeeded, or false otherwise.
  - close
```
public logical close(boolean isProcedureCall,
                     boolean closeWriteExecutor)
```
    Closes the currently open log file. Additional logging will not be possible after this operation.
    
    Specified by:
    
    close in interface LegacyLogManager
    
    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 writeExecutor any more. In case of file being rotated or clearLog() called, this should be false.
    
    Returns:
    
    true if the operation succeeded, or false otherwise.
  - valid
```
public boolean valid()
```
    This object is always valid for use. It might output an error message if its state is not prepared for logging, but that is the expected behavior.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    Always true.
  - writeMessage
```
public logical writeMessage(java.lang.String msg)
```
    Write a user defined message to the currently open log file using the default subsystem name "APPL". The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    Parameters:
    
    msg - The message to write.
    
    Returns:
    
    true if the operation succeeded, or false otherwise.
  - writeMessage
```
public logical writeMessage(character msg)
```
    Write a user defined message to the currently open log file using the default subsystem name "APPL". The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    Parameters:
    
    msg - The message to write.
    
    Returns:
    
    true if the operation succeeded, or false otherwise.
  - writeMessage
```
public 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. The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    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
```
public logical writeMessage(character msg,
                            java.lang.String subsys)
```
    Write a user defined message to the currently open log file using the given subsystem name. The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    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
```
public logical writeMessage(java.lang.String msg,
                            character subsys)
```
    Write a user defined message to the currently open log file using the given subsystem name. The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    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
```
public logical writeMessage(character msg,
                            character subsys)
```
    Write a user defined message to the currently open log file using the given subsystem name. The method is called directly as a manual WRITE-MESSAGE, instead of an auto logging from a subsystem, that's why the logging level is set to HANDLE_CALL_LOGGING_LEVEL.
    Should be used only automatically by the converted code or LOG-MANAGER itself.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    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
```
public logical writeMessage(java.lang.String msg,
                            java.lang.String subsys,
                            java.lang.String[] callStack,
                            int logLevel,
                            long threadId)
```
    Write an automated message from the given subsystem to the currently open log file.
    To be used for custom calls / auto logging of entry types.
    
    Specified by:
    
    writeMessage in interface LegacyLogManager
    
    Parameters:
    
    msg - The message to write.
    
    subsys - Subsystem name (up to 10 characters will be used).
    
    callStack - The call stack.
    
    logLevel - The logging level of the message.
    
    threadId - The client thread id or server thread id for AppServer and WebSpeed.
    
    Returns:
    
    logical true if the operation succeeded, or logical false otherwise.
  - writeMessage
```
private logical writeMessage(java.lang.String msg,
                             java.lang.String subsys,
                             java.lang.String[] callStack,
                             int logLevel,
                             long threadId,
                             boolean isAutoLogging)
```
    Write a user defined message from a handle WRITE-MESSAGE call or an automated message to the currently open log file using the given subsystem name.
    To be used for custom calls / auto logging of entry types.
    
    Parameters:
    
    msg - The message to write.
    
    subsys - Subsystem name (up to 10 characters will be used).
    
    callStack - The call stack.
    
    logLevel - The logging level of the message.
    
    threadId - The client thread id or server thread id for AppServer and WebSpeed.
    
    isAutoLogging - A flag to indicate if auto logging from a subsystem or a user call from converted procedure.
    
    Returns:
    
    logical true if the operation succeeded, or logical false otherwise.
  - createLogRecord
```
private java.lang.String createLogRecord(java.lang.String msg,
                                         java.lang.String subsys,
                                         java.lang.String[] callStack,
                                         int logLevel,
                                         long threadId,
                                         java.util.Date date)
```
    Formats the input data as a log record.
    
    Parameters:
    
    msg - The message to write.
    
    subsys - Subsystem name (up to 10 characters will be used).
    
    callStack - The call stack.
    
    logLevel - The logging level of the message.
    
    threadId - The client thread id or server thread id for AppServer and WebSpeed.
    
    date - The date of the log record.
    
    Returns:
    
    The formatted log record.
  - resetEnabled
```
private void resetEnabled()
```
    Sets the isEnabled flag.
  - isWritable
```
static boolean isWritable(java.io.File file)
```
    Checks if the folder exists and if the JVM process has rights to write to it.
    
    Parameters:
    
    file - The file to check for.
    
    Returns:
    
    true if the folder is writable, false otherwise.
  - makeSequencedLogFile
```
static java.io.File makeSequencedLogFile(java.lang.String logFilePath,
                                         int logThreshold)
```
    Adds a dot and a sequence number to the file name before the file extension. The sequence number is six digits with leading zeros in the range 000001 - 999999. Traverses log file directory to find all files in the sequence. The first consecutive numbers found are used to determine the current sequence number. If the file is full based on the logThreshold value, the method increments the last sequence number or uses 1 if the end of the allowed range 999999 is reached.
    
    Parameters:
    
    logFilePath - The log file without sequence number.
    
    logThreshold - The log file size threshold for rolling over to a new file.
    
    Returns:
    
    The log file with updated name that includes the sequence number of the current last log file.
  - cleanupRotation
```
static void cleanupRotation(java.io.File logFile,
                            int numLogFiles)
```
    Removes the sequenced log files with the same name in the same folder that exceed the max count of numLogFiles, while preserving the current log file and of its predecessors.
  - deleteSequence
```
static boolean deleteSequence(java.io.File logFile)
```
    Deletes all files in the sequence in the same folder as the provided log file.
    
    Parameters:
    
    logFile - The log file to base the sequence finding on.
    
    Returns:
    
    true if all files in the sequence successfully deleted, false otherwise.
  - nextSequenceNumber
```
private static int nextSequenceNumber(int lastNumber)
```
    Get the next number in the sequence valid range.
    
    Parameters:
    
    lastNumber - The previous number in the sequence.
    
    Returns:
    
    The next number in the sequence.
  - formatFileName
```
private static java.lang.String formatFileName(LegacyLogManagerImpl.FileName fileName,
                                               int sequenceNumber)
```
    Concatenates the file name, sequence and extension. Number sequence is formatted with 6 digits (leading zeros are added if needed).
    
    Parameters:
    
    fileName - The file name object wrapper for the name prefix (name without extension and sequence number) and the extension itself.
    
    sequenceNumber - The sequence number.
    
    Returns:
    
    The formatted file name.
  - formatSystemId
```
private static java.lang.String formatSystemId(long id)
```
    Format process or thread id. Should take up at least 6 characters including leading zeros.
    
    Parameters:
    
    id - The process or thread id.
    
    Returns:
    
    The formatted id.
  - findLastLogFileNumber
```
private static int findLastLogFileNumber(java.io.File dir,
                                         java.lang.String nameNoExt,
                                         java.lang.String ext)
```
    This should reflect the 4GL logic to find the last file that has been written to. Traverses log file directory to find all files in the sequence. The last gap in the numbers found are used to determine the current sequence number. The last consecutive number (of that preceding sub-sequence) is returned.
    
    Parameters:
    
    dir - The directory to search for log files.
    
    nameNoExt - The name of the file without extension and sequence.
    
    ext - The extension of the file.
    
    Returns:
    
    The number in the sequence of the last log file.
  - switchLogFile
```
private void switchLogFile(java.io.File newLogFile)
```
    Updates the field logFile for resolved path to the log File. Closes the old log file, does cleanup of old rotation log files based on numLogFiles, and opens the new file adding the log header lines.
    
    Parameters:
    
    newLogFile - The new log file to be used.
  - writeSystemHeader
```
private void writeSystemHeader()
```
    Writes the system messages when a new file name is set.
  - setLogThreshold
```
private boolean setLogThreshold(int fileSize)
```
    Assigns the log file size threshold in bytes for rolling over to a new file. Valid values are either 0 for no limit (limited only by the system), or in the range 500_000 - 2_147_483_647. Can be set only command line on initialization.
    
    Parameters:
    
    fileSize - The log file size threshold for rolling over to a new file.
  - isRotationEnabled
```
private boolean isRotationEnabled()
```
    Checks if file rotation is enabled. If logThreshold has been initialized (having a value greater than 0), log file rotation is enabled.
    
    Returns:
    
    true if rotation is enabled, false otherwise.
  - setNumLogFiles
```
private boolean setNumLogFiles(int numLogFiles)
```
    Sets the number of log files that will be stored in total (including both backed up log files and the current log). Can be set only command line.
    
    Parameters:
    
    numLogFilesString - The number of log files in total.
  - setLogFileName
```
private void setLogFileName(boolean isProcedureCall,
                            java.lang.String logFileConfig)
```
    Assigns the file path to which log entries and stack traces are written.
    
    Parameters:
    
    isProcedureCall - Flag to identify the method is called by the execution of a converted 4GL procedure.
    
    logFileConfig - The log file path.
  - createLogLine
```
private java.lang.String createLogLine(int logLvl,
                                       java.lang.String subsys,
                                       java.lang.String msg,
                                       long threadId,
                                       java.util.Date date)
```
    Formats the parameters to the 4GL log record format.
    
    Parameters:
    
    logLvl - The logging level. See LegacyLogManagerImpl.LoggingLevel.
    
    subsys - The subsystem name.
    
    msg - The message.
    
    threadId - The client thread id or server thread id for AppServer and WebSpeed.
    
    date - The date of the log record.
    
    Returns:
    
    The formatted string line representing the log record.
  - writeLocal
```
private boolean writeLocal(java.lang.String logRecord)
```
    Writes the log record to the log file server-side.
    
    Parameters:
    
    logRecord - The record to be written to the log file.
    
    Returns:
    
    true if the record has been written successfully, false otherwise.
  - writeRemote
```
private boolean writeRemote(java.lang.String logRecord,
                            boolean isAutoLogging)
```
    Writes the log record to the log file client-side.
    
    Parameters:
    
    logRecord - The record to be written to the log file.
    
    isAutoLogging - A flag to indicate if auto logging from a subsystem or a user call from converted procedure.
    
    Returns:
    
    true if the record has been written successfully, false otherwise.
  - formatSubsys
```
private java.lang.String formatSubsys(java.lang.String subsys)
```
    Format the subsystem string. It should take up a space defined by WRITE_MSG_SUBSYS_CHARS_COUNT.
    
    Parameters:
    
    subsys - Subsystem name.
    
    Returns:
    
    The formatted string for subsystem.
  - rotateLogFile
```
private void rotateLogFile()
```
    Creates the next file in the sequence.
  - recordOrThrowError
```
private void recordOrThrowError(int num,
                                java.lang.String text,
                                boolean prefix)
```
    Raise an error condition and optionally record the given error.
    
    Parameters:
    
    num - The error number.
    
    text - The text of the error message.
    
    prefix - true to prepend a double asterisk prefix to the formatted error message, false to omit this text.
    
    Throws:
    
    ErrorConditionException
  - recordOrShowWarning
```
private void recordOrShowWarning(int num,
                                 java.lang.String text,
                                 boolean prefix)
```
    Manufacture a warning text based on the given parameters.
    
    Parameters:
    
    num - The error number.
    
    text - The text of the error message.
    
    prefix - true to prepend a double asterisk prefix to the formatted error message, false to omit this text.

Class LegacyLogManagerImpl

Nested Class Summary

Field Summary

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface com.goldencode.util.Printable

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

Field Detail

SUBSYS_EMPTY

SUBSYS_DEFAULT

SUBSYS_APPSERVER_AGENT

HANDLE_CALL_LOGGING_LEVEL

WRITE_MSG_SUBSYS_CHARS_COUNT

DATETIME_FORMATTER

NUMBER_REGEX

MIN_LOG_FILE_THRESHOLD_BYTES

MAX_LOG_FILE_THRESHOLD_BYTES

MAX_NUM_LOG_FILES

LOG

writeExecutor

isInitialized

isEnabled

maxInputCharacters

isAppserver

clientProcessId

logFile

logWriter

activatedTypeLevelPairs

loggingLevel

logThreshold

numLogFiles

client

session

remoteFileSize

Constructor Detail

LegacyLogManagerImpl

Method Detail

initialize

initialize

getEntryTypesList

getLogEntryTypes

setLogEntryTypes

setLogEntryTypes

getLogFileName

setLogFileName

setLogFileName

getLoggingLevel

setLoggingLevel

setLoggingLevel

getLogThreshold

getNumLogFiles

clearLog

closeLog

close

valid

writeMessage

writeMessage

writeMessage

writeMessage

writeMessage

writeMessage

writeMessage

writeMessage

createLogRecord

resetEnabled

isWritable

makeSequencedLogFile

cleanupRotation

deleteSequence

nextSequenceNumber

formatFileName

formatSystemId

findLastLogFileNumber

switchLogFile