com.goldencode.p2j.util

Class LegacyLogManagerClientServiceImpl

java.lang.Object

com.goldencode.p2j.util.LegacyLogManagerClientServiceImpl

All Implemented Interfaces:

LegacyLogManagerClientService

public class LegacyLogManagerClientServiceImpl
extends java.lang.Object
implements LegacyLogManagerClientService

LOG-MANAGER client service.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.channels.FileChannel	channel The file channel associated with the output stream.
private java.io.FileOutputStream	fileOutputStream The output stream to write to the log file.
private java.lang.String	filePath The file path.
private static CentralLogger	LOG Logger.
private java.nio.channels.FileLock	rotationLock The lock to the file channel, when rotation is enabled.

Constructor Summary

Constructors

Constructor and Description
LegacyLogManagerClientServiceImpl() Default public constructor for LegacyLogManagerClientServiceImpl.

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.
void	write(java.util.List<java.lang.String> logManagerRecords) Writes multiple log record.
boolean	write(java.lang.String logRecord) Writes the log record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final CentralLogger LOG

Logger.

filePath

private java.lang.String filePath

The file path.

fileOutputStream

private java.io.FileOutputStream fileOutputStream

The output stream to write to the log file.

channel

private java.nio.channels.FileChannel channel

The file channel associated with the output stream.

rotationLock

private java.nio.channels.FileLock rotationLock

The lock to the file channel, when rotation is enabled.

Constructor Detail

LegacyLogManagerClientServiceImpl

public LegacyLogManagerClientServiceImpl()

Default public constructor for LegacyLogManagerClientServiceImpl. Adds a JVM shutdown hook to close the log file and release the lock.

Method Detail

isWritable

public boolean isWritable(java.lang.String filePath)

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

Specified by:

isWritable in interface LegacyLogManagerClientService

Parameters:

filePath - The file path to check for.

Returns:

true if the folder is writable, false otherwise.

makeSequencedLogFile

public 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.

Specified by:

makeSequencedLogFile in interface LegacyLogManagerClientService

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

public boolean open(java.lang.String filePath)

Opens the file for writing.

Specified by:

open in interface LegacyLogManagerClientService

Parameters:

filePath - The file path.

Returns:

true if successful, false otherwise.

write

public boolean write(java.lang.String logRecord)

Writes the log record.

Specified by:

write in interface LegacyLogManagerClientService

Parameters:

logRecord - The log record.

Returns:

true if successful, false otherwise.

close

public boolean close()

Closes the file.

Specified by:

close in interface LegacyLogManagerClientService

Returns:

true if successful, false otherwise.

clear

public boolean clear()

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

Specified by:

clear in interface LegacyLogManagerClientService

Returns:

true if successful, false otherwise.

cleanupRotation

public 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.

Specified by:

cleanupRotation in interface LegacyLogManagerClientService

Parameters:

filePath - The log record.

numLogFiles - The log record.

write

public void write(java.util.List<java.lang.String> logManagerRecords)

Writes multiple log record. Used with state transfer.

Parameters:

logManagerRecords - The log records.