com.goldencode.p2j.util

Interface LegacyLogManagerClientService

All Known Implementing Classes:

LegacyLogManagerClientServiceImpl

public interface LegacyLogManagerClientService

LOG-MANAGER client service interface.

Method Summary

Modifier and Type	Method and Description
void	cleanupRotation(java.lang.String filePath, 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.
boolean	clear() Clears the content of the currently open log file.
boolean	close() Closes the file.
boolean	isWritable(java.lang.String filePath) Returns a flag to indicate if the file path is writable.
java.lang.String	makeSequencedLogFile(java.lang.String logFileConfig, int logThreshold) Receives the clean file path from configs and returns the path modified with rotation number, next in the sequence based on the existing files in the folder.
boolean	open(java.lang.String filePath) Opens the file for writing.
boolean	write(java.lang.String logRecord) Writes the log record.

Method Detail

isWritable

boolean isWritable(java.lang.String filePath)

Returns a flag to indicate if the file path is writable.

Parameters:

filePath - The file path to check for.

Returns:

true if the folder is writable, false otherwise.

makeSequencedLogFile

java.lang.String makeSequencedLogFile(java.lang.String logFileConfig,
                                      int logThreshold)

Receives the clean file path from configs and returns the path modified with rotation number, next in the sequence based on the existing files in the folder.

Parameters:

logFileConfig - The clean file path from configs.

logThreshold - The size of the file before rolling over.

Returns:

The modified file path with the rotation number.

open

boolean open(java.lang.String filePath)

Opens the file for writing.

Parameters:

filePath - The file path.

Returns:

true if successful, false otherwise.

write

boolean write(java.lang.String logRecord)

Writes the log record.

Parameters:

logRecord - The log record.

Returns:

true if successful, false otherwise.

close

boolean close()

Closes the file.

Returns:

true if successful, false otherwise.

clear

boolean clear()

Clears the content of the currently open log file. If rotation is enabled, deletes all files in the sequence.

Returns:

true if successful, false otherwise.

cleanupRotation

void cleanupRotation(java.lang.String filePath,
                     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.

Parameters:

filePath - The log record.

numLogFiles - The log record.