| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Wed Dec 11 21:08:55 MST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Rfc5424Layout (Apache Log4j Core 2.13.0 API)</title> |
| <meta name="date" content="2019-12-11"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Rfc5424Layout (Apache Log4j Core 2.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Rfc5424Layout.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/ScriptPatternSelector.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/layout/Rfc5424Layout.html" target="_top">Frames</a></li> |
| <li><a href="Rfc5424Layout.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.layout</div> |
| <h2 title="Class Rfc5424Layout" class="title">Class Rfc5424Layout</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractStringLayout</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.layout.Rfc5424Layout</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a>, <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>, <a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>>, <a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#name--">name</a>="Rfc5424Layout", |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#category--">category</a>="Core", |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#elementType--">elementType</a>="layout", |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/Plugin.html#printObject--">printObject</a>=true) |
| public final class <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.71">Rfc5424Layout</a> |
| extends <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></pre> |
| <div class="block">Formats a log event in accordance with RFC 5424.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a> extends <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a>>>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer2.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#DEFAULT_ENTERPRISE_NUMBER">DEFAULT_ENTERPRISE_NUMBER</a></span></code> |
| <div class="block">Not a very good default - it is the Apache Software Foundation's enterprise number.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#DEFAULT_ID">DEFAULT_ID</a></span></code> |
| <div class="block">The default event id.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#DEFAULT_MDCID">DEFAULT_MDCID</a></span></code> |
| <div class="block">Default MDC ID: "mdc" .</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#NEWLINE_PATTERN">NEWLINE_PATTERN</a></span></code> |
| <div class="block">Match newlines in a platform-independent manner.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#PARAM_VALUE_ESCAPE_PATTERN">PARAM_VALUE_ESCAPE_PATTERN</a></span></code> |
| <div class="block">Match characters which require escaping.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#DEFAULT_STRING_BUILDER_SIZE">DEFAULT_STRING_BUILDER_SIZE</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#MAX_STRING_BUILDER_SIZE">MAX_STRING_BUILDER_SIZE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractLayout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#configuration">configuration</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#eventCount">eventCount</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#footer">footer</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#header">header</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#LOGGER">LOGGER</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.Layout"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#ELEMENT_TYPE">ELEMENT_TYPE</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#createLayout-org.apache.logging.log4j.core.net.Facility-java.lang.String-int-boolean-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-org.apache.logging.log4j.core.layout.LoggerFields:A-org.apache.logging.log4j.core.config.Configuration-">createLayout</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a> facility, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| int enterpriseNumber, |
| boolean includeMDC, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdcId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdcPrefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventPrefix, |
| boolean newLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> escapeNL, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msgId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> excludes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> includes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> required, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> exceptionPattern, |
| boolean useTlsMessageFormat, |
| <a href="../../../../../../org/apache/logging/log4j/core/layout/LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[] loggerFields, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</code> |
| <div class="block">Create the RFC 5424 Layout.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#getContentFormat--">getContentFormat</a></span>()</code> |
| <div class="block">Gets this Rfc5424Layout's content format.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#getFacility--">getFacility</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#getMdcExcludes--">getMdcExcludes</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#getMdcIncludes--">getMdcIncludes</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#getProcId--">getProcId</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#toSerializable-org.apache.logging.log4j.core.LogEvent-">toSerializable</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code> |
| <div class="block">Formats a <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> in conformance with the RFC 5424 Syslog specification.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractStringLayout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getBytes-java.lang.String-">getBytes</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getCharset--">getCharset</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getContentType--">getContentType</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getFooter--">getFooter</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getFooterSerializer--">getFooterSerializer</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getHeader--">getHeader</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getHeaderSerializer--">getHeaderSerializer</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getStringBuilder--">getStringBuilder</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getStringBuilderEncoder--">getStringBuilderEncoder</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#requiresLocation--">requiresLocation</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#serializeToBytes-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-byte:A-">serializeToBytes</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#serializeToString-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-">serializeToString</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#toByteArray-org.apache.logging.log4j.core.LogEvent-">toByteArray</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#trimToMaxSize-java.lang.StringBuilder-">trimToMaxSize</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractLayout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#encode-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.layout.ByteBufferDestination-">encode</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#markEvent--">markEvent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.layout.Encoder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html#encode-T-org.apache.logging.log4j.core.layout.ByteBufferDestination-">encode</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_ENTERPRISE_NUMBER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ENTERPRISE_NUMBER</h4> |
| <pre>public static final int <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.76">DEFAULT_ENTERPRISE_NUMBER</a></pre> |
| <div class="block">Not a very good default - it is the Apache Software Foundation's enterprise number.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.layout.Rfc5424Layout.DEFAULT_ENTERPRISE_NUMBER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ID</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.80">DEFAULT_ID</a></pre> |
| <div class="block">The default event id.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.layout.Rfc5424Layout.DEFAULT_ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NEWLINE_PATTERN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NEWLINE_PATTERN</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.84">NEWLINE_PATTERN</a></pre> |
| <div class="block">Match newlines in a platform-independent manner.</div> |
| </li> |
| </ul> |
| <a name="PARAM_VALUE_ESCAPE_PATTERN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARAM_VALUE_ESCAPE_PATTERN</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.88">PARAM_VALUE_ESCAPE_PATTERN</a></pre> |
| <div class="block">Match characters which require escaping.</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_MDCID"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_MDCID</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.93">DEFAULT_MDCID</a></pre> |
| <div class="block">Default MDC ID: "mdc" .</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.layout.Rfc5424Layout.DEFAULT_MDCID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContentFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentFormat</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.256">getContentFormat</a>()</pre> |
| <div class="block">Gets this Rfc5424Layout's content format. Specified by: |
| <ul> |
| <li>Key: "structured" Value: "true"</li> |
| <li>Key: "format" Value: "RFC5424"</li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#getContentFormat--">getContentFormat</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getContentFormat--">getContentFormat</a></code> in class <code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map of content format keys supporting Rfc5424Layout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toSerializable-org.apache.logging.log4j.core.LogEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSerializable</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.270">toSerializable</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</pre> |
| <div class="block">Formats a <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> in conformance with the RFC 5424 Syslog specification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - The LogEvent.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The RFC 5424 String representation of the LogEvent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProcId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProcId</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.436">getProcId</a>()</pre> |
| </li> |
| </ul> |
| <a name="getMdcExcludes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMdcExcludes</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.440">getMdcExcludes</a>()</pre> |
| </li> |
| </ul> |
| <a name="getMdcIncludes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMdcIncludes</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.444">getMdcIncludes</a>()</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.572">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createLayout-org.apache.logging.log4j.core.net.Facility-java.lang.String-int-boolean-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-org.apache.logging.log4j.core.layout.LoggerFields:A-org.apache.logging.log4j.core.config.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createLayout</h4> |
| <pre><a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| public static <a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.609">createLayout</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="facility",<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultString--">defaultString</a>="LOCAL0") |
| <a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a> facility, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="id") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="enterpriseNumber",<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultInt--">defaultInt</a>=18060) |
| int enterpriseNumber, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="includeMDC",<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultBoolean--">defaultBoolean</a>=true) |
| boolean includeMDC, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="mdcId",<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#defaultString--">defaultString</a>="mdc") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdcId, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="mdcPrefix") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mdcPrefix, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="eventPrefix") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventPrefix, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="newLine") |
| boolean newLine, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="newLineEscape") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> escapeNL, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="appName") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> appName, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="messageId") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msgId, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="mdcExcludes") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> excludes, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="mdcIncludes") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> includes, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="mdcRequired") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> required, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="exceptionPattern") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> exceptionPattern, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html#value--">value</a>="useTlsMessageFormat") |
| boolean useTlsMessageFormat, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html#value--">value</a>="LoggerFields") |
| <a href="../../../../../../org/apache/logging/log4j/core/layout/LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[] loggerFields, |
| <a href="../../../../../../org/apache/logging/log4j/core/config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</pre> |
| <div class="block">Create the RFC 5424 Layout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>facility</code> - The Facility is used to try to classify the message.</dd> |
| <dd><code>id</code> - The default structured data id to use when formatting according to RFC 5424.</dd> |
| <dd><code>enterpriseNumber</code> - The IANA enterprise number.</dd> |
| <dd><code>includeMDC</code> - Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog |
| record. Defaults to "true:.</dd> |
| <dd><code>mdcId</code> - The id to use for the MDC Structured Data Element.</dd> |
| <dd><code>mdcPrefix</code> - The prefix to add to MDC key names.</dd> |
| <dd><code>eventPrefix</code> - The prefix to add to event key names.</dd> |
| <dd><code>newLine</code> - If true, a newline will be appended to the end of the syslog record. The default is false.</dd> |
| <dd><code>escapeNL</code> - String that should be used to replace newlines within the message text.</dd> |
| <dd><code>appName</code> - The value to use as the APP-NAME in the RFC 5424 syslog record.</dd> |
| <dd><code>msgId</code> - The default value to be used in the MSGID field of RFC 5424 syslog records.</dd> |
| <dd><code>excludes</code> - A comma separated list of MDC keys that should be excluded from the LogEvent.</dd> |
| <dd><code>includes</code> - A comma separated list of MDC keys that should be included in the FlumeEvent.</dd> |
| <dd><code>required</code> - A comma separated list of MDC keys that must be present in the MDC.</dd> |
| <dd><code>exceptionPattern</code> - The pattern for formatting exceptions.</dd> |
| <dd><code>useTlsMessageFormat</code> - If true the message will be formatted according to RFC 5425.</dd> |
| <dd><code>loggerFields</code> - Container for the KeyValuePairs containing the patterns</dd> |
| <dd><code>config</code> - The Configuration. Some Converters require access to the Interpolator.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An Rfc5424Layout.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFacility--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFacility</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/Rfc5424Layout.html#line.706">getFacility</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Rfc5424Layout.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/layout/ScriptPatternSelector.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/layout/Rfc5424Layout.html" target="_top">Frames</a></li> |
| <li><a href="Rfc5424Layout.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
