public final class

JiraHomeAppender

extends Object
implements RollOverLogAppender Appender OptionHandler
java.lang.Object
   ↳ com.atlassian.jira.logging.JiraHomeAppender

Class Overview

A log4j appender that will log output data to the JIRA.HOME/log directory. It accepts the same options as the org.apache.log4j.RollingFileAppender.

The appender may be called before JIRA.HOME is ready to be used. In this situation the appender will buffer the log events until the JIRA.HOME is ready. Once ready, all the events will be flushed in order.

The appender will revert to its old behaviour (creating a file in the working directory) if JIRA.HOME is not configured correctly.

Summary

Public Constructors
JiraHomeAppender(JiraHomeStartupCheck startupCheck)
JiraHomeAppender()
Public Methods
void activateOptions()
void addFilter(Filter newFilter)
void clearFilters()
void close()
void doAppend(LoggingEvent event)
boolean getAppend()
int getBufferSize()
boolean getBufferedIO()
String getEncoding()
ErrorHandler getErrorHandler()
String getFile()
Filter getFilter()
Filter getFirstFilter()
boolean getImmediateFlush()
Layout getLayout()
int getMaxBackupIndex()
long getMaximumFileSize()
String getName()
Priority getThreshold()
boolean requiresLayout()
void rollOver()
Cause a log rollover to happen
void setAppend(boolean flag)
void setBufferSize(int bufferSize)
void setBufferedIO(boolean bufferedIO)
void setEncoding(String value)
void setErrorHandler(ErrorHandler eh)
void setFile(String file)
void setImmediateFlush(boolean value)
void setLayout(Layout layout)
void setMaxBackupIndex(int maxBackups)
void setMaxFileSize(String value)
void setMaximumFileSize(long maxFileSize)
void setName(String name)
void setThreshold(Priority threshold)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.logging.RollOverLogAppender
From interface org.apache.log4j.Appender
From interface org.apache.log4j.spi.OptionHandler

Public Constructors

public JiraHomeAppender (JiraHomeStartupCheck startupCheck)

public JiraHomeAppender ()

Public Methods

public void activateOptions ()

public void addFilter (Filter newFilter)

public void clearFilters ()

public void close ()

public void doAppend (LoggingEvent event)

public boolean getAppend ()

public int getBufferSize ()

public boolean getBufferedIO ()

public String getEncoding ()

public ErrorHandler getErrorHandler ()

public String getFile ()

public Filter getFilter ()

public Filter getFirstFilter ()

public boolean getImmediateFlush ()

public Layout getLayout ()

public int getMaxBackupIndex ()

public long getMaximumFileSize ()

public String getName ()

public Priority getThreshold ()

public boolean requiresLayout ()

public void rollOver ()

Cause a log rollover to happen

public void setAppend (boolean flag)

public void setBufferSize (int bufferSize)

public void setBufferedIO (boolean bufferedIO)

public void setEncoding (String value)

public void setErrorHandler (ErrorHandler eh)

public void setFile (String file)

public void setImmediateFlush (boolean value)

public void setLayout (Layout layout)

public void setMaxBackupIndex (int maxBackups)

public void setMaxFileSize (String value)

public void setMaximumFileSize (long maxFileSize)

public void setName (String name)

public void setThreshold (Priority threshold)