ch.qos.logback.core

Class FileAppender<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<E>

ch.qos.logback.core.OutputStreamAppender<E>

ch.qos.logback.core.FileAppender<E>

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

Direct Known Subclasses:

RollingFileAppender

public class FileAppender<E>
extends OutputStreamAppender<E>

FileAppender appends log events to a file. For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#FileAppender

Property Summary

Type	Property and Description
String	rawFile This method is used by derived classes to obtain the raw file property.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	append Append to or truncate the file? The default value for this variable is true, meaning that by default a FileAppender will append to an existing file and not truncate it.
protected String	fileName The name of the active log file.

Fields inherited from class ch.qos.logback.core.OutputStreamAppender

encoder, lock

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
FileAppender()

Method Summary

Modifier and Type	Method and Description
String	getFile() Returns the value of the File property.
boolean	getLazy() Gets the enable status of lazy initialization of the file output stream
boolean	isAppend() Returns the value of the Append property.
boolean	isPrudent()
protected boolean	openFile(String filename) Sets and opens the file where the log output will go.
String	rawFileProperty() This method is used by derived classes to obtain the raw file property.
void	setAppend(boolean append)
void	setFile(String file) The File property takes a string value which should be the name of the file to append to.
void	setLazy(boolean enable) Enables/disables lazy initialization of the file output stream.
void	setPrudent(boolean prudent) When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.
void	start() If the value of File is not null, then openFile(java.lang.String) is called with the values of File and Append properties.
protected void	subAppend(E event) Actual writing occurs here.
protected void	writeOut(E event)

Methods inherited from class ch.qos.logback.core.OutputStreamAppender

append, closeOutputStream, getEncoder, getOutputStream, setEncoder, setLayout, setOutputStream, stop

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Property Detail

rawFile

public final String rawFileProperty

This method is used by derived classes to obtain the raw file property. Regular users should not be calling this method. Note that RollingFilePolicyBase requires public getter for this property.

Field Detail

append

protected boolean append

Append to or truncate the file? The default value for this variable is true, meaning that by default a FileAppender will append to an existing file and not truncate it.

fileName

protected String fileName

The name of the active log file.

Constructor Detail

FileAppender

public FileAppender()

Method Detail

setFile

public void setFile(String file)

The File property takes a string value which should be the name of the file to append to.

Parameters:

file - path to destination log file

isAppend

public boolean isAppend()

Returns the value of the Append property.

Returns:

true if file should be appended to instead of overwritten

rawFileProperty

public final String rawFileProperty()

This method is used by derived classes to obtain the raw file property. Regular users should not be calling this method. Note that RollingFilePolicyBase requires public getter for this property.

getFile

public String getFile()

Returns the value of the File property.

Returns:

the path to the destination log file

start

public void start()

If the value of File is not null, then openFile(java.lang.String) is called with the values of File and Append properties.

Specified by:

start in interface LifeCycle

Overrides:

start in class OutputStreamAppender<E>

openFile

protected boolean openFile(String filename)
                    throws IOException

Sets and opens the file where the log output will go. The specified file must be writable.

If there was already an opened file, then the previous file is closed first.

Do not use this method directly. To configure a FileAppender or one of its subclasses, set its properties one by one and then call start().

Parameters:

filename - The path to the log file.

Returns:

true if successful; false otherwise

Throws:

IOException - file could not be opened

isPrudent

public boolean isPrudent()

Returns:

true if in prudent mode

See Also:

setPrudent(boolean)

setPrudent

public void setPrudent(boolean prudent)

When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.

Parameters:

prudent - whether to enable prudent mode

setAppend

public void setAppend(boolean append)

getLazy

public boolean getLazy()

Gets the enable status of lazy initialization of the file output stream

Returns:

true if enabled; false otherwise

setLazy

public void setLazy(boolean enable)

Enables/disables lazy initialization of the file output stream. This defers the file creation until the first outgoing message.

Parameters:

enable - true to enable lazy initialization; false otherwise

writeOut

protected void writeOut(E event)
                 throws IOException

Overrides:

writeOut in class OutputStreamAppender<E>

Throws:

IOException

subAppend

protected void subAppend(E event)

Description copied from class: OutputStreamAppender

Actual writing occurs here.

Most subclasses of WriterAppender will need to override this method.

Overrides:

subAppend in class OutputStreamAppender<E>

Parameters:

event - the log event