com.persistit.logging

Class DefaultPersistitLogger

java.lang.Object

com.persistit.logging.DefaultPersistitLogger

All Implemented Interfaces:

PersistitLogger

public class DefaultPersistitLogger
extends Object
implements PersistitLogger

The default implementation of logging for Persistit. Writes log messages to a file and/or System.err. Many applications will uses one of the logging adapter classes instead of this class to connect Persistit's log output to an existing infrastructure.

Version:

1.0

See Also:

Slf4jAdapter

Constructor Summary

Constructors

Constructor and Description
DefaultPersistitLogger() Construct a logger that logs messages at WARNING level or above to the system console.
DefaultPersistitLogger(String fileName) Construct a logger that logs messages to a file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the log file.
void	flush() Writes pending I/O to the log file.
PersistitLevel	getLevel()
boolean	isLoggable(PersistitLevel level) Test whether a message at the specified level should be written to the log.
void	log(PersistitLevel level, String message) Writes a message to the log file and also displays high-significance messages to System.err.
void	open() Prepares this logger to received messages.
void	setLevel(PersistitLevel level)
void	setLevel(String levelName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPersistitLogger

public DefaultPersistitLogger()

Construct a logger that logs messages at WARNING level or above to the system console.

DefaultPersistitLogger

public DefaultPersistitLogger(String fileName)

Construct a logger that logs messages to a file. If the supplied path name is null then log only WARNING and higher messages to the system console.

Parameters:

fileName - Log file path name

Method Detail

setLevel

public void setLevel(String levelName)

setLevel

public void setLevel(PersistitLevel level)

getLevel

public PersistitLevel getLevel()

log

public void log(PersistitLevel level,
                String message)

Writes a message to the log file and also displays high-significance messages to System.err.

Specified by:

log in interface PersistitLogger

Parameters:

level - PersistitLevel at which this message should be logged. (Ignored in this implementation.)

message - The message to write

isLoggable

public boolean isLoggable(PersistitLevel level)

Description copied from interface: PersistitLogger

Test whether a message at the specified level should be written to the log. This method is called during configuration, not once per log message.

Specified by:

isLoggable in interface PersistitLogger

Parameters:

level - The level of the log event

Returns:

whether a message should be logged at the specified level

open

public void open()
          throws Exception

Prepares this logger to received messages. This implementation, opens the file for writing.

Specified by:

open in interface PersistitLogger

Throws:

Exception

close

public void close()
           throws InterruptedException

Closes the log file.

Specified by:

close in interface PersistitLogger

Throws:

InterruptedException

flush

public void flush()

Writes pending I/O to the log file. Because this implementation uses a BufferedWriter, log messages may be held in memory rather than being written to disk. Since the most interesting log messages in the event of a failure are often the last messages, it is helpful for these messages to be flushed to disk on a regular basis. This method is invoked at various times within the execution of Persistit to increase the likelihood that the log file will be useful in case the application exits abruptly.

Specified by:

flush in interface PersistitLogger