Log4j2ConfluencePatternLayoutBuilder (Atlassian Confluence 8.8.0 API)

java.lang.Object
- org.apache.log4j.builders.AbstractBuilder<org.apache.log4j.Layout>
- - com.atlassian.confluence.impl.logging.log4j.layout.Log4j2ConfluencePatternLayoutBuilder

All Implemented Interfaces:

org.apache.log4j.builders.Builder<org.apache.log4j.Layout>, org.apache.log4j.builders.layout.LayoutBuilder, org.apache.log4j.builders.Parser<org.apache.log4j.Layout>

Direct Known Subclasses:

Log4j2ConfluenceControlCharsEscapedPatternLayoutBuilder
```
@Plugin(name="com.atlassian.confluence.impl.logging.ConfluencePatternLayout",
        category="Log4j Builder")
@PluginAliases("com.atlassian.logging.log4j.NewLineIndentingFilteringPatternLayout")
public class Log4j2ConfluencePatternLayoutBuilder
extends org.apache.log4j.builders.AbstractBuilder<org.apache.log4j.Layout>
```
A Log4j2.x Plugin that constructs a Log4j1.x Layout that emulates ConfluencePatternLayout as used under log4j1.x. This is for use by log4j2.x under its log4j1.x emulation mode. This class is based upon PatternLayoutBuilder, but adds the custom pattern converters used by ConfluencePatternLayout. This layout does not escape any control chars in a log message, catering for usage in internal tools, e.g. JMX, IPD. Use com.atlassian.confluence.impl.logging.ConfluenceControlCharsEscapedPatternLayout in customer facing applications

Since:

7.14

Field Summary
- Fields inherited from class org.apache.log4j.builders.AbstractBuilder
  APPEND_PARAM, BUFFER_SIZE_PARAM, BUFFERED_IO_PARAM, FILE_PARAM, IMMEDIATE_FLUSH_PARAM, MAX_BACKUP_INDEX, MAX_SIZE_PARAM, NULL, RELATIVE

Constructor Summary

Constructors
Constructor Description

Log4j2ConfluencePatternLayoutBuilder(String prefix, Properties props)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`modifyPattern(String pattern)`	Since this needs to work with log4j1.x-era configurations, we need to substitute the single-character pattern specifiers used by the log4j1.x `ConfluencePatternLayout` with the multi-character pattern specifiers used by log4j2.x
`org.apache.log4j.Layout`	`parse(org.apache.log4j.config.PropertiesConfiguration config)`
`org.apache.log4j.Layout`	`parse(Element element, org.apache.log4j.xml.XmlConfiguration config)`

Methods inherited from class org.apache.log4j.builders.AbstractBuilder
buildFilters, getBooleanProperty, getBooleanProperty, getBooleanValueAttribute, getIntegerProperty, getLongProperty, getNameAttribute, getNameAttributeKey, getProperties, getProperty, getProperty, getValueAttribute, getValueAttribute, set, set, set, set, substVars

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Log4j2ConfluencePatternLayoutBuilder
```
public Log4j2ConfluencePatternLayoutBuilder(String prefix,
                                            Properties props)
```
- Method Detail
  - modifyPattern
```
protected String modifyPattern(String pattern)
```
    Since this needs to work with log4j1.x-era configurations, we need to substitute the single-character pattern specifiers used by the log4j1.x ConfluencePatternLayout with the multi-character pattern specifiers used by log4j2.x
  - parse
```
public org.apache.log4j.Layout parse(org.apache.log4j.config.PropertiesConfiguration config)
```
    Specified by:
    
    parse in interface org.apache.log4j.builders.Parser<org.apache.log4j.Layout>
  - parse
```
public org.apache.log4j.Layout parse(Element element,
                                     org.apache.log4j.xml.XmlConfiguration config)
```
    Specified by:
    
    parse in interface org.apache.log4j.builders.Parser<org.apache.log4j.Layout>