org.apache.directory.server.log
Interface Log

public interface Log

Method Summary

LogScanner	beginScan(LogAnchor startPoint) Starts a san in the logs starting from the given log position
void	init(String logFilepath, String suffix, int logBufferSize, long logFileSize) Initializes the logging subsystem
void	log(UserLogRecord userRecord, boolean sync) Logs the given user record to the log.

Method Detail

init

void init(String logFilepath,
          String suffix,
          int logBufferSize,
          long logFileSize)

Initializes the logging subsystem

Parameters:

logFilepath - log file path

suffix - suffix for log file.

logBufferSize - size of buffer that will hold unflushed log changes. Specifigy zero if no buffering is desired

logFileSize - A soft limit on the log file size

log

void log(UserLogRecord userRecord,
         boolean sync)
         throws IOException,
                InvalidLogException

Logs the given user record to the log. Position in the log files where the record is logged is returned as part of userRecord.

Parameters:

userLogRecord - provides the user data to be logged

sync - if true, this calls returns after making sure that the appended data is reflected to the underlying media

Throws:

IOException

InvalidLogException

beginScan

LogScanner beginScan(LogAnchor startPoint)

Starts a san in the logs starting from the given log position

Parameters:

startPoint - starting position of the scan.

Returns: