com.atlassian.logging.log4j

Class NewLineIndentingFilteringPatternLayout

java.lang.Object

org.apache.log4j.Layout

org.apache.log4j.PatternLayout

com.atlassian.logging.log4j.FilteredPatternLayout

com.atlassian.logging.log4j.NewLineIndentingFilteringPatternLayout

All Implemented Interfaces:

org.apache.log4j.spi.OptionHandler

public class NewLineIndentingFilteringPatternLayout
extends FilteredPatternLayout

PatternLayout that looks to suffix all new lines contained within log messages with an indent for the new line. Note Unlike FilteredPatternLayout filtering for stack traces is disabled by default

Since:

v1.2

Field Summary

Fields inherited from class com.atlassian.logging.log4j.FilteredPatternLayout

collapsingParser

Fields inherited from class org.apache.log4j.PatternLayout

BUF_SIZE, DEFAULT_CONVERSION_PATTERN, MAX_CAPACITY, TTCC_CONVERSION_PATTERN

Fields inherited from class org.apache.log4j.Layout

LINE_SEP, LINE_SEP_LEN

Constructor Summary

Constructors

Constructor and Description
NewLineIndentingFilteringPatternLayout()
NewLineIndentingFilteringPatternLayout(String lineIndent)

Method Summary

Modifier and Type	Method and Description
protected org.apache.log4j.helpers.PatternParser	createPatternParser(String pattern)
String	getLineIndent()
protected String[]	getThrowableStrRep(org.apache.log4j.spi.ThrowableInformation throwableInformation) A replacement for ThrowableInformation.getThrowableStrRep() which will split on any newline characters that may have been injected into the exception message.
void	setLineIndent(String lineIndent)

Methods inherited from class com.atlassian.logging.log4j.FilteredPatternLayout

activateOptions, format, getCategoryNameCollapsePrecision, getFilterEveryThingAfterMessage, getFilterReplacementToken, getMarkerAtMessage, getMinimumLines, ignoresThrowable, isFilteringApplied, isFilteringAppliedToDebugLevel, isShowEludedSummary, isStackTracePackagingExamined, setFilteredFrames, setFilterEveryThingAfterFrames, setFilterEveryThingAfterMessage, setFilteringApplied, setFilteringAppliedToDebugLevel, setFilterReplacementToken, setMarkerAtFrames, setMarkerAtMessage, setMinimumLines, setShowEludedSummary, setStackTracePackagingExamined

Methods inherited from class org.apache.log4j.PatternLayout

getConversionPattern, setConversionPattern

Methods inherited from class org.apache.log4j.Layout

getContentType, getFooter, getHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

NewLineIndentingFilteringPatternLayout

public NewLineIndentingFilteringPatternLayout()

NewLineIndentingFilteringPatternLayout

public NewLineIndentingFilteringPatternLayout(String lineIndent)

Method Detail

createPatternParser

protected org.apache.log4j.helpers.PatternParser createPatternParser(String pattern)

Overrides:

createPatternParser in class FilteredPatternLayout

getThrowableStrRep

protected String[] getThrowableStrRep(org.apache.log4j.spi.ThrowableInformation throwableInformation)

A replacement for ThrowableInformation.getThrowableStrRep() which will split on any newline characters that may have been injected into the exception message. This also replaces the call to Throwable.printStackTrace(java.io.PrintStream) which has hard coded Strings ("\tat", "Caused By:", "\t... ") that are printed along with the exception message. If text is injected into the exception message then these can be easily faked.

Overrides:

getThrowableStrRep in class FilteredPatternLayout

Parameters:

throwableInformation - the throwable that is attached to the logging event

Returns:

array containing all the StackTrace lines of the exception message

getLineIndent

public String getLineIndent()

setLineIndent

public void setLineIndent(String lineIndent)