| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Plugin reference :: Apache Log4j</title> |
| <link rel="canonical" href="https://logging.apache.org/log4j/2.x/plugin-reference.html"> |
| <meta name="generator" content="Antora 3.2.0-alpha.10"> |
| <link rel="stylesheet" href="./_/css/site.css"> |
| <link rel="icon" href="./_/../_images/favicon.ico" type="image/x-icon"> |
| <!-- `@asciidoctor/tabs` extension styles --> |
| <link rel="stylesheet" href="./_/css/vendor/tabs.css"> |
| <style> |
| /* Swap colors of `IMPORTANT` and `WARNING` blocks */ |
| .doc .admonitionblock.important .icon { background-color: #f70; } |
| .doc .admonitionblock.warning .icon { background-color: #e40046; } |
| /* Default `h4`, `h5`, and `h6` are smaller than the normal text, fix header font sizing: */ |
| .doc h1 { font-size: 1.9rem; } |
| .doc h2 { font-size: 1.7rem; } |
| .doc h3 { font-size: 1.5rem; font-weight: 400; } |
| .doc h4 { font-size: 1.3rem; font-weight: 500; } |
| .doc h5 { font-size: 1.1rem; font-weight: 500; text-decoration: underline; } |
| .doc h6 { font-size: 0.9rem; font-weight: 500; text-decoration: underline; } |
| /* Default `code`, `pre`, and `.colist` (source code annotations) fonts are too big, adjust them: */ |
| .doc .colist>table code, .doc p code, .doc thead code { font-size: 0.8em; } |
| .doc pre { font-size: 0.7rem; } |
| .doc .colist { font-size: 0.75rem; } |
| /* Make links more visible: */ |
| .doc a { text-decoration: underline; } |
| .doc a code { text-decoration: underline; color: #1565c0; } |
| /* Tab header fonts aren't rendered good, adjusting the font weight: */ |
| .tablist > ul li { font-weight: 500; } |
| /* `page-toclevels` greater than 4 are not supported by Antora UI, patching it: */ |
| .toc .toc-menu li[data-level="4"] a { |
| padding-left: 2.75rem; |
| } |
| /* Replace the default highlight.js color for strings from red (unnecessarily signaling something negative) to green: */ |
| .hljs-string { |
| color: #0f8532; |
| } |
| /* Colors for maintenance policies */ |
| .development { color: #8A4FFF; } |
| .active { color: #28A745; } |
| .eom { color: #FFC107; } |
| .eol { color: #DC3545; } |
| </style> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <div class="navbar-item"> |
| <img src="./_/../_images/logo-small-white.png" alt="Apache Log4j"/> |
| </div> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <div class="navbar-end"> |
| <a class="navbar-item" href="https://logging.apache.org">a subproject of <strong>Apache Logging Services</strong></a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body"> |
| <div class="nav-container" data-component="ROOT" data-version=""> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <button class="nav-menu-toggle" aria-label="Toggle expand/collapse all" style="display: none"></button> |
| <h3 class="title"><a href="index.html">Home</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="download.html">Download</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="release-notes.html">Release notes</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="https://logging.apache.org/support.html">Support</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="versioning.html">Versioning and maintenance policy</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="https://logging.apache.org/security.html">Security</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/index.html">Manual</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="manual/getting-started.html">Getting started</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="manual/installation.html">Installation</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/api.html">API</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/api.html#loggers">Loggers</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/eventlogging.html">Event Logger</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/simple-logger.html">Simple Logger</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/status-logger.html">Status Logger</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="manual/logbuilder.html">Fluent API</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/api.html#fish-tagging">Fish tagging</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/customloglevels.html">Levels</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/markers.html">Markers</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/thread-context.html">Thread Context</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="manual/messages.html">Messages</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="manual/flowtracing.html">Flow Tracing</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/implementation.html">Implementation</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="manual/architecture.html">Architecture</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/config-intro.html">Configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/configuration.html">Configuration file</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/systemproperties.html">Configuration properties</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/customconfig.html">Programmatic configuration</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/appenders.html">Appenders</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/file.html">File appenders</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/rolling-file.html">Rolling file appenders</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/database.html">Database appenders</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/network.html">Network Appenders</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/message-queue.html">Message queue appenders</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/appenders/delegating.html">Delegating Appenders</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/layouts.html">Layouts</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/json-template-layout.html">JSON Template Layout</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="manual/pattern-layout.html">Pattern Layout</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/lookups.html">Lookups</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/filters.html">Filters</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/scripts.html">Scripts</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/jmx.html">JMX</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/extending.html">Extending</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/plugins.html">Plugins</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="manual/performance.html">Performance</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/async.html">Asynchronous loggers</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="manual/garbagefree.html">Garbage-free logging</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">References</span> |
| <ul class="nav-list"> |
| <li class="nav-item is-current-page" data-depth="1"> |
| <a class="nav-link" href="plugin-reference.html">Plugin reference</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="javadoc.html">Java API reference</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Resources</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="faq.html">F.A.Q.</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="migrate-from-log4j1.html">Migrating from Log4j 1</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="migrate-from-logback.html">Migrating from Logback</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="migrate-from-slf4j.html">Migrating from SLF4J</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="graalvm.html">Building GraalVM native images</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="hibernate.html">Integrating with Hibernate</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="jakarta.html">Integrating with Jakarta EE</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="soa.html">Integrating with service-oriented architectures</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="development.html">Development</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="components.html">Components</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="log4j-iostreams.html">Log4j IOStreams</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="log4j-spring-boot.html">Log4j Spring Boot Support</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="log4j-spring-cloud-config-client.html">Log4j Spring Cloud Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="log4j-jul.html">JUL-to-Log4j bridge</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="log4j-to-jul.html">Log4j-to-JUL bridge</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="0"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Related projects</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="https://logging.apache.org/log4j/jmx-gui/index.html">Log4j JMX GUI</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="https://logging.apache.org/log4j/kotlin/index.html">Log4j Kotlin</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="https://logging.apache.org/log4j/tools/index.html">Log4j Tools</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="https://logging.apache.org/log4j/transform/index.html">Log4j Transformation Tools</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main class="article"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="index.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="index.html">Home</a></li> |
| <li>References</li> |
| <li><a href="plugin-reference.html">Plugin reference</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/apache/logging-log4j2/edit/2.x/src/site/antora/modules/ROOT/pages/plugin-reference.adoc">Edit this Page</a></div> |
| </div> |
| <div class="content"> |
| <aside class="toc sidebar" data-title="Contents" data-levels="3"> |
| <div class="toc-menu"></div> |
| </aside> |
| <article class="doc"> |
| <h1 class="page">Plugin reference</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This page is a Javadoc-on-steroids specialized for Log4j plugins. |
| This reference manual is derived from the source code of all Log4j plugins and types associated with them. |
| You can use this reference manual to precisely customize your <code>log4j2.xml</code>.</p> |
| </div> |
| <div class="admonitionblock tip"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-tip" title="Tip"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>Every running Log4j system is a constellation of <a href="manual/plugins.html">plugins</a>, which is analogous to beans in Java EE and Spring. |
| This not only allows Log4j itself to be developed in individual components, but also enables extensibility users can leverage.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="shortcuts"><a class="anchor" href="#shortcuts"></a>Shortcuts</h2> |
| <div class="sectionbody"> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration">The <code><Configuration></code> element assembly in a <code>log4j2.xml</code></a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender">The type hierarchy of <strong>appenders</strong></a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">The type hierarchy of <strong>layouts</strong></a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">The type hierarchy of <strong>filters</strong></a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="index"><a class="anchor" href="#index"></a>Index</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Below is a list of all types reachable by plugins grouped by the Maven coordinate of the artifact bundling them.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-1-2-api"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api"></a><code>log4j-1.2-api</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-AbstractBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-AbstractBuilder"></a><code>AbstractBuilder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.AbstractBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Base class for Log4j 1 component builders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-AbstractBuilder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-AbstractBuilder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder">AsyncAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder">ConsoleAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder">DailyRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder">EnhancedRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder">FileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder">RewriteAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder">RollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder">SocketAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder">SyslogAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder">LevelMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder">LevelRangeFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder">StringMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder">HtmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder">PatternLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder">TTCCLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder">XmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder">CompositeTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder">SizeBasedTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder">TimeBasedRollingPolicyBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Builder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Builder"></a><code>Builder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.Builder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A marker interface for Log4j 1.x component builders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Builder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Builder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder">AsyncAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder">ConsoleAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder">DailyRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder">EnhancedRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder">FileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder">NullAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder">RewriteAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder">RollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder">SocketAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder">SyslogAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder">DenyAllFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder">LevelMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder">LevelRangeFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder">StringMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder">HtmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder">PatternLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder">SimpleLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder">TTCCLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder">XmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder">CompositeTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder">SizeBasedTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder">TimeBasedRollingPolicyBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Parser"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Parser"></a><code>Parser</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.Parser</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Parses DOM and properties.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Parser_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-Parser_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder">DenyAllFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder">LevelMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder">LevelRangeFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder">StringMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder">HtmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder">PatternLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder">SimpleLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder">TTCCLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder">XmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder">CompositeTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder">SizeBasedTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder">TimeBasedRollingPolicyBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AppenderBuilder"></a><code>AppenderBuilder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.AppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Define an Appender Builder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AppenderBuilder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AppenderBuilder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder">AsyncAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder">ConsoleAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder">DailyRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder">EnhancedRollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder">FileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder">NullAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder">RewriteAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder">RollingFileAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder">SocketAppenderBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder">SyslogAppenderBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder"></a>org.apache.log4j.AsyncAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.AsyncAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build an Async Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-AsyncAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.AsyncAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder"></a>org.apache.log4j.ConsoleAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.ConsoleAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Console Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-ConsoleAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.ConsoleAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder"></a>org.apache.log4j.DailyRollingFileAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.DailyRollingFileAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Daily Rolling File Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-DailyRollingFileAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.DailyRollingFileAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder"></a>org.apache.log4j.rolling.RollingFileAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.EnhancedRollingFileAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a File Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-EnhancedRollingFileAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.rolling.RollingFileAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder"></a>org.apache.log4j.FileAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.FileAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a File Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-FileAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.FileAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder"></a>org.apache.log4j.varia.NullAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.NullAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Null Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-NullAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.varia.NullAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder"></a>org.apache.log4j.rewrite.RewriteAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.RewriteAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Rewrite Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RewriteAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.rewrite.RewriteAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder"></a>org.apache.log4j.RollingFileAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.RollingFileAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a File Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-RollingFileAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.RollingFileAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder"></a>org.apache.log4j.net.SocketAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.SocketAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Console Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SocketAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.net.SocketAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder"></a>org.apache.log4j.net.SyslogAppender</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.appender.SyslogAppenderBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a File Appender</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-appender-SyslogAppenderBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.net.SyslogAppender/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder"></a>org.apache.log4j.varia.DenyAllFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.filter.DenyAllFilterBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Pattern Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.varia.DenyAllFilter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-FilterBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-FilterBuilder"></a><code>FilterBuilder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.filter.FilterBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Define a Filter Builder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-FilterBuilder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-FilterBuilder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-DenyAllFilterBuilder">DenyAllFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder">LevelMatchFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder">LevelRangeFilterBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder">StringMatchFilterBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder"></a>org.apache.log4j.varia.LevelMatchFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.filter.LevelMatchFilterBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Level match filter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelMatchFilterBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.varia.LevelMatchFilter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder"></a>org.apache.log4j.varia.LevelRangeFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.filter.LevelRangeFilterBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Level range filter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In this class, order of <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> is log4j1 way, i.e., <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> and <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> have minimum and maximum order, respectively. |
| (see: LOG4J2-2315)</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-LevelRangeFilterBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.varia.LevelRangeFilter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder"></a>org.apache.log4j.varia.StringMatchFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.filter.StringMatchFilterBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a String match filter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-filter-StringMatchFilterBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.varia.StringMatchFilter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder"></a>org.apache.log4j.HTMLLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.HtmlLayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Pattern Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.HTMLLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-LayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-LayoutBuilder"></a><code>LayoutBuilder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.LayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Define a Layout Builder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-LayoutBuilder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-LayoutBuilder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-HtmlLayoutBuilder">HtmlLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder">PatternLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder">SimpleLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder">TTCCLayoutBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder">XmlLayoutBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder"></a>org.apache.log4j.PatternLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.PatternLayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Pattern Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-PatternLayoutBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.PatternLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder"></a>org.apache.log4j.SimpleLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.SimpleLayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Pattern Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-SimpleLayoutBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.SimpleLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder"></a>org.apache.log4j.TTCCLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.TTCCLayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build a Pattern Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-TTCCLayoutBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.TTCCLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder"></a>org.apache.log4j.xml.XMLLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.layout.XmlLayoutBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Build an XML Layout</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-layout-XmlLayoutBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.xml.XMLLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder"></a>org.apache.log4j.rolling.CompositeTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.rolling.CompositeTriggeringPolicyBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.rolling.CompositeTriggeringPolicy/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder"></a>org.apache.log4j.rolling.SizeBasedTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.rolling.SizeBasedTriggeringPolicyBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.rolling.SizeBasedTriggeringPolicy/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder"></a>org.apache.log4j.rolling.TimeBasedRollingPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.rolling.TimeBasedRollingPolicyBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><org.apache.log4j.rolling.TimeBasedRollingPolicy/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TriggeringPolicyBuilder"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TriggeringPolicyBuilder"></a><code>TriggeringPolicyBuilder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.builders.rolling.TriggeringPolicyBuilder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TriggeringPolicyBuilder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TriggeringPolicyBuilder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-CompositeTriggeringPolicyBuilder">CompositeTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-SizeBasedTriggeringPolicyBuilder">SizeBasedTriggeringPolicyBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-builders-rolling-TimeBasedRollingPolicyBuilder">TimeBasedRollingPolicyBuilder</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory"></a>Log4j1PropertiesConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.config.PropertiesConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configures Log4j from a log4j 1 format properties file.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1PropertiesConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout"></a>Log4j1SyslogLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.layout.Log4j1SyslogLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Port of the layout used by SyslogAppender in Log4j 1.x.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Provided for compatibility with existing Log4j 1 configurations. |
| Originally developed by Ceki Glc and Anders Kristensen.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1SyslogLayout charset="" |
| facility="" |
| facilityPrinting="" |
| footer="" |
| header=""> |
| <a-Layout-implementation/> |
| <a-Serializer-implementation/> |
| </Log4j1SyslogLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>facility</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility">Facility</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>facilityPrinting</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout"></a>Log4j1XmlLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.layout.Log4j1XmlLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Port of XMLLayout in Log4j 1.x.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Provided for compatibility with existing Log4j 1 configurations. |
| Originally developed by Ceki Glc, Mathias Bogaert.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1XmlLayout locationInfo="" |
| properties=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>properties</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter"></a>Log4j1LevelPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.pattern.Log4j1LevelPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Outputs the Log4j 1.x level name.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1LevelPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter"></a>Log4j1MdcPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.pattern.Log4j1MdcPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Able to handle the contents of the LogEvent’s MDC and either output the entire contents of the properties, or to output the value of a specific key within the property bundle when this pattern converter has the option set.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1MdcPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter"></a>Log4j1NdcPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.pattern.Log4j1NdcPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s NDC in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1NdcPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory"></a>Log4j1XmlConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.log4j.xml.XmlConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-1.2-api</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Constructs a Configuration usable in Log4j 2 from a Log4j 1 configuration file.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Log4j1XmlConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-cassandra"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra"></a><code>log4j-cassandra</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-cassandra_com-datastax-driver-core-BatchStatement-Type"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra_com-datastax-driver-core-BatchStatement-Type"></a><code>Type</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>com.datastax.driver.core.BatchStatement.Type</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-cassandra</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender"></a>Cassandra</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.cassandra.CassandraAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-cassandra</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appender plugin that uses a Cassandra database.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Cassandra batched="" |
| batchType="" |
| bufferSize="" |
| clusterName="" |
| ignoreExceptions="" |
| keyspace="" |
| name="" |
| password="" |
| table="" |
| useClockForTimestampGenerator="" |
| username="" |
| useTls=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <ColumnMapping/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| <SocketAddress/><!-- multiple occurrences allowed --> |
| </Cassandra></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>batched</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether or not to use batch statements when inserting records.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>batchType</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-cassandra_com-datastax-driver-core-BatchStatement-Type">Type</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If batch statements are enabled, use this type of batch statement.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Number of LogEvents to buffer before writing.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Can be used with or without batch statements.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>clusterName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyspace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>table</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>useClockForTimestampGenerator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Override the default TimestampGenerator with one based on the configured <code>org.apache.logging.log4j.core.util.Clock</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>username</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>useTls</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ColumnMapping</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping">ColumnMapping</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>List of column mappings to convert a LogEvent into a database row.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SocketAddress</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress">SocketAddress</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>List of Cassandra node contact points.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Addresses without a port (or port set to 0) will use the default Cassandra port (9042).</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-core"><a class="anchor" href="#org-apache-logging-log4j_log4j-core"></a><code>log4j-core</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_com-conversantmedia-util-concurrent-SpinPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_com-conversantmedia-util-concurrent-SpinPolicy"></a><code>SpinPolicy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>com.conversantmedia.util.concurrent.SpinPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-commons-csv-QuoteMode"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-commons-csv-QuoteMode"></a><code>QuoteMode</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.commons.csv.QuoteMode</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level"></a><code>Level</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.Level</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Represents a logging level. |
| NOTE: The Log4j API supports custom levels, the following list contains only the standard ones.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-AbstractLifeCycle"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-AbstractLifeCycle"></a><code>AbstractLifeCycle</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.AbstractLifeCycle</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A life cycle to be extended.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Wraps a <code>org.apache.logging.log4j.core.LifeCycle.State</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-AbstractLifeCycle_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-AbstractLifeCycle_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource">DataSourceConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource">FactoryMethodConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy">CompositeTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy">CronTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy">NoOpTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy">OnStartupTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy">TimeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy">IdlePurgePolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter">BurstFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter">CompositeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter">DenyAllFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter">DynamicThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter">LevelMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter">MapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter">MarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter">MutableThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter">NoMarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter">RegexFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter">ScriptFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter">StringMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter">TimeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender"></a><code>Appender</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.Appender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends <code>org.apache.logging.log4j.core.LogEvent</code>s.</p> |
| </div> |
| <div class="paragraph"> |
| <p>An Appender can contain a <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-core-Layout">Layout</a> if applicable as well as an <code>org.apache.logging.log4j.core.ErrorHandler</code>. Typical Appender implementations coordinate with an implementation of <code>org.apache.logging.log4j.core.appender.AbstractManager</code> to handle external resources such as streams, connections, and other shared state. |
| As Appenders are plugins, concrete implementations need to be annotated with <code>org.apache.logging.log4j.core.config.plugins.Plugin</code> and need to provide a static factory method annotated with <code>org.apache.logging.log4j.core.config.plugins.PluginFactory</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Most core plugins are written using a related Manager class that handle the actual task of serializing a <code>org.apache.logging.log4j.core.LogEvent</code> to some output location. |
| For instance, many Appenders can take advantage of the <code>org.apache.logging.log4j.core.appender.OutputStreamManager</code> class.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It is recommended that Appenders don’t do any heavy lifting since there can be many instances of the class being used at any given time. |
| When resources require locking (e.g., through <code>org.apache.logging.log4j.core.java.nio.channels.FileLock</code>), it is important to isolate synchronized code to prevent concurrency issues.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter"></a><code>Filter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.Filter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface that must be implemented to allow custom event filtering.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It is highly recommended that applications make use of the Filters provided with this implementation before creating their own.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This interface supports "global" filters (i.e. - all events must pass through them first), attached to specific loggers and associated with Appenders. |
| It is recommended that, where possible, Filter implementations create a generic filtering method that can be called from any of the filter methods.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter">BurstFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter">CompositeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter">DenyAllFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter">DynamicThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter">LevelMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter">MapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter">MarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter">MutableThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter">NoMarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter">RegexFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter">ScriptFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter">StringMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter">TimeFilter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result"></a><code>Result</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.Filter.Result</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The result that can returned from a filter method call.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout"></a><code>Layout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.Layout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lays out a <code>org.apache.logging.log4j.core.LogEvent</code> in different formats.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The formats are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>byte[]</code></p> |
| </li> |
| <li> |
| <p>an implementer of <code>java.io.Serializable</code>, like <code>byte[]</code></p> |
| </li> |
| <li> |
| <p><code>java.lang.String</code></p> |
| </li> |
| <li> |
| <p><code>org.apache.logging.log4j.core.LogEvent</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Since 2.6, Layouts can <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-core-layout-Encoder">encode</a> a <code>LogEvent</code> directly to a <code>org.apache.logging.log4j.core.layout.ByteBufferDestination</code> without creating temporary intermediary objects.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout">MessageLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout">SerializedLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout">JsonTemplateLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle"></a><code>LifeCycle</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.LifeCycle</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>All proper Java frameworks implement some sort of object life cycle.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In Log4j, the main interface for handling the life cycle context of an object is this one. |
| An object first starts in the <code>org.apache.logging.log4j.core.State#INITIALIZED</code> state by default to indicate the class has been loaded. |
| From here, calling the <a href="#org-apache-logging-log4j_log4j-fuzz-test_org-apache-logging-log4j-core-LifeCycle">LifeCycle</a> method will change this state to <code>org.apache.logging.log4j.core.State#STARTING</code>. After successfully being started, this state is changed to <code>org.apache.logging.log4j.core.State#STARTED</code>. When the <a href="#org-apache-logging-log4j_log4j-fuzz-test_org-apache-logging-log4j-core-LifeCycle">LifeCycle</a> is called, this goes into the <code>org.apache.logging.log4j.core.State#STOPPING</code> state. |
| After successfully being stopped, this goes into the <code>org.apache.logging.log4j.core.State#STOPPED</code> state. |
| In most circumstances, implementation classes should store their <code>org.apache.logging.log4j.core.State</code> in a <code>volatile</code> field or inside an <code>org.apache.logging.log4j.core.java.util.concurrent.atomic.AtomicReference</code> dependent on synchronization and concurrency requirements.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource">DataSourceConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource">FactoryMethodConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy">CompositeTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy">CronTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy">NoOpTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy">OnStartupTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy">TimeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy">IdlePurgePolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter">BurstFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter">CompositeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter">DenyAllFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter">DynamicThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter">LevelMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter">MapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter">MarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter">MutableThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter">NoMarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter">RegexFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter">ScriptFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter">StringMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter">TimeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle2"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle2"></a><code>LifeCycle2</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.LifeCycle2</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Extends the LifeCycle interface.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This interface should be merged with the super-interface in 3.0.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle2_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-LifeCycle2_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource">DataSourceConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource">FactoryMethodConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy">CompositeTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy">CronTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy">NoOpTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy">OnStartupTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy">TimeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy">IdlePurgePolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter">BurstFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter">CompositeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter">DenyAllFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter">DynamicThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter">LevelMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter">MapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter">MarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter">MutableThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter">NoMarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter">RegexFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter">ScriptFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter">StringMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter">TimeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-StringLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-StringLayout"></a><code>StringLayout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.StringLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Instantiates the <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-core-Layout">Layout</a> type for String-based layouts.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-StringLayout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-StringLayout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout">JsonTemplateLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractAppender"></a><code>AbstractAppender</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.AbstractAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract base class for Appenders.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Although Appenders do not have to extend this class, doing so will simplify their implementation.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractAppender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractAppender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractOutputStreamAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractOutputStreamAppender"></a><code>AbstractOutputStreamAppender</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends log events as bytes to a byte output stream.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The stream encoding is defined in the layout.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractOutputStreamAppender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractOutputStreamAppender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractWriterAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractWriterAppender"></a><code>AbstractWriterAppender</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.AbstractWriterAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends log events as strings to a writer.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractWriterAppender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AbstractWriterAppender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AppenderSet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AppenderSet"></a>AppenderSet</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.AppenderSet</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A deferred plugin for appenders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AppenderSet_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AppenderSet_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><AppenderSet/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender"></a>Async</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.AsyncAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends to one or more Appenders asynchronously.</p> |
| </div> |
| <div class="paragraph"> |
| <p>You can configure an AsyncAppender with one or more Appenders and an Appender to append to if the queue is full. |
| The AsyncAppender does not allow a filter to be specified on the Appender references.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Async blocking="" |
| bufferSize="" |
| errorRef="" |
| ignoreExceptions="" |
| includeLocation="" |
| name="" |
| shutdownTimeout=""> |
| <a-Filter-implementation/> |
| <a-BlockingQueueFactory-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| </Async></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>blocking</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>errorRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>shutdownTimeout</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory">BlockingQueueFactory</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender"></a>Console</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.ConsoleAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends log events to <code>System. out</code> or <code>System. err</code> using a layout specified by the user.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default target is <code>System. out</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>TODO Accessing <code>System. out</code> or <code>System. err</code> as a byte stream instead of a writer bypasses the JVM’s knowledge of the proper encoding. |
| (RG) Encoding is handled within the Layout. |
| Typically, a Layout will generate a String and then call getBytes which may use a configured encoding or the system default. |
| OTOH, a Writer cannot print byte streams.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Console bufferedIo="" |
| bufferSize="" |
| direct="" |
| follow="" |
| ignoreExceptions="" |
| immediateFlush="" |
| name="" |
| target=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </Console></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>direct</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>follow</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>target</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender-Target">Target</a></code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender-Target"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender-Target"></a><code>Target</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.ConsoleAppender.Target</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Enumeration of console destinations.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender"></a>CountingNoOp</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.CountingNoOpAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>No-Operation Appender that counts events.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CountingNoOp name=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender"></a>Failover</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.FailoverAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The FailoverAppender will capture exceptions in an Appender and then route the event to a different appender.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Hopefully it is obvious that the Appenders must be configured to not suppress exceptions for the FailoverAppender to work.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Failover ignoreExceptions="" |
| name="" |
| primary="" |
| retryIntervalSeconds=""> |
| <a-String-implementation/><!-- multiple occurrences allowed --> |
| <a-Filter-implementation/> |
| </Failover></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If <code>"true"</code> (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the Appender (required).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>primary</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the primary Appender (required).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>retryIntervalSeconds</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The retry interval in seconds.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of one or more Appenders to fail over to (at least one is required).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>A Filter (optional).</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin"></a>Failovers</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.FailoversPlugin</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The array of failover Appenders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Failovers/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoversPlugin_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The references to return.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender"></a>File</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.FileAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>File Appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><File advertise="" |
| advertiseUri="" |
| append="" |
| bufferedIo="" |
| bufferSize="" |
| createOnDemand="" |
| fileGroup="" |
| fileName="" |
| fileOwner="" |
| filePermissions="" |
| ignoreExceptions="" |
| immediateFlush="" |
| locking="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </File></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertiseUri</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>append</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>createOnDemand</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileGroup</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileOwner</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePermissions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locking</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender"></a>Http</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.HttpAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Http connectTimeoutMillis="" |
| ignoreExceptions="" |
| method="" |
| name="" |
| readTimeoutMillis="" |
| url="" |
| verifyHostname=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| <Ssl/> |
| </Http></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectTimeoutMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>method</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>readTimeoutMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>url</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>URL</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>verifyHostname</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Ssl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration">SslConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender"></a>MemoryMappedFile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.MemoryMappedFileAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Memory Mapped File Appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MemoryMappedFile advertise="" |
| advertiseURI="" |
| append="" |
| bufferedIo="" |
| bufferSize="" |
| fileName="" |
| ignoreExceptions="" |
| immediateFlush="" |
| name="" |
| regionLength=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </MemoryMappedFile></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertiseURI</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>append</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>regionLength</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender"></a>Null</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.NullAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An Appender that ignores log events.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use for compatibility with version 1.2 and handy for composing a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Null name=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender"></a>OutputStream</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.OutputStreamAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends log events to a given output stream using a layout.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Character encoding is handled within the Layout.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><OutputStream bufferedIo="" |
| bufferSize="" |
| ignoreExceptions="" |
| immediateFlush="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </OutputStream></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender"></a>RandomAccessFile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.RandomAccessFileAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>File Appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RandomAccessFile advertise="" |
| advertiseURI="" |
| append="" |
| bufferedIo="" |
| bufferSize="" |
| fileName="" |
| ignoreExceptions="" |
| immediateFlush="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </RandomAccessFile></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertiseURI</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>append</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender"></a>RollingFile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.RollingFileAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An appender that writes to files and can roll over at intervals.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RollingFile advertise="" |
| advertiseUri="" |
| append="" |
| bufferedIo="" |
| bufferSize="" |
| createOnDemand="" |
| fileGroup="" |
| fileName="" |
| fileOwner="" |
| filePattern="" |
| filePermissions="" |
| ignoreExceptions="" |
| immediateFlush="" |
| locking="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <a-RolloverStrategy-implementation/> |
| <a-TriggeringPolicy-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </RollingFile></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertiseUri</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>append</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>createOnDemand</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileGroup</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileOwner</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePermissions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locking</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy">RolloverStrategy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy">TriggeringPolicy</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender"></a>RollingRandomAccessFile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.RollingRandomAccessFileAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An appender that writes to random access files and can roll over at intervals.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RollingRandomAccessFile advertise="" |
| advertiseURI="" |
| append="" |
| bufferedIo="" |
| bufferSize="" |
| fileGroup="" |
| fileName="" |
| fileOwner="" |
| filePattern="" |
| filePermissions="" |
| ignoreExceptions="" |
| immediateFlush="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <a-RolloverStrategy-implementation/> |
| <a-TriggeringPolicy-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </RollingRandomAccessFile></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertiseURI</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>append</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileGroup</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileOwner</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePermissions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy">RolloverStrategy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy">TriggeringPolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector"></a>ScriptAppenderSelector</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.ScriptAppenderSelector</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptAppenderSelector name=""> |
| <AppenderSet/> |
| <a-AbstractScript-implementation/> |
| </ScriptAppenderSelector></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderSet</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AppenderSet">AppenderSet</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender"></a>SMTP</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.SmtpAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The number of logging events delivered in this e-mail depend on the value of <strong>BufferSize</strong> option. |
| The <code>SmtpAppender</code> keeps only the last <code>BufferSize</code> logging events in its cyclic buffer. |
| This keeps memory requirements at a reasonable level while still delivering useful application context. |
| By default, an email message will formatted as HTML. |
| This can be modified by setting a layout for the appender. |
| By default, an email message will be sent when an ERROR or higher severity message is appended. |
| This can be modified by setting a filter for the appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SMTP bcc="" |
| bufferSize="" |
| cc="" |
| from="" |
| ignoreExceptions="" |
| name="" |
| replyTo="" |
| smtpDebug="" |
| smtpHost="" |
| smtpPassword="" |
| smtpPort="" |
| smtpProtocol="" |
| smtpUsername="" |
| subject="" |
| to=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| <Ssl/> |
| </SMTP></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bcc</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Comma-separated list of BCC email addresses.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Number of log events to buffer before sending an email.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to .</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cc</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Comma-separated list of CC email addresses.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>from</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Email address of the sender.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>replyTo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Comma-separated list of Reply-To email addresses.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpDebug</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Enables or disables mail session debugging on STDOUT.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Disabled by default.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpHost</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Host name of SMTP server to send messages through.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpPassword</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Password to authenticate with SMTP server.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpPort</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Port number of SMTP server to send messages through.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpProtocol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Transport protocol to use for SMTP such as "smtp" or "smtps".</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to "smtp".</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>smtpUsername</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Username to authenticate with SMTP server.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>subject</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Subject template for the email messages.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>to</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Comma-separated list of recipient email addresses.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Specifies the filter used for this appender.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, uses a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a> with a level of ERROR.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Specifies the layout used for the email message body.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, this uses the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">default HTML layout</a>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Ssl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration">SslConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Specifies an SSL configuration for smtps connections.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender"></a>Socket</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.SocketAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An Appender that delivers events over socket connections.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Supports both TCP and UDP.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Socket advertise="" |
| bufferedIo="" |
| bufferSize="" |
| connectTimeoutMillis="" |
| host="" |
| ignoreExceptions="" |
| immediateFail="" |
| immediateFlush="" |
| name="" |
| port="" |
| protocol="" |
| reconnectDelayMillis=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| <SocketOptions/> |
| <Ssl/> |
| </Socket></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectTimeoutMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>host</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFail</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>port</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>protocol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Protocol">Protocol</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectDelayMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SocketOptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions">SocketOptions</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Ssl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration">SslConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender"></a>Syslog</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.SyslogAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The Syslog Appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Syslog advertise="" |
| appName="" |
| bufferedIo="" |
| bufferSize="" |
| charset="" |
| connectTimeoutMillis="" |
| enterpriseNumber="" |
| eventPrefix="" |
| exceptionPattern="" |
| facility="" |
| format="" |
| host="" |
| id="" |
| ignoreExceptions="" |
| immediateFail="" |
| immediateFlush="" |
| includeMdc="" |
| mdcExcludes="" |
| mdcId="" |
| mdcIncludes="" |
| mdcPrefix="" |
| mdcRequired="" |
| messageId="" |
| name="" |
| newLine="" |
| newLineEscape="" |
| port="" |
| protocol="" |
| reconnectDelayMillis=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| <LoggerFields/><!-- multiple occurrences allowed --> |
| <SocketOptions/> |
| <Ssl/> |
| </Syslog></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>advertise</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>appName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferedIo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectTimeoutMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>enterpriseNumber</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>exceptionPattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>facility</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility">Facility</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>format</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>host</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFail</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFlush</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeMdc</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcExcludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcIncludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcRequired</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>messageId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>newLine</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>newLineEscape</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>port</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>protocol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Protocol">Protocol</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectDelayMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LoggerFields</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields">LoggerFields</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SocketOptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions">SocketOptions</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Ssl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration">SslConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender"></a>Writer</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.WriterAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends log events to a <code>java.io.Writer</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Writer ignoreExceptions="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </Writer></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-AbstractDatabaseAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-AbstractDatabaseAppender"></a><code>AbstractDatabaseAppender</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An abstract Appender for writing events to a database of some type, be it relational or NoSQL.</p> |
| </div> |
| <div class="paragraph"> |
| <p>All database appenders should inherit from this base appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-AbstractDatabaseAppender_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-AbstractDatabaseAppender_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping"></a>ColumnMapping</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.ColumnMapping</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A configuration element for specifying a database column name mapping.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ColumnMapping columnType="" |
| literal="" |
| name="" |
| parameter="" |
| pattern="" |
| source="" |
| type=""> |
| <a-StringLayout-implementation/> |
| </ColumnMapping></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>columnType</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Class</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Class to convert value to before storing in database.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If the type is compatible with <code>org.apache.logging.log4j.spi.ThreadContextMap</code> or <code>org.apache.logging.log4j.util.ReadOnlyStringMap</code>, then the MDC will be used. |
| If the type is compatible with <code>org.apache.logging.log4j.spi.ThreadContextStack</code>, then the NDC will be used. |
| If the type is compatible with <code>java.util.Date</code>, then the event timestamp will be used.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>literal</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Literal value to use for populating a column.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is generally useful for functions, stored procedures, etc. |
| No escaping will be done on this value.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Column name.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>parameter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Parameter value to use for populating a column, MUST contain a single parameter marker '?'.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is generally useful for functions, stored procedures, etc. |
| No escaping will be done on this value.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Pattern to use as a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Convenient shorthand for <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping">ColumnMapping</a> with a PatternLayout.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>source</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Source name.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Useful when combined with a <code>org.apache.logging.log4j.core.appender.db.org.apache.logging.log4j.message.MapMessage</code> depending on the appender.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Class?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-StringLayout">StringLayout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Layout of value to write to database (before type conversion).</p> |
| </div> |
| <div class="paragraph"> |
| <p>Not applicable if <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping">ColumnMapping</a> is a <code>org.apache.logging.log4j.util.ReadOnlyStringMap</code>, <code>org.apache.logging.log4j.spi.ThreadContextMap</code>, or <code>org.apache.logging.log4j.spi.ThreadContextStack</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractConnectionSource"></a><code>AbstractConnectionSource</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.AbstractConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractConnectionSource_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractConnectionSource_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource">DataSourceConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource">FactoryMethodConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractDriverManagerConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractDriverManagerConnectionSource"></a><code>AbstractDriverManagerConnectionSource</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource">ConnectionSource</a> that uses a JDBC connection string, a user name, and a password to call <code>java.sql.DriverManager#getConnection(String,String,String)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This plugin does not provide any connection pooling unless it is available through the connection string and driver itself. |
| This handy to get you off the ground without having to deal with JNDI.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractDriverManagerConnectionSource_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-AbstractDriverManagerConnectionSource_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig"></a>Column</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A configuration element used to configure which event properties are logged to which columns in the database table.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Column isClob="" |
| isEventTimestamp="" |
| isUnicode="" |
| literal="" |
| name="" |
| pattern=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isClob</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isEventTimestamp</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isUnicode</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>literal</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The literal value to insert into the column as-is without any quoting or escaping.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Mutually exclusive with <code>pattern! =null</code> and <code>eventTimestamp=true</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the database column as it exists within the database table.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a> pattern to insert in this column.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Mutually exclusive with <code>literal! =null</code> and <code>eventTimestamp=true</code></p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource"></a><code>ConnectionSource</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configuration element for <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you want to use the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a> but none of the provided connection sources meet your needs, you can simply create your own connection source.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource">DataSourceConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource">DriverManagerConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource">FactoryMethodConnectionSource</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource">PoolingDriverConnectionSource</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource"></a>DataSource</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a> connection source that uses a <code>javax.sql.DataSource</code> to connect to the database.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DataSource jndiName=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DataSourceConnectionSource-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>jndiName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The full JNDI path where the data source is bound. |
| Must start with java:/comp/env or environment-equivalent.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource"></a>DriverManager</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource">ConnectionSource</a> that uses a JDBC connection string, a user name, and a password to call <code>java.sql.DriverManager#getConnection(String,String,String)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This plugin does not provide any connection pooling unless it is available through the connection string and driver itself. |
| This handy to get you off the ground without having to deal with JNDI.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DriverManager connectionString="" |
| driverClassName="" |
| password="" |
| userName=""> |
| <Property/><!-- multiple occurrences allowed --> |
| </DriverManager></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectionString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>driverClassName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>userName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-DriverManagerConnectionSource_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource"></a>ConnectionFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a> connection source that uses a public static factory method to obtain a <code>java.sql.Connection</code> or <code>javax.sql.DataSource</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ConnectionFactory class="" |
| method=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-FactoryMethodConnectionSource-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>class</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of a public class that contains a static method capable of returning either a <code>javax.sql.DataSource</code> or a <code>java.sql.Connection</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>method</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the public static method on the aforementioned class that returns the data source or connection. |
| If this method returns a <code>java.sql.Connection</code>, it should return a new connection every call.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender"></a>JDBC</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender writes logging events to a relational database using standard JDBC mechanisms.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It takes a list of <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig">ColumnConfig</a>s and/or <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping">ColumnMapping</a>s with which it determines how to save the event data into the appropriate columns in the table. |
| ColumnMapping is new as of Log4j 2.8 and supports <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-core-config-plugins-convert-TypeConverter">type conversion</a> and persistence using <code>java.sql.PreparedStatement#setObject(int,Object)</code>. A <a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource">ConnectionSource</a> plugin instance instructs the appender (and <code>org.apache.logging.log4j.core.appender.db.jdbc.JdbcDatabaseManager</code>) how to connect to the database. |
| This appender can be reconfigured at run time.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JDBC bufferSize="" |
| ignoreExceptions="" |
| immediateFail="" |
| name="" |
| reconnectIntervalMillis="" |
| tableName="" |
| truncateStrings=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <ColumnMapping/><!-- multiple occurrences allowed --> |
| <Column/><!-- multiple occurrences allowed --> |
| <a-ConnectionSource-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </JDBC></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If an integer greater than 0, this causes the appender to buffer log events and flush whenever the buffer reaches this size.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFail</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectIntervalMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tableName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the database table to insert log events into.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>truncateStrings</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ColumnMapping</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-ColumnMapping">ColumnMapping</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Column</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ColumnConfig">ColumnConfig</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Information about the columns that log event data should be inserted into and how to insert that data.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource">ConnectionSource</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The connections source from which database connections should be retrieved.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender"></a>JMS-Javax</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.mom.JmsAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Javax JMS Appender plugin.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender replaces the previous split classes. |
| Configurations set up for the 2.0 version of the JMS appenders will still work.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JMS-Javax destinationBindingName="" |
| factoryBindingName="" |
| factoryName="" |
| ignoreExceptions="" |
| immediateFail="" |
| name="" |
| password="" |
| providerUrl="" |
| reconnectIntervalMillis="" |
| securityCredentials="" |
| securityPrincipalName="" |
| urlPkgPrefixes="" |
| userName=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </JMS-Javax></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>destinationBindingName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryBindingName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFail</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>providerUrl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectIntervalMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityCredentials</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityPrincipalName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>urlPkgPrefixes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>userName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender"></a>JeroMQ</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.mom.jeromq.JeroMqAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Sends log events to one or more ZeroMQ (JeroMQ) endpoints.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Requires the JeroMQ jar (LGPL as of 0.3.5)</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JeroMQ affinity="" |
| backlog="" |
| delayAttachOnConnect="" |
| identity="" |
| ignoreExceptions="" |
| ipv4Only="" |
| linger="" |
| maxMsgSize="" |
| name="" |
| rcvHwm="" |
| receiveBufferSize="" |
| receiveTimeOut="" |
| reconnectIVL="" |
| reconnectIVLMax="" |
| sendBufferSize="" |
| sendTimeOut="" |
| sndHwm="" |
| tcpKeepAlive="" |
| tcpKeepAliveCount="" |
| tcpKeepAliveIdle="" |
| tcpKeepAliveInterval="" |
| xpubVerbose=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </JeroMQ></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>affinity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>backlog</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>delayAttachOnConnect</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>identity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ipv4Only</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>linger</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxMsgSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>rcvHwm</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>receiveBufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>receiveTimeOut</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectIVL</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectIVLMax</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sendBufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sendTimeOut</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sndHwm</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tcpKeepAlive</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tcpKeepAliveCount</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tcpKeepAliveIdle</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tcpKeepAliveInterval</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>xpubVerbose</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender"></a>Kafka</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.mom.kafka.KafkaAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Sends log events to an Apache Kafka topic.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Kafka ignoreExceptions="" |
| key="" |
| name="" |
| retryCount="" |
| sendEventTimestamp="" |
| syncSend="" |
| topic=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </Kafka></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>retryCount</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sendEventTimestamp</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>syncSend</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>topic</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender"></a>NoSql</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.nosql.NoSqlAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender writes logging events to a NoSQL database using a configured NoSQL provider.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It requires implementations of <code>org.apache.logging.log4j.core.appender.nosql.NoSqlObject</code>, <code>org.apache.logging.log4j.core.appender.nosql.NoSqlConnection</code>, and <a href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider">NoSqlProvider</a> to "know" how to write events to the chosen NoSQL database.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For examples on how to write your own NoSQL provider, see the simple source code for the MongoDB and CouchDB providers.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><NoSql bufferSize="" |
| ignoreExceptions="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <a-NoSqlProvider-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </NoSql></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the buffer size.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider">NoSqlProvider</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the provider.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy"></a>LoggerNameLevelRewritePolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rewrite.LoggerNameLevelRewritePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Rewrites log event levels for a given logger name.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LoggerNameLevelRewritePolicy logger=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </LoggerNameLevelRewritePolicy></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>logger</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The logger name prefix for events to rewrite; all event logger names that start with this string will be rewritten.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The levels to rewrite, the key is the source level, the value the target level.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy"></a>MapRewritePolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rewrite.MapRewritePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This policy modifies events by replacing or possibly adding keys and values to the MapMessage.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MapRewritePolicy mode=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </MapRewritePolicy></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mode</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The string representation of the Mode.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>key/value pairs for the new Map keys and values.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy"></a>PropertiesRewritePolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rewrite.PropertiesRewritePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This policy modifies events by replacing or possibly adding keys and values to the MapMessage.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PropertiesRewritePolicy/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>key/value pairs for the new keys and values.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender"></a>Rewrite</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rewrite.RewriteAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender allows the logging event to be manipulated before it is processed by other Appenders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Rewrite ignoreExceptions="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-RewritePolicy-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| </Rewrite></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If <code>"true"</code> (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the Appender.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy">RewritePolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The policy to use to modify the event.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Appender names to call.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>A Filter to filter events.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy"></a><code>RewritePolicy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rewrite.RewritePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface to be implemented by components that support modifications to the LogEvent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-LoggerNameLevelRewritePolicy">LoggerNameLevelRewritePolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-MapRewritePolicy">MapRewritePolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-PropertiesRewritePolicy">PropertiesRewritePolicy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractRolloverStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractRolloverStrategy"></a><code>AbstractRolloverStrategy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractRolloverStrategy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractRolloverStrategy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy">DefaultRolloverStrategy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy">DirectWriteRolloverStrategy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractTriggeringPolicy"></a><code>AbstractTriggeringPolicy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract convenience class for triggering policies that extend <a href="#org-apache-logging-log4j_log4j-fuzz-test_org-apache-logging-log4j-core-AbstractLifeCycle">AbstractLifeCycle</a> and implement <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy">TriggeringPolicy</a>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractTriggeringPolicy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-AbstractTriggeringPolicy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy">CompositeTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy">CronTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy">NoOpTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy">OnStartupTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy">TimeBasedTriggeringPolicy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy"></a>Policies</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.CompositeTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Triggering policy that wraps other triggering policies.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Policies/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy">TriggeringPolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The triggering policies.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy"></a>CronTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.CronTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Rolls a file over based on a cron schedule.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CronTriggeringPolicy evaluateOnStartup="" |
| schedule=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>evaluateOnStartup</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>check if the file should be rolled over immediately.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>schedule</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the cron expression.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy"></a>DefaultRolloverStrategy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>When rolling over, <code>DefaultRolloverStrategy</code> renames files according to an algorithm as described below.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The DefaultRolloverStrategy is a combination of a time-based policy and a fixed-window policy. |
| When the file name pattern contains a date format then the rollover time interval will be used to calculate the time to use in the file pattern. |
| When the file pattern contains an integer replacement token one of the counting techniques will be used.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When the ascending attribute is set to true (the default) then the counter will be incremented and the current log file will be renamed to include the counter value. |
| If the counter hits the maximum value then the oldest file, which will have the smallest counter, will be deleted, all other files will be renamed to have their counter decremented and then the current file will be renamed to have the maximum counter value. |
| Note that with this counting strategy specifying a large maximum value may entirely avoid renaming files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When the ascending attribute is false, then the "normal" fixed-window strategy will be used.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Let <em>max</em> and <em>min</em> represent the values of respectively the <strong>MaxIndex</strong> and <strong>MinIndex</strong> options. |
| Let "foo. |
| log" be the value of the <strong>ActiveFile</strong> option and "foo. |
| %i.log" the value of <strong>FileNamePattern</strong>. Then, when rolling over, the file <code>foo. <em>max</em>.log</code> will be deleted, the file <code>foo. <em>max-1</em>.log</code> will be renamed as <code>foo. <em>max</em>.log</code>, the file <code>foo. <em>max-2</em>.log</code> renamed as <code>foo. <em>max-1</em>.log</code>, and so on, the file <code>foo. <em>min+1</em>.log</code> renamed as <code>foo. <em>min+2</em>.log</code>. Lastly, the active file <code>foo. log</code> will be renamed as <code>foo. <em>min</em>.log</code> and a new active file name <code>foo. log</code> will be created.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Given that this rollover algorithm requires as many file renaming operations as the window size, large window sizes are discouraged.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DefaultRolloverStrategy compressionLevel="" |
| fileIndex="" |
| max="" |
| min="" |
| stopCustomActionsOnError="" |
| tempCompressedFilePattern=""> |
| <a-Action-implementation/><!-- multiple occurrences allowed --> |
| </DefaultRolloverStrategy></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compressionLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileIndex</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>max</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>min</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stopCustomActionsOnError</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tempCompressedFilePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action">Action</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectFileRolloverStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectFileRolloverStrategy"></a><code>DirectFileRolloverStrategy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.DirectFileRolloverStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Created by rgoers on 1/12/17.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectFileRolloverStrategy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectFileRolloverStrategy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy">DirectWriteRolloverStrategy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy"></a>DirectWriteRolloverStrategy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.DirectWriteRolloverStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>When rolling over, <code>DirectWriteRolloverStrategy</code> writes directly to the file as resolved by the file pattern.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Files will be renamed files according to an algorithm as described below.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The DirectWriteRolloverStrategy uses similar logic as DefaultRolloverStrategy to determine the file name based on the file pattern, however the DirectWriteRolloverStrategy writes directly to a file and does not rename it during rollover, except if it is compressed, in which case it will add the appropriate file extension.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DirectWriteRolloverStrategy compressionLevel="" |
| maxFiles="" |
| stopCustomActionsOnError="" |
| tempCompressedFilePattern=""> |
| <a-Action-implementation/><!-- multiple occurrences allowed --> |
| </DirectWriteRolloverStrategy></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compressionLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxFiles</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stopCustomActionsOnError</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tempCompressedFilePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action">Action</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy"></a>NoOpTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.NoOpTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><NoOpTriggeringPolicy/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy"></a>OnStartupTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.OnStartupTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Triggers a rollover on every restart, but only if the file size is greater than zero.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><OnStartupTriggeringPolicy minSize=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>minSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy"></a><code>RolloverStrategy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.RolloverStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <code>RollingPolicy</code> specifies the actions taken on a logging file rollover.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-RolloverStrategy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DefaultRolloverStrategy">DefaultRolloverStrategy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-DirectWriteRolloverStrategy">DirectWriteRolloverStrategy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy"></a>SizeBasedTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.SizeBasedTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SizeBasedTriggeringPolicy size=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The size of the file before rollover is required.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy"></a>TimeBasedTriggeringPolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Rolls a file over based on time.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><TimeBasedTriggeringPolicy interval="" |
| maxRandomDelay="" |
| modulate=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>interval</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxRandomDelay</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>modulate</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy"></a><code>TriggeringPolicy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <code>TriggeringPolicy</code> controls the conditions under which rollover occurs.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Such conditions include time of day, file size, an external event, the log request or a combination thereof.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TriggeringPolicy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CompositeTriggeringPolicy">CompositeTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-CronTriggeringPolicy">CronTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-NoOpTriggeringPolicy">NoOpTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-OnStartupTriggeringPolicy">OnStartupTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-SizeBasedTriggeringPolicy">SizeBasedTriggeringPolicy</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-TimeBasedTriggeringPolicy">TimeBasedTriggeringPolicy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractAction"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractAction"></a><code>AbstractAction</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.AbstractAction</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract base class for implementations of Action.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractAction_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractAction_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction">DeleteAction</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction">PosixViewAttributeAction</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractPathAction"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractPathAction"></a><code>AbstractPathAction</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract action for processing files that are accepted by the specified PathFilters.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractPathAction_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-AbstractPathAction_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction">DeleteAction</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction">PosixViewAttributeAction</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action"></a><code>Action</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.Action</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The Action interface should be implemented by any class that performs file system actions for RollingFileAppenders after the close of the active log file.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Action_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction">DeleteAction</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction">PosixViewAttributeAction</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction"></a>Delete</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.DeleteAction</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Delete basePath="" |
| followLinks="" |
| maxDepth="" |
| testMode=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| <a-PathSorter-implementation/> |
| <ScriptCondition/> |
| </Delete></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>basePath</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>base path from where to start scanning for files to delete.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>followLinks</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>whether to follow symbolic links. |
| Default is false.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxDepth</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The maxDepth parameter is the maximum number of levels of directories to visit. |
| A value of 0 means that only the starting file is visited, unless denied by the security manager. |
| A value of MAX_VALUE may be used to indicate that all levels should be visited.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>testMode</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>if true, files are not deleted but instead a message is printed to the status logger at INFO level. |
| Users can use this to do a dry run to test if their configuration works as expected. |
| Default is false.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>an array of path conditions (if more than one, they all need to accept a path before it is deleted).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter">PathSorter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>a plugin implementing the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter">PathSorter</a> interface</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ScriptCondition</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition">ScriptCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Duration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Duration"></a><code>Duration</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.Duration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Simplified implementation of the ISO-8601 Durations standard.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The supported format is <code>PnDTnHnMnS</code>, with 'P' and 'T' optional. |
| Days are considered to be exactly 24 hours.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Similarly to the <code>java. time. Duration</code> class, this class does not support year or month sections in the format. |
| This implementation does not support fractions or negative values.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount"></a>IfAccumulatedFileCount</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfAccumulatedFileCount</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfAccumulatedFileCount exceeds=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| </IfAccumulatedFileCount></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>exceeds</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The threshold count from which files will be deleted.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize"></a>IfAccumulatedFileSize</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfAccumulatedFileSize</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfAccumulatedFileSize exceeds=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| </IfAccumulatedFileSize></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>exceeds</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The threshold accumulated file size from which files will be deleted.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll"></a>IfAll</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfAll</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Composite <code>PathCondition</code> that only accepts objects that are accepted by <em>all</em> component conditions.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Corresponds to logical "AND".</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfAll/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The component filters.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny"></a>IfAny</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfAny</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Composite <code>PathCondition</code> that accepts objects that are accepted by <em>any</em> component conditions.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Corresponds to logical "OR".</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfAny/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The component conditions.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName"></a>IfFileName</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfFileName</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular expression.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression is ignored.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The regular expression is a pattern as defined by the <code>java.util.regex.Pattern</code> class. |
| A glob is a simplified pattern expression described in <code>java.nio.file.FileSystem#getPathMatcher(String)</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfFileName glob="" |
| regex=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| </IfFileName></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>glob</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts)</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>regex</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the regular expression that matches the baseDir-relative path of the file(s) to delete</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>nested conditions to evaluate if this condition accepts a path</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified"></a>IfLastModified</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfLastModified</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>PathCondition that accepts paths that are older than the specified duration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfLastModified age=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| </IfLastModified></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>age</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-Duration">Duration</a></code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot"></a>IfNot</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.IfNot</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Wrapper <code>PathCondition</code> that accepts objects that are rejected by the wrapped component filter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IfNot/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The condition to negate.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition"></a><code>PathCondition</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.PathCondition</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Filter that accepts or rejects a candidate <code>Path</code> for deletion.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileCount">IfAccumulatedFileCount</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAccumulatedFileSize">IfAccumulatedFileSize</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAll">IfAll</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfAny">IfAny</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfFileName">IfFileName</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfLastModified">IfLastModified</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-IfNot">IfNot</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime"></a>SortByModificationTime</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.PathSortByModificationTime</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter">PathSorter</a> that sorts path by their LastModified attribute.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SortByModificationTime recentFirst=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>recentFirst</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>if true, most recently modified paths should come first.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter"></a><code>PathSorter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.PathSorter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Defines the interface of classes that can sort Paths.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSorter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathSortByModificationTime">PathSortByModificationTime</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction"></a>PosixViewAttribute</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.PosixViewAttributeAction</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>File POSIX attribute view action.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Allow to define file permissions, user and group for log files on POSIX supported OS.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PosixViewAttribute basePath="" |
| fileGroup="" |
| fileOwner="" |
| filePermissions="" |
| followLinks="" |
| maxDepth=""> |
| <a-PathCondition-implementation/><!-- multiple occurrences allowed --> |
| </PosixViewAttribute></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>basePath</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileGroup</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fileOwner</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>filePermissions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>followLinks</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxDepth</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PosixViewAttributeAction_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-PathCondition">PathCondition</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition"></a>ScriptCondition</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A condition of the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction">DeleteAction</a> where a user-provided script selects the files to delete from a provided list.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The specified script may be a <code>org.apache.logging.log4j.core.appender.rolling.action.org.apache.logging.log4j.core.script.Script</code>, a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile">ScriptFile</a> or a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef">ScriptRef</a>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptCondition/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-ScriptCondition_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The script to run. |
| This may be a <code>org.apache.logging.log4j.core.appender.rolling.action.org.apache.logging.log4j.core.script.Script</code>, a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile">ScriptFile</a> or a <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef">ScriptRef</a>. The script must return a <code>List<PathWithAttributes></code>. When the script is executed, it is provided the following bindings:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>basePath - the directory from where the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rolling-action-DeleteAction">Delete</a> action started scanning for files to delete. |
| Can be used to relativize the paths in the pathList.</p> |
| </li> |
| <li> |
| <p>pathList - a <code>java. util. List</code> containing <code>org.apache.logging.log4j.core.appender.rolling.action.PathWithAttributes</code> objects. |
| (The script is free to modify and return this list. |
| )</p> |
| </li> |
| <li> |
| <p>substitutor - a <code>org.apache.logging.log4j.core.appender.rolling.action.org.apache.logging.log4j.core.lookup.StrSubstitutor</code> that can be used to look up variables embedded in the base dir or other properties</p> |
| </li> |
| <li> |
| <p>statusLogger - the <code>org.apache.logging.log4j.status.StatusLogger</code> that can be used to log events during script execution</p> |
| </li> |
| <li> |
| <p>any properties declared in the configuration</p> |
| </li> |
| </ul> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy"></a>IdlePurgePolicy</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.routing.IdlePurgePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Policy is purging appenders that were not in use specified time in minutes</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IdlePurgePolicy checkInterval="" |
| timeToLive="" |
| timeUnit=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>checkInterval</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>when all appenders purged, the number of increments of timeUnit to check if any appenders appeared</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>timeToLive</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the number of increments of timeUnit before the Appender should be purged.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>timeUnit</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the unit of time the timeToLive and the checkInterval is expressed in.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-PurgePolicy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-PurgePolicy"></a><code>PurgePolicy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.routing.PurgePolicy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Policy for purging routed appenders</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-PurgePolicy_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-PurgePolicy_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-IdlePurgePolicy">IdlePurgePolicy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route"></a>Route</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.routing.Route</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A Route to an appender.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Route key="" |
| ref=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The key.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ref</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The Appender reference.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes"></a>Routes</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.routing.Routes</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Contains the individual Route elements.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Routes pattern=""> |
| <Route/><!-- multiple occurrences allowed --> |
| <a-AbstractScript-implementation/> |
| </Routes></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Route</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Route">Route</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender"></a>Routing</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.routing.RoutingAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender "routes" between various Appenders, some of which can be references to Appenders defined earlier in the configuration while others can be dynamically created within this Appender as required.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Routing is achieved by specifying a pattern on the Routing appender declaration. |
| The pattern should contain one or more substitution patterns of the form "$${[key:]token}". The pattern will be resolved each time the Appender is called using the built in StrSubstitutor and the StrLookup plugin that matches the specified key.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Routing ignoreExceptions="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <a-RewritePolicy-implementation/> |
| <a-PurgePolicy-implementation/> |
| <Routes/> |
| <Property/><!-- multiple occurrences allowed --> |
| <a-AbstractScript-implementation/> |
| </Routing></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewritePolicy">RewritePolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-PurgePolicy">PurgePolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Routes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-Routes">Routes</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-ArrayBlockingQueueFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-ArrayBlockingQueueFactory"></a>ArrayBlockingQueue</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory for creating instances of <code>java.util.concurrent.ArrayBlockingQueue</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-ArrayBlockingQueueFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-ArrayBlockingQueueFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ArrayBlockingQueue/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig"></a>AsyncLogger</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.AsyncLoggerConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Asynchronous Logger object that is created via configuration and can be combined with synchronous loggers.</p> |
| </div> |
| <div class="paragraph"> |
| <p>AsyncLoggerConfig is a logger designed for high throughput and low latency logging. |
| It does not perform any I/O in the calling (application) thread, but instead hands off the work to another thread as soon as possible. |
| The actual logging is performed in the background thread. |
| It uses LMAX Disruptor for inter-thread communication.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To use AsyncLoggerConfig, specify <code><asyncLogger></code> or <code><asyncRoot></code> in configuration.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Note that for performance reasons, this logger does not include source location by default. |
| You need to specify <code>includeLocation="true"</code> in the configuration or any %class, %location or %line conversion patterns in your log4j. |
| xml configuration will produce either a "?" character or no output at all.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For best performance, use AsyncLoggerConfig with the RandomAccessFileAppender or RollingRandomAccessFileAppender, with immediateFlush=false. |
| These appenders have built-in support for the batching mechanism used by the Disruptor library, and they will flush to disk at the end of each batch. |
| This means that even with immediateFlush=false, there will never be any items left in the buffer; all log events will all be written to disk in a very efficient manner.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><AsyncLogger additivity="" |
| includeLocation="" |
| level="" |
| levelAndRefs="" |
| name=""> |
| <a-Filter-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| </AsyncLogger></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>additivity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>levelAndRefs</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger"></a>AsyncRoot</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.AsyncLoggerConfig.RootLogger</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An asynchronous root Logger.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><AsyncRoot additivity="" |
| includeLocation="" |
| level="" |
| levelAndRefs=""> |
| <a-Filter-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| </AsyncRoot></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>additivity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>levelAndRefs</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig"></a>AsyncWaitStrategyFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.AsyncWaitStrategyFactoryConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This class allows users to configure the factory used to create an instance of the LMAX disruptor WaitStrategy used by Async Loggers in the log4j configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><AsyncWaitStrategyFactory class=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>class</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory"></a><code>BlockingQueueFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.BlockingQueueFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory for creating instances of <code>java.util.concurrent.BlockingQueue</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-BlockingQueueFactory_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-ArrayBlockingQueueFactory">ArrayBlockingQueueFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory">DisruptorBlockingQueueFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory">JCToolsBlockingQueueFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-LinkedTransferQueueFactory">LinkedTransferQueueFactory</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory"></a>DisruptorBlockingQueue</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory for creating instances of <code>com.conversantmedia.util.concurrent.DisruptorBlockingQueue</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DisruptorBlockingQueue SpinPolicy=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-DisruptorBlockingQueueFactory-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SpinPolicy</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_com-conversantmedia-util-concurrent-SpinPolicy">SpinPolicy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory"></a>JCToolsBlockingQueue</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory for creating instances of BlockingQueues backed by JCTools <code>org.jctools.queues.MpscArrayQueue</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JCToolsBlockingQueue WaitStrategy=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>WaitStrategy</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory-WaitStrategy">WaitStrategy</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory-WaitStrategy"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-JCToolsBlockingQueueFactory-WaitStrategy"></a><code>WaitStrategy</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.WaitStrategy</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-LinkedTransferQueueFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-LinkedTransferQueueFactory"></a>LinkedTransferQueue</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.async.LinkedTransferQueueFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory for creating instances of <code>java.util.concurrent.LinkedTransferQueue</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-LinkedTransferQueueFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-LinkedTransferQueueFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LinkedTransferQueue/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef"></a>AppenderRef</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.AppenderRef</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An Appender reference.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><AppenderRef level="" |
| ref=""> |
| <a-Filter-implementation/> |
| </AppenderRef></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The Level to filter against.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ref</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the Appender.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The filter(s) to use.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin"></a>Appenders</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.AppendersPlugin</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An Appender container.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Appenders/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Appender">Appender</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Appenders.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration"></a>Configuration</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.Configuration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A Log4j configuration contains many components of which two are required: <code>Appenders</code> and <code>Loggers</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Configuration dest="err" |
| monitorInterval="0" |
| name="" |
| schema="" |
| shutdownHook="" |
| shutdownTimeout="" |
| status="ERROR" |
| strict="false"> |
| <Properties/> |
| <Appenders/> |
| <CustomLevels/> |
| <Loggers/> |
| </Configuration></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>dest</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>err</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Specifies the destination for status logger events. |
| The possible values are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>out</code> for using standard out (default)</p> |
| </li> |
| <li> |
| <p><code>err</code> for using standard error</p> |
| </li> |
| <li> |
| <p>a string that is interpreted in order as URI, URL or the path to a local file</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>If the provided value is invalid, then the default destination of standard out will be used.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>monitorInterval</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Number of seconds between polls for configuration changes</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Name of the configuration</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>schema</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of a classpath resource to use to validate the configuration</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>shutdownHook</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Indicates if Log4j should automatically shut down when the JVM shuts down. |
| Possible values are <code>enable</code> and <code>disable</code>. |
| The shutdown hook is enabled by default, unless Log4j detects the presence of the Servlet API.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>shutdownTimeout</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Timeout in milliseconds of the logger context shut down</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>status</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ERROR</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the level of the status logger</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>strict</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If set to <code>true</code> the configuration file will be validated using an XML schema.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Configuration_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Appenders</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppendersPlugin">AppendersPlugin</a></code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Wrapper element for a list of appenders</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>CustomLevels</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels">CustomLevels</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Wrapper element for a list of custom levels</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Loggers</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin">LoggersPlugin</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Wrapper element for a list of logger configurations</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Properties</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin">PropertiesPlugin</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Wrapper element for a list of properties</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationAware"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationAware"></a><code>ConfigurationAware</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.ConfigurationAware</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Indicates that a class requests the current Configuration to be injected.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationAware_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationAware_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup">Log4jLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationFactory"></a><code>ConfigurationFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.ConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory class for parsed <code>org.apache.logging.log4j.core.config.Configuration</code> objects from a configuration file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>ConfigurationFactory allows the configuration implementation to be dynamically chosen in 1 of 3 ways:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>A system property named "log4j. |
| configurationFactory" can be set with the name of the ConfigurationFactory to be used.</p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-logging-log4j-core-config-ConfigurationFactory">ConfigurationFactory</a> can be called with the instance of the ConfigurationFactory to be used. |
| This must be called before any other calls to Log4j.</p> |
| </li> |
| <li> |
| <p>A ConfigurationFactory implementation can be added to the classpath and configured as a plugin in the <a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-logging-log4j-core-config-ConfigurationFactory">ConfigurationFactory</a> category. |
| The <code>org.apache.logging.log4j.core.config.Order</code> annotation should be used to configure the factory to be the first one inspected. |
| See <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory">XmlConfigurationFactory</a> for an example.</p> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>If the ConfigurationFactory that was added returns null on a call to getConfiguration then any other ConfigurationFactories found as plugins will be called in their respective order. |
| DefaultConfiguration is always called last if no configuration has been returned.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationFactory_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ConfigurationFactory_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory">PropertiesConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory">XmlConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory">JsonConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory">PropertiesConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory">XmlConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory">YamlConfigurationFactory</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig"></a>CustomLevel</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.CustomLevelConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Descriptor of a custom Level object that is created via configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CustomLevel intLevel="" |
| name=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>intLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the intLevel that determines where this level resides relative to the built-in levels</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>name of the custom level.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels"></a>CustomLevels</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.CustomLevels</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for CustomLevelConfig objects.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CustomLevels/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevels_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>CustomLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-CustomLevelConfig">CustomLevelConfig</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of CustomLevelConfigs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-DefaultAdvertiser"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-DefaultAdvertiser"></a>Default</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.DefaultAdvertiser</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The default advertiser does not do anything.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-DefaultAdvertiser_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-DefaultAdvertiser_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Default/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher"></a>http</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.HttpWatcher</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><http/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig"></a>Logger</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.LoggerConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Logger object that is created via configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Logger additivity="" |
| includeLocation="" |
| level="" |
| levelAndRefs="" |
| name=""> |
| <a-Filter-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| </Logger></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>additivity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>levelAndRefs</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger"></a>Root</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.LoggerConfig.RootLogger</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The root Logger.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Root additivity="" |
| includeLocation="" |
| level="" |
| levelAndRefs=""> |
| <a-Filter-implementation/> |
| <AppenderRef/><!-- multiple occurrences allowed --> |
| <Property/><!-- multiple occurrences allowed --> |
| </Root></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>additivity</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>levelAndRefs</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>AppenderRef</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-AppenderRef">AppenderRef</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin"></a>Loggers</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.LoggersPlugin</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container of Logger objects.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Loggers/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggersPlugin_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Logger</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Loggers.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource"></a>MonitorResource</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.MonitorResource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for the <code>MonitorResource</code> element.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MonitorResource uri=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>uri</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>URI</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources"></a>MonitorResources</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.MonitorResources</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for the <code>MonitorResources</code> element.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MonitorResources/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResources_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>MonitorResource</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-MonitorResource">MonitorResource</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin"></a>Properties</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.PropertiesPlugin</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Handles properties defined in the configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Properties/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Property elements.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property"></a>Property</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.Property</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Represents a key/value pair in the configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Property name="" |
| value=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The key.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The value without any substitution applied.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin"></a>Scripts</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.ScriptsPlugin</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A container of Scripts.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Scripts/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-ScriptsPlugin_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Scripts.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-Arbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-Arbiter"></a><code>Arbiter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.Arbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface used to check for portions of the configuration that may be optionally included.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-Arbiter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-Arbiter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter">ClassArbiter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-DefaultArbiter">DefaultArbiter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter">EnvironmentArbiter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ScriptArbiter">ScriptArbiter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter">SystemPropertyArbiter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter">SpringProfileArbiter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter"></a>ClassArbiter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.ClassArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Conditional that determines if the specified class is present.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ClassArbiter className=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ClassArbiter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>className</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Class name.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-DefaultArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-DefaultArbiter"></a>DefaultArbiter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.DefaultArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Default Condition for a Select Condition.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-DefaultArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-DefaultArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DefaultArbiter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter"></a>EnvironmentArbiter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.EnvironmentArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Condition that determines if the specified environment variable is set.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EnvironmentArbiter propertyName="" |
| propertyValue=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-EnvironmentArbiter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>propertyName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Property Name.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>propertyValue</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Property Value.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ScriptArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ScriptArbiter"></a>ScriptArbiter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.ScriptArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Condition that evaluates a script.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ScriptArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-ScriptArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptArbiter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SelectArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SelectArbiter"></a>Select</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.SelectArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Class Description goes here.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SelectArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SelectArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Select/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter"></a>SystemPropertyArbiter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.arbiters.SystemPropertyArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Condition that determines if the specified property is set.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SystemPropertyArbiter propertyName="" |
| propertyValue=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-arbiters-SystemPropertyArbiter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>propertyName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Property Name.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>propertyValue</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Property Value.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-builder-api-ConfigurationBuilderFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-builder-api-ConfigurationBuilderFactory"></a><code>ConfigurationBuilderFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Provides methods to create ConfigurationBuilders.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-builder-api-ConfigurationBuilderFactory_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-builder-api-ConfigurationBuilderFactory_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-config-PropertiesConfigurationFactory">PropertiesConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-xml-XmlConfigurationFactory">XmlConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory">JsonConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory">PropertiesConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory">XmlConfigurationFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory">YamlConfigurationFactory</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory"></a>JsonConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.json.JsonConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-json-JsonConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JsonConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverter"></a><code>TypeConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface for doing automatic String conversion to a specific type.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigDecimalConverter">BigDecimalConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigIntegerConverter">BigIntegerConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BooleanConverter">BooleanConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteArrayConverter">ByteArrayConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteConverter">ByteConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharArrayConverter">CharArrayConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharacterConverter">CharacterConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharsetConverter">CharsetConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ClassConverter">ClassConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CronExpressionConverter">CronExpressionConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DoubleConverter">DoubleConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DurationConverter">DurationConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FileConverter">FileConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FloatConverter">FloatConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-InetAddressConverter">InetAddressConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-IntegerConverter">IntegerConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LevelConverter">LevelConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LongConverter">LongConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PathConverter">PathConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PatternConverter">PatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-SecurityProviderConverter">SecurityProviderConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ShortConverter">ShortConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-StringConverter">StringConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UriConverter">UriConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UrlConverter">UrlConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UuidConverter">UuidConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactoryConverter">RecyclerFactoryConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigDecimalConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigDecimalConverter"></a>BigDecimal</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigDecimalConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Parses a <code>java.lang.String</code> into a <code>java.math.BigDecimal</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigDecimalConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigDecimalConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><BigDecimal/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigIntegerConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigIntegerConverter"></a>BigInteger</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Parses a <code>java.lang.String</code> into a <code>java.math.BigInteger</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigIntegerConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BigIntegerConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><BigInteger/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BooleanConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BooleanConverter"></a>Boolean</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Boolean</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BooleanConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-BooleanConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Boolean/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteArrayConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteArrayConverter"></a>ByteArray</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>byte[]</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The supported formats are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>0x0123456789ABCDEF</p> |
| </li> |
| <li> |
| <p>Base64:ABase64String</p> |
| </li> |
| <li> |
| <p>String using <code>java.nio.charset.Charset#defaultCharset()</code> [TODO Should this be UTF-8 instead? |
| ]</p> |
| </li> |
| </ul> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteArrayConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteArrayConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ByteArray/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteConverter"></a>Byte</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Byte</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ByteConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Byte/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharArrayConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharArrayConverter"></a>CharacterArray</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>char[]</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharArrayConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharArrayConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CharacterArray/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharacterConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharacterConverter"></a>Character</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Character</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharacterConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharacterConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Character/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharsetConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharsetConverter"></a>Charset</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.nio.charset.Charset</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharsetConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CharsetConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Charset/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ClassConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ClassConverter"></a>Class</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Class</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ClassConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ClassConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Class/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CronExpressionConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CronExpressionConverter"></a>CronExpression</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CronExpressionConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CronExpressionConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-CronExpressionConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CronExpression/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DoubleConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DoubleConverter"></a>Double</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DoubleConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Double</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DoubleConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DoubleConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Double/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DurationConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DurationConverter"></a>Duration</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.org.apache.logging.log4j.core.appender.rolling.action.Duration</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DurationConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-DurationConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Duration/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FileConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FileConverter"></a>File</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.io.File</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FileConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FileConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><File/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FloatConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FloatConverter"></a>Float</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Float</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FloatConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-FloatConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Float/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-InetAddressConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-InetAddressConverter"></a>InetAddress</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into an <code>java.net.InetAddress</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-InetAddressConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-InetAddressConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><InetAddress/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-IntegerConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-IntegerConverter"></a>Integer</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Integer</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-IntegerConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-IntegerConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Integer/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LevelConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LevelConverter"></a>Level</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a Log4j <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LevelConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LevelConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Level/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LongConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LongConverter"></a>Long</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LongConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Long</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LongConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-LongConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Long/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PathConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PathConverter"></a>Path</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.nio.file.Path</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PathConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PathConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Path/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PatternConverter"></a>Pattern</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.util.regex.Pattern</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-PatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Pattern/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-SecurityProviderConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-SecurityProviderConverter"></a>SecurityProvider</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.security.Provider</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-SecurityProviderConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-SecurityProviderConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SecurityProvider/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ShortConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ShortConverter"></a>Short</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.lang.Short</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ShortConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-ShortConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Short/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-StringConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-StringConverter"></a>String</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the given <code>java.lang.String</code>, no conversion takes place.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-StringConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-StringConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><String/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UriConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UriConverter"></a>URI</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.net.URI</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UriConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UriConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><URI/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UrlConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UrlConverter"></a>URL</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.net.URL</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UrlConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UrlConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><URL/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UuidConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UuidConverter"></a>UUID</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts a <code>java.lang.String</code> into a <code>java.util.UUID</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UuidConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-plugins-convert-TypeConverters-UuidConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><UUID/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory"></a>PropertiesConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.properties.PropertiesConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Creates a PropertiesConfiguration from a properties file.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-properties-PropertiesConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PropertiesConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory"></a>XmlConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.xml.XmlConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Factory to construct an XmlConfiguration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-xml-XmlConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><XmlConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory"></a>YamlConfigurationFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.yaml.YamlConfigurationFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-yaml-YamlConfigurationFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><YamlConfigurationFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilter"></a><code>AbstractFilter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.AbstractFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Users should extend this class to implement filters.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Filters can be either context wide or attached to an appender. |
| A filter may choose to support being called only from the context or only from an appender in which case it will only implement the required method(s). The rest will default to return <code>org.apache.logging.log4j.core.filter.org.apache.logging.log4j.core.Filter.Result#NEUTRAL</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Garbage-free note: the methods with unrolled varargs by default delegate to the apiref:org.apache.logging.log4j.core.filter.AbstractFilter#filter(Logger, Level, Marker, String, Object…​)[filter method with vararg parameters]. Subclasses that want to be garbage-free should override these methods to implement the appropriate filtering without creating a vararg array.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter">BurstFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter">DenyAllFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter">DynamicThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter">LevelMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter">MapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter">MarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter">MutableThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter">NoMarkerFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter">RegexFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter">ScriptFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter">StringMatchFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter">ThresholdFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter">TimeFilter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilterable"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilterable"></a><code>AbstractFilterable</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.AbstractFilterable</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Enhances a Class by allowing it to contain Filters.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilterable_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-AbstractFilterable_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter"></a>BurstFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.BurstFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>BurstFilter</code> is a logging filter that regulates logging traffic.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use this filter when you want to control the maximum burst of log statements that can be sent to an appender. |
| The filter is configured in the log4j configuration file. |
| For example, the following configuration limits the number of INFO level (as well as DEBUG and TRACE) log statements that can be sent to the console to a burst of 100 with an average rate of 16 per second. |
| WARN, ERROR and FATAL messages would continue to be delivered. |
| <code><Console name="console"> <PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/> <Filters> <BurstFilter level="INFO" rate="16" maxBurst="100"/> </Filters> </Console></code></p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><BurstFilter level="" |
| maxBurst="" |
| onMatch="" |
| onMismatch="" |
| rate=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-BurstFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the logging level to use.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxBurst</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>rate</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>float?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the average number of events per second to allow.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter"></a>Filters</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.CompositeFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Composes and invokes one or more filters.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Filters/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-CompositeFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Filters to call.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter"></a>DenyAllFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.DenyAllFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter causes all logging events to be dropped.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DenyAllFilter onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DenyAllFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter"></a>DynamicThresholdFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.DynamicThresholdFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Compares against a log level that is associated with a context value.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default the context is the <code>org.apache.logging.log4j.ThreadContext</code>, but users may <em>configure</em> a custom <code>org.apache.logging.log4j.core.ContextDataInjector</code> which obtains context data from some other source.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DynamicThresholdFilter defaultThreshold="" |
| key="" |
| onMatch="" |
| onMismatch=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </DynamicThresholdFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultThreshold</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The default Level.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the key to compare.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform if a match occurs.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform if no match occurs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-DynamicThresholdFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of value and Level pairs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-Filterable"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-Filterable"></a><code>Filterable</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.Filterable</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface implemented by Classes that allow filtering to occur.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Extends <a href="#org-apache-logging-log4j_log4j-fuzz-test_org-apache-logging-log4j-core-LifeCycle">LifeCycle</a> since filters have a life cycle.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-Filterable_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-Filterable_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter"></a>LevelMatchFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.LevelMatchFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LevelMatchFilter level="" |
| onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelMatchFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the logging level to use.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter"></a>LevelRangeFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.LevelRangeFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> result if the level of the <code>org.apache.logging.log4j.core.LogEvent</code> is in the range of the configured <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> and <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> values, otherwise it returns the <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> result.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default values for <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> and <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> are set to <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> and <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>, respectively. |
| The default values for <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> and <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> are set to <code>org.apache.logging.log4j.core.filter.Result#NEUTRAL</code> and <code>org.apache.logging.log4j.core.filter.Result#DENY</code>, respectively.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The levels get compared by their associated integral values; <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> has an integral value of 0, <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> 100, <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a> 200, and so on. |
| For example, if the filter is configured with <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> set to <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>, the filter will return <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter">LevelRangeFilter</a> result for <code>org.apache.logging.log4j.core.LogEvent</code>s of level with higher integral values; <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>, <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>, etc.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LevelRangeFilter maxLevel="" |
| minLevel="" |
| onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-LevelRangeFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the maximum level threshold</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>minLevel</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the minimum level threshold</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the result to return on a match</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>the result to return on a mismatch</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter"></a>MapFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.MapFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A Filter that operates on a Map.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MapFilter onMatch="" |
| onMismatch="" |
| operator=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </MapFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>operator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MapFilter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter">StructuredDataFilter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter">ThreadContextMapFilter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter"></a>MarkerFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.MarkerFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the onMatch result if the marker in the LogEvent is the same as or has the configured marker as a parent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MarkerFilter marker="" |
| onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MarkerFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>marker</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The Marker name to match.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take if a match occurs.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take if no match occurs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter"></a>MutableThreadContextMapFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.MutableThreadContextMapFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Filter based on a value in the Thread Context Map (MDC).</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MutableThreadContextMapFilter configLocation="" |
| onMatch="" |
| onMismatch="" |
| pollInterval=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-MutableThreadContextMapFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>configLocation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the configuration to use.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pollInterval</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Set the frequency in seconds that changes to the list a ThreadContext valudes should be checked.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter"></a>NoMarkerFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.NoMarkerFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the onMatch result if there is no marker in the LogEvent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><NoMarkerFilter onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-NoMarkerFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter"></a>RegexFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.RegexFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A filter that matches the given regular expression pattern against messages.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RegexFilter onMatch="" |
| onMismatch="" |
| regex="" |
| useRawMsg=""> |
| <a-String-implementation/><!-- multiple occurrences allowed --> |
| </RegexFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform when a match occurs.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform when a mismatch occurs.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>regex</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The regular expression to match.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>useRawMsg</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If <code>true</code>, for <code>org.apache.logging.log4j.message.ParameterizedMessage</code>, <code>org.apache.logging.log4j.message.StringFormattedMessage</code>, and <code>org.apache.logging.log4j.message.MessageFormatMessage</code>, the message format pattern; for <code>org.apache.logging.log4j.message.StructuredDataMessage</code>, the message field will be used as the match target.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-RegexFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of Strings where each String is a <code>java.util.regex.Pattern#compile(String,int)</code> compilation flag.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter"></a>ScriptFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.ScriptFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptFilter onMatch="" |
| onMismatch=""> |
| <a-AbstractScript-implementation/> |
| </ScriptFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take if a match occurs.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take if no match occurs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ScriptFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The script to run. |
| The script must return a boolean value. |
| Either script or scriptFile must be provided.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter"></a>StringMatchFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.StringMatchFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><StringMatchFilter onMatch="" |
| onMismatch="" |
| text=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StringMatchFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter matches.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Defaults to Result. |
| NEUTRAL.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Result to return when the filter does not match.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default is Result. |
| DENY.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>text</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the text to search in event messages.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter"></a>StructuredDataFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.StructuredDataFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Filter based on data in a StructuredDataMessage.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><StructuredDataFilter onMatch="" |
| onMismatch="" |
| operator=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </StructuredDataFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform on a match.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to perform on a mismatch.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>operator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The operator to perform. |
| If not "or" the operation will be an "and".</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-StructuredDataFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Key and value pairs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter"></a>ThreadContextMapFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.ThreadContextMapFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Filter based on a value in the Thread Context Map (MDC).</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadContextMapFilter onMatch="" |
| onMismatch="" |
| operator=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </ThreadContextMapFilter></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>operator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThreadContextMapFilter_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter"></a>ThresholdFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.ThresholdFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This filter returns the onMatch result if the level in the <code>org.apache.logging.log4j.core.LogEvent</code> is the same or more specific than the configured level and the <code>onMismatch</code> value otherwise.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example, if the ThresholdFilter is configured with Level <code>ERROR</code> and the LogEvent contains Level <code>DEBUG</code> then the <code>onMismatch</code> value will be returned since <code>ERROR</code> events are more specific than <code>DEBUG</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default Level is <code>ERROR</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThresholdFilter level="" |
| onMatch="" |
| onMismatch=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-ThresholdFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>level</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-Level">Level</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The log Level.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take on a match.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The action to take on a mismatch.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter"></a>TimeFilter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.filter.TimeFilter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Filters events that fall within a specified time period in each day.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><TimeFilter end="" |
| onMatch="" |
| onMismatch="" |
| start="" |
| timezone=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-filter-TimeFilter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>end</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The end time.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Action to perform if the time matches.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>onMismatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter-Result">Result</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Action to perform if the action does not match.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>start</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The start time.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>timezone</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>timezone.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-impl-LocationAware"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-impl-LocationAware"></a><code>LocationAware</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.impl.LocationAware</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Classes that use location information should implement this interface.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-impl-LocationAware_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-impl-LocationAware_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-cassandra_org-apache-logging-log4j-cassandra-CassandraAppender">CassandraAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-AsyncAppender">AsyncAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ConsoleAppender">ConsoleAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-CountingNoOpAppender">CountingNoOpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FailoverAppender">FailoverAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-FileAppender">FileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-HttpAppender">HttpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-MemoryMappedFileAppender">MemoryMappedFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-NullAppender">NullAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-OutputStreamAppender">OutputStreamAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RandomAccessFileAppender">RandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingFileAppender">RollingFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-RollingRandomAccessFileAppender">RollingRandomAccessFileAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-ScriptAppenderSelector">ScriptAppenderSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SmtpAppender">SmtpAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SocketAppender">SocketAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-SyslogAppender">SyslogAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-WriterAppender">WriterAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-db-jdbc-JdbcAppender">JdbcAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender">JpaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender">JmsAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-jeromq-JeroMqAppender">JeroMqAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-mom-kafka-KafkaAppender">KafkaAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-nosql-NoSqlAppender">NoSqlAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-rewrite-RewriteAppender">RewriteAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-appender-routing-RoutingAppender">RoutingAppender</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig">AsyncLoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncLoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig">LoggerConfig</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-LoggerConfig-RootLogger">RootLogger</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector">LevelPatternSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector">MarkerPatternSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector">ScriptPatternSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter">ClassNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter">FileLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter">FullLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter">LineLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter">MethodLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout">JsonTemplateLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender">ServletAppender</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractCsvLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractCsvLayout"></a><code>AbstractCsvLayout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.AbstractCsvLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A superclass for Comma-Separated Value (CSV) layouts.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Depends on Apache Commons CSV 1.2.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractCsvLayout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractCsvLayout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractJacksonLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractJacksonLayout"></a><code>AbstractJacksonLayout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.AbstractJacksonLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractJacksonLayout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractJacksonLayout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractLayout"></a><code>AbstractLayout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.AbstractLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract base class for Layouts.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractLayout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractLayout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout">MessageLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout">SerializedLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractStringLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractStringLayout"></a><code>AbstractStringLayout</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.AbstractStringLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract base class for Layouts that result in a String.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Since 2.4.1, this class has custom logic to convert ISO-8859-1 or US-ASCII Strings to byte[] arrays to improve performance: all characters are simply cast to bytes.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractStringLayout_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-AbstractStringLayout_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout"></a>CsvLogEventLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.CsvLogEventLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A Comma-Separated Value (CSV) layout to log events.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Depends on Apache Commons CSV 1.2.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CsvLogEventLayout charset="" |
| delimiter="" |
| escape="" |
| footer="" |
| format="" |
| header="" |
| nullString="" |
| quote="" |
| quoteMode="" |
| recordSeparator=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>delimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>escape</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>format</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>nullString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>quote</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>quoteMode</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-commons-csv-QuoteMode">QuoteMode</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordSeparator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout"></a>CsvParameterLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.CsvParameterLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A Comma-Separated Value (CSV) layout to log event parameters.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The event message is currently ignored.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Best used with:</p> |
| </div> |
| <div class="paragraph"> |
| <p><code>logger. debug(new ObjectArrayMessage(1, 2, "Bob"));</code> Depends on Apache Commons CSV 1.4.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CsvParameterLayout charset="" |
| delimiter="" |
| escape="" |
| footer="" |
| format="" |
| header="" |
| nullString="" |
| quote="" |
| quoteMode="" |
| recordSeparator=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>delimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>escape</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>format</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>nullString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>quote</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Character?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>quoteMode</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-commons-csv-QuoteMode">QuoteMode</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordSeparator</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Encoder"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Encoder"></a><code>Encoder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.Encoder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Objects implementing the <code>Encoder</code> interface know how to convert an object to some binary representation and write the result to a <code>ByteBuffer</code>, ideally without creating temporary objects.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Encoder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Encoder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1SyslogLayout">Log4j1SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-layout-Log4j1XmlLayout">Log4j1XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvLogEventLayout">CsvLogEventLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-CsvParameterLayout">CsvParameterLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout">GelfLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout">HtmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout">JsonLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout">MessageLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout">PatternLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout">Rfc5424Layout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout">SerializedLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout">SyslogLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout">XmlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout">YamlLayout</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout">JsonTemplateLayout</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout"></a>GelfLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.GelfLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lays out events in the Graylog Extended Log Format (GELF) 1.1.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This layout compresses JSON to GZIP or ZLIB (the <code>compressionType</code>) if log event data is larger than 1024 bytes (the <code>compressionThreshold</code>). This layout does not implement chunking.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><GelfLayout charset="" |
| compressionThreshold="" |
| compressionType="" |
| footer="" |
| header="" |
| host="" |
| includeMapMessage="" |
| includeNewLineDelimiter="" |
| includeNullDelimiter="" |
| includeStacktrace="" |
| includeThreadContext="" |
| mapMessageExcludes="" |
| mapMessageIncludes="" |
| mapPrefix="" |
| messagePattern="" |
| omitEmptyFields="" |
| threadContextExcludes="" |
| threadContextIncludes="" |
| threadContextPrefix=""> |
| <a-Serializer-implementation/> |
| <a-PatternSelector-implementation/> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </GelfLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compressionThreshold</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Compress if data is larger than this number of bytes (optional, defaults to 1024).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compressionType</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout-CompressionType">CompressionType</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Compression to use (optional, defaults to GZIP).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>host</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The value of the <code>host</code> property (optional, defaults to local host name).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeMapMessage</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include MapMessage fields as additional fields (optional, default to true).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNewLineDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include newline (LF) as delimiter after each event (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNullDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include NULL byte as delimiter after each event (optional, default to false).</p> |
| </div> |
| <div class="paragraph"> |
| <p>Useful for Graylog GELF TCP input.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeStacktrace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include full stacktrace of logged Throwables (optional, default to true).</p> |
| </div> |
| <div class="paragraph"> |
| <p>If set to false, only the class name and message of the Throwable will be included.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeThreadContext</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include thread context as additional fields (optional, default to true).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mapMessageExcludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>A comma separated list of MapMessage keys to exclude;</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mapMessageIncludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>A comma separated list of thread context keys to include;</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mapPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The String to prefix the MapMessage attributes.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>messagePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The pattern to use to format the message.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>omitEmptyFields</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>threadContextExcludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>threadContextIncludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>threadContextPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The String to prefix the ThreadContext attributes.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector">PatternSelector</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The PatternSelector to use to format the message.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Additional fields to set on each log event.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout-CompressionType"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-GelfLayout-CompressionType"></a><code>CompressionType</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.GelfLayout.CompressionType</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout"></a>HtmlLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.HtmlLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Outputs events as rows in an HTML table on an HTML page.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Appenders using this layout should have their encoding set to UTF-8 or UTF-16, otherwise events containing non ASCII characters could result in corrupted log files.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><HtmlLayout charset="" |
| contentType="" |
| datePattern="" |
| fontName="" |
| fontSize="" |
| locationInfo="" |
| timezone="" |
| title=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>contentType</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>datePattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fontName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fontSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout-FontSize">FontSize</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>timezone</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>title</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout-FontSize"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-HtmlLayout-FontSize"></a><code>FontSize</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.HtmlLayout.FontSize</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Possible font sizes</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout"></a>JsonLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.JsonLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Note: The JsonLayout should be considered to be deprecated.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Please use JsonTemplateLayout instead. |
| Appends a series of JSON events as strings serialized as bytes.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_additional_fields"><a class="anchor" href="#_additional_fields"></a>Additional Fields</h5> |
| <div class="paragraph"> |
| <p>If you configure <code>complete="true"</code>, the appender outputs a well-formed JSON document. |
| By default, with <code>complete="false"</code>, you should include the output as an <em>external file</em> in a separate file to form a well-formed JSON document.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>complete="false"</code>, the appender does not write the JSON open array character "[" at the start of the document, "]" and the end, nor comma "," between records.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or <code>UTF-16</code>, otherwise events containing non ASCII characters could result in corrupted log files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, the JSON layout is not compact (a.k.a. "pretty") with <code>compact="false"</code>, which means the appender uses end-of-line characters and indents lines to format the text. |
| If <code>compact="true"</code>, then no end-of-line or indentation is used. |
| Message content may contain, of course, escaped end-of-lines.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This property allows addition of custom fields into generated JSON. |
| <code><JsonLayout><KeyValuePair key="foo" value="bar"/></JsonLayout></code> inserts <code>"foo":"bar"</code> directly into JSON output. |
| Supports Lookup expressions.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JsonLayout charset="" |
| compact="" |
| complete="" |
| endOfLine="" |
| eventEol="" |
| footer="" |
| header="" |
| includeNullDelimiter="" |
| includeStacktrace="" |
| includeTimeMillis="" |
| locationInfo="" |
| objectMessageAsJsonObject="" |
| properties="" |
| propertiesAsList="" |
| stacktraceAsString=""> |
| <a-Serializer-implementation/> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </JsonLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compact</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>complete</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>endOfLine</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventEol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNullDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include NULL byte as delimiter after each event (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeStacktrace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p> |
| </div> |
| <div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeTimeMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include the timestamp (in addition to the Instant) (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>objectMessageAsJsonObject</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>properties</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>propertiesAsList</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stacktraceAsString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to format the stacktrace as a string, and not a nested object (optional, defaults to false).</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-JsonLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Additional fields to set on each log event.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector"></a>LevelPatternSelector</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.LevelPatternSelector</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Selects the pattern to use based on the Level in the LogEvent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LevelPatternSelector alwaysWriteExceptions="" |
| defaultPattern="" |
| disableAnsi="" |
| noConsoleNoAnsi=""> |
| <PatternMatch/><!-- multiple occurrences allowed --> |
| </LevelPatternSelector></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>alwaysWriteExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultPattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>disableAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>noConsoleNoAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PatternMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch">PatternMatch</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields"></a>LoggerFields</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.LoggerFields</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A LoggerFields container.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LoggerFields discardIfAllFieldsAreEmpty="" |
| enterpriseId="" |
| sdId=""> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </LoggerFields></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>discardIfAllFieldsAreEmpty</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>this SD-ELEMENT should be discarded if all fields are empty</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>enterpriseId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The IANA assigned enterprise number</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sdId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The SD-ID in an SD-ELEMENT</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An array of KeyValuePairs.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector"></a>MarkerPatternSelector</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.MarkerPatternSelector</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Selects the pattern to use based on the Marker in the LogEvent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MarkerPatternSelector alwaysWriteExceptions="" |
| defaultPattern="" |
| disableAnsi="" |
| noConsoleNoAnsi=""> |
| <PatternMatch/><!-- multiple occurrences allowed --> |
| </MarkerPatternSelector></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>alwaysWriteExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultPattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>disableAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>noConsoleNoAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PatternMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch">PatternMatch</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout"></a>MessageLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.MessageLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a <code>org.apache.logging.log4j.core.LogEvent</code> in its <code>org.apache.logging.log4j.message.Message</code> form.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Useful in combination with a JMS Appender to map a Log4j <code>org.apache.logging.log4j.core.layout.org.apache.logging.log4j.message.MapMessage</code> or <code>org.apache.logging.log4j.core.layout.org.apache.logging.log4j.message.StringMapMessage</code> to a JMS <code>org.apache.logging.log4j.core.layout.javax.jms.MapMessage</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MessageLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MessageLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout"></a>PatternLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.PatternLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A flexible layout configurable with pattern string.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The goal of this class is to <em>format</em> a <code>org.apache.logging.log4j.core.LogEvent</code> and return the results. |
| The format of the result depends on the <em>conversion pattern</em>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called <em>conversion specifiers</em>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See the Log4j Manual for details on the supported pattern converters.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PatternLayout alwaysWriteExceptions="" |
| charset="" |
| disableAnsi="" |
| footer="" |
| header="" |
| noConsoleNoAnsi="" |
| pattern=""> |
| <a-PatternSelector-implementation/> |
| <Replace/> |
| </PatternLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>alwaysWriteExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>disableAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>noConsoleNoAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector">PatternSelector</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Replace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement">RegexReplacement</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch"></a>PatternMatch</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.PatternMatch</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>PatternMatch configuration item.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PatternMatch key="" |
| pattern=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>pattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector"></a><code>PatternSelector</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.PatternSelector</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Allows different patterns to be used with the PatternLayout based on some selection criteria.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternSelector_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LevelPatternSelector">LevelPatternSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-MarkerPatternSelector">MarkerPatternSelector</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector">ScriptPatternSelector</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout"></a>Rfc5424Layout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.Rfc5424Layout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a log event in accordance with RFC 5424.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Rfc5424Layout appName="" |
| charset="" |
| ein="" |
| enterpriseNumber="" |
| escapeNL="" |
| eventPrefix="" |
| exceptionPattern="" |
| excludes="" |
| facility="" |
| footer="" |
| header="" |
| id="" |
| includeMDC="" |
| includeNL="" |
| includes="" |
| mdcId="" |
| mdcPrefix="" |
| messageId="" |
| required="" |
| useTLSMessageFormat=""> |
| <a-Serializer-implementation/> |
| <LoggerFields/><!-- multiple occurrences allowed --> |
| </Rfc5424Layout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>appName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ein</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>enterpriseNumber</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>escapeNL</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>exceptionPattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>excludes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>facility</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility">Facility</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeMDC</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNL</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>mdcPrefix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>messageId</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>required</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>useTLSMessageFormat</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-Rfc5424Layout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LoggerFields</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-LoggerFields">LoggerFields</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector"></a>ScriptPatternSelector</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.ScriptPatternSelector</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Selects the pattern to use based on the result of executing a Script.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The returned value will be used as the "key" to choose between one of the configured patterns. |
| If no key is returned or there is no match the default pattern will be used.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptPatternSelector alwaysWriteExceptions="" |
| defaultPattern="" |
| disableAnsi="" |
| noConsoleNoAnsi=""> |
| <PatternMatch/><!-- multiple occurrences allowed --> |
| <a-AbstractScript-implementation/> |
| </ScriptPatternSelector></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>alwaysWriteExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultPattern</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>disableAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>noConsoleNoAnsi</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-ScriptPatternSelector_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PatternMatch</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-PatternMatch">PatternMatch</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript">AbstractScript</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout"></a>SerializedLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.SerializedLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a <code>org.apache.logging.log4j.core.LogEvent</code> in its Java serialized form.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SerializedLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SerializedLayout/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout"></a>SyslogLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.SyslogLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a log event as a BSD Log record.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SyslogLayout charset="" |
| facility="" |
| footer="" |
| header="" |
| newLine="" |
| newLineEscape=""> |
| <a-Serializer-implementation/> |
| </SyslogLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>facility</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility">Facility</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>newLine</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>newLineEscape</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-SyslogLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout"></a>XmlLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.XmlLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends a series of <code>event</code> elements as defined in the Log4j-events. |
| xsd.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_additional_fields_2"><a class="anchor" href="#_additional_fields_2"></a>Additional Fields</h5> |
| <div class="paragraph"> |
| <p>If you configure <code>complete="true"</code>, the appender outputs a well-formed XML document where the default namespace is the log4j namespace . By default, with <code>complete="false"</code>, you should include the output as an <em>external entity</em> in a separate file to form a well-formed XML document.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>complete="false"</code>, the appender does not write the XML processing instruction and the root element.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or <code>UTF-16</code>, otherwise events containing non-ASCII characters could result in corrupted log files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, the XML layout is not compact (compact = not "pretty") with <code>compact="false"</code>, which means the appender uses end-of-line characters and indents lines to format the XML. |
| If <code>compact="true"</code>, then no end-of-line or indentation is used. |
| Message content may contain, of course, end-of-lines.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This property allows addition of custom fields into generated JSON. |
| <code><XmlLayout><KeyValuePair key="foo" value="bar"/></XmlLayout></code> inserts <code><foo>bar</foo></code> directly into XML output. |
| Supports Lookup expressions.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><XmlLayout charset="" |
| compact="" |
| complete="" |
| endOfLine="" |
| eventEol="" |
| footer="" |
| header="" |
| includeNullDelimiter="" |
| includeStacktrace="" |
| includeTimeMillis="" |
| locationInfo="" |
| properties="" |
| stacktraceAsString=""> |
| <a-Serializer-implementation/> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </XmlLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compact</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>complete</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>endOfLine</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventEol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNullDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include NULL byte as delimiter after each event (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeStacktrace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p> |
| </div> |
| <div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeTimeMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include the timestamp (in addition to the Instant) (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>properties</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stacktraceAsString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to format the stacktrace as a string, and not a nested object (optional, defaults to false).</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-XmlLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Additional fields to set on each log event.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout"></a>YamlLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.layout.YamlLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends a series of YAML events as strings serialized as bytes.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_additional_fields_3"><a class="anchor" href="#_additional_fields_3"></a>Additional Fields</h5> |
| <div class="paragraph"> |
| <p>Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or <code>UTF-16</code>, otherwise events containing non ASCII characters could result in corrupted log files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This property allows addition of custom fields into generated JSON. |
| <code><YamlLayout><KeyValuePair key="foo" value="bar"/></YamlLayout></code> inserts <code>foo: "bar"</code> directly into YAML output. |
| Supports Lookup expressions.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><YamlLayout charset="" |
| compact="" |
| complete="" |
| endOfLine="" |
| eventEol="" |
| footer="" |
| header="" |
| includeNullDelimiter="" |
| includeStacktrace="" |
| includeTimeMillis="" |
| locationInfo="" |
| properties="" |
| stacktraceAsString=""> |
| <a-Serializer-implementation/> |
| <KeyValuePair/><!-- multiple occurrences allowed --> |
| </YamlLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>compact</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>complete</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>endOfLine</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventEol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>footer</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>header</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeNullDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include NULL byte as delimiter after each event (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeStacktrace</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".</p> |
| </div> |
| <div class="paragraph"> |
| <p>If "true", includes the stacktrace of any Throwable in the generated data, defaults to "true".</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>includeTimeMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to include the timestamp (in addition to the Instant) (optional, default to false).</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfo</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>properties</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stacktraceAsString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Whether to format the stacktrace as a string, and not a nested object (optional, defaults to false).</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-layout-YamlLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Serializer?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyValuePair</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair">KeyValuePair</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Additional fields to set on each log event.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractConfigurationAwareLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractConfigurationAwareLookup"></a><code>AbstractConfigurationAwareLookup</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.AbstractConfigurationAwareLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>StrLookup that is ConfigurationAware.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Handles saving the Configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractConfigurationAwareLookup_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractConfigurationAwareLookup_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup">Log4jLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractLookup"></a><code>AbstractLookup</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.AbstractLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A default lookup for others to extend.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractLookup_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-AbstractLookup_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup">EnvironmentLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup">EventLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup">JavaLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup">JndiLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup">Log4jLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup">LowerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup">MarkerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup">ResourceBundleLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup">StructuredDataLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup">SystemPropertiesLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup">DockerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup">WebLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ContextMapLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ContextMapLookup"></a>ctx</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.ContextMapLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from the context.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default this is the <code>org.apache.logging.log4j.ThreadContext</code>, but users may <em>configure</em> a custom <code>org.apache.logging.log4j.core.ContextDataInjector</code> which obtains context data from some other source.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ContextMapLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ContextMapLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ctx/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-DateLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-DateLookup"></a>date</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.DateLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the current date or the date in the LogEvent.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The "key" is used as the format String, following the java. |
| text. |
| SimpleDateFormat date and time pattern strings.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-DateLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-DateLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><date/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup"></a>env</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.EnvironmentLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from environment variables.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><env/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup"></a>event</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.EventLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up values from the log event.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><event/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup"></a>java</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.JavaLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys related to Java: Java version, JRE version, VM version, and so on.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><java/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup"></a>jvmrunargs</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.JmxRuntimeInputArgumentsLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><jvmrunargs/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup"></a>jndi</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.JndiLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from JNDI resources.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><jndi/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup"></a>log4j</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.Log4jLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lookup properties of Log4j</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><log4j/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup"></a>lower</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.LowerLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts values to lower case.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The passed in "key" should be the value of another lookup.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><lower/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup"></a>main</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.MainMapLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A map-based lookup for main arguments.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup">MainMapLookup</a>)[].</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><main/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup"></a>map</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.MapLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A map-based lookup.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><map/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup">JmxRuntimeInputArgumentsLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup">MainMapLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup"></a>marker</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.MarkerLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks-up markers.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><marker/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup"></a>bundle</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.ResourceBundleLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from resource bundles.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><bundle/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StrLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StrLookup"></a><code>StrLookup</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.StrLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lookup a String key to a String value.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This class represents the simplest form of a string to string map. |
| It has a benefit over a map in that it can create the result on demand based on the key.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This class comes complete with various factory methods. |
| If these do not suffice, you can subclass and implement your own matcher.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value on demand from the database</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StrLookup_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StrLookup_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ContextMapLookup">ContextMapLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-DateLookup">DateLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EnvironmentLookup">EnvironmentLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-EventLookup">EventLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JavaLookup">JavaLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JmxRuntimeInputArgumentsLookup">JmxRuntimeInputArgumentsLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-JndiLookup">JndiLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-Log4jLookup">Log4jLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-LowerLookup">LowerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MainMapLookup">MainMapLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MapLookup">MapLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-MarkerLookup">MarkerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-ResourceBundleLookup">ResourceBundleLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup">StructuredDataLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup">SystemPropertiesLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-UpperLookup">UpperLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup">DockerLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup">SpringLookup</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup">WebLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup"></a>sd</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.StructuredDataLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from <code>org.apache.logging.log4j.core.lookup.org.apache.logging.log4j.message.StructuredDataMessage</code> log messages.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-StructuredDataLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><sd/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup"></a>sys</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.SystemPropertiesLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Looks up keys from system properties.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-SystemPropertiesLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><sys/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-UpperLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-UpperLookup"></a>upper</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.lookup.UpperLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts values to upper case.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The passed in "key" should be the value of another lookup.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-UpperLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-lookup-UpperLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><upper/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Advertiser"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Advertiser"></a><code>Advertiser</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.Advertiser</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Advertiser_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Advertiser_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-DefaultAdvertiser">DefaultAdvertiser</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-MulticastDnsAdvertiser">MulticastDnsAdvertiser</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Facility"></a><code>Facility</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.Facility</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The facility codes used by the Syslog system.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Numerical Code</p></th> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Facility</p></th> |
| </tr> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Facility</p></th> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">kernel messages</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">user-level messages</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">mail system</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">system daemons</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">4</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">security/authorization messages</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">messages generated internally by syslogd</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">6</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">line printer subsystem</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">7</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">network news subsystem</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UUCP subsystem</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">9</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">clock daemon</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">security/authorization messages</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">11</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">FTP daemon</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">12</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">NTP subsystem</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">13</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">log audit</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">14</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">log alert</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">15</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">clock daemon (note 2)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">16</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 0 (local0)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">17</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 1 (local1)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">18</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 2 (local2)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">19</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 3 (local3)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">20</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 4 (local4)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">21</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 5 (local5)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">22</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">local use 6 (local6)</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">23</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-MulticastDnsAdvertiser"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-MulticastDnsAdvertiser"></a>MulticastDns</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.MulticastDnsAdvertiser</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Advertise an entity via ZeroConf/MulticastDNS and the JmDNS library.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The length of property names and values must be 255 bytes or less. |
| Entries with names or values larger than 255 bytes will be removed prior to advertisement.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-MulticastDnsAdvertiser_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-MulticastDnsAdvertiser_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MulticastDns/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Protocol"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Protocol"></a><code>Protocol</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.Protocol</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Enumerates the supported protocols.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Rfc1349TrafficClass"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Rfc1349TrafficClass"></a><code>Rfc1349TrafficClass</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.Rfc1349TrafficClass</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Enumerates the RFC 1349 TOS field.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>IPTOS_LOWCOST (0x02)</code></p> |
| </li> |
| <li> |
| <p><code>IPTOS_RELIABILITY (0x04)</code></p> |
| </li> |
| <li> |
| <p><code>IPTOS_THROUGHPUT (0x08)</code></p> |
| </li> |
| <li> |
| <p><code>IPTOS_LOWDELAY (0x10)</code> |
| *</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress"></a>SocketAddress</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.SocketAddress</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Plugin to hold a hostname and port (socket address).</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SocketAddress host="" |
| port=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketAddress-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>host</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>InetAddress?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>port</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions"></a>SocketOptions</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.SocketOptions</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Holds all socket options settable via <code>java.net.Socket</code> methods.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SocketOptions keepAlive="" |
| oobInline="" |
| receiveBufferSize="" |
| reuseAddress="" |
| rfc1349TrafficClass="" |
| sendBufferSize="" |
| soLinger="" |
| soTimeout="" |
| tcpNoDelay="" |
| trafficClass=""> |
| <SocketPerformancePreferences/> |
| </SocketOptions></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keepAlive</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setKeepAlive(boolean)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setKeepAlive(boolean)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>oobInline</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setOOBInline(boolean)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setOOBInline(boolean)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>receiveBufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setReceiveBufferSize(int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setReceiveBufferSize(int)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reuseAddress</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setReuseAddress(boolean)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setReuseAddress(boolean)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>rfc1349TrafficClass</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-Rfc1349TrafficClass">Rfc1349TrafficClass</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setTrafficClass(int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setTrafficClass(int)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sendBufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setSendBufferSize(int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setSendBufferSize(int)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>soLinger</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setSoLinger(boolean,int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setSoLinger(boolean,int)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>soTimeout</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setSoTimeout(int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setSoTimeout(int)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>tcpNoDelay</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setTcpNoDelay(boolean)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setTcpNoDelay(boolean)</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafficClass</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setTrafficClass(int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setTrafficClass(int)</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SocketPerformancePreferences</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences">SocketPerformancePreferences</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>See <code>java.net.Socket#setPerformancePreferences(int,int,int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <code>java.net.Socket#setPerformancePreferences(int,int,int)</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences"></a>SocketPerformancePreferences</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.SocketPerformancePreferences</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Holds all socket options settable via <code>java.net.Socket#setPerformancePreferences(int,int,int)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>java.net.Socket#setPerformancePreferences(int,int,int)</code> API may not be implemented by a JRE.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SocketPerformancePreferences bandwidth="" |
| connectionTime="" |
| latency=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bandwidth</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectionTime</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>latency</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-AbstractKeyStoreConfiguration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-AbstractKeyStoreConfiguration"></a><code>AbstractKeyStoreConfiguration</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.ssl.AbstractKeyStoreConfiguration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configuration of the KeyStore</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-AbstractKeyStoreConfiguration_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-AbstractKeyStoreConfiguration_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration">KeyStoreConfiguration</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration">TrustStoreConfiguration</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration"></a>KeyStore</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configuration of the KeyStore</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><KeyStore keyManagerFactoryAlgorithm="" |
| location="" |
| password="" |
| passwordEnvironmentVariable="" |
| passwordFile="" |
| type=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>keyManagerFactoryAlgorithm</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The standard name of the requested algorithm. |
| See the Java Secure Socket Extension Reference Guide for information about these names.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>location</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The location of the KeyStore, a file path, URL or resource.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The password to access the KeyStore.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>passwordEnvironmentVariable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>passwordFile</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The KeyStore type, null defaults to <code>"JKS"</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration"></a>Ssl</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.ssl.SslConfiguration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>SSL Configuration</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Ssl protocol=""> |
| <KeyStore/> |
| <TrustStore/> |
| </Ssl></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>protocol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The protocol, see SSLContext Algorithms</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-SslConfiguration_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>KeyStore</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration">KeyStoreConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The KeyStoreConfiguration.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TrustStore</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration">TrustStoreConfiguration</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The TrustStoreConfiguration.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-StoreConfiguration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-StoreConfiguration"></a><code>StoreConfiguration</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.ssl.StoreConfiguration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-StoreConfiguration_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-StoreConfiguration_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-KeyStoreConfiguration">KeyStoreConfiguration</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration">TrustStoreConfiguration</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration"></a>TrustStore</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configuration of the TrustStore</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><TrustStore location="" |
| password="" |
| passwordEnvironmentVariable="" |
| passwordFile="" |
| trustManagerFactoryAlgorithm="" |
| type=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-ssl-TrustStoreConfiguration-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>location</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The location of the KeyStore, a file path, URL or resource.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The password to access the KeyStore.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>passwordEnvironmentVariable</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>passwordFile</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>trustManagerFactoryAlgorithm</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The standard name of the requested trust management algorithm. |
| See the Java Secure Socket Extension Reference Guide for information these names.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>type</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The KeyStore type, null defaults to <code>"JKS"</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractPatternConverter"></a><code>AbstractPatternConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>AbstractPatternConverter is an abstract class that provides the formatting functionality that derived classes need.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. |
| Each of which is responsible for converting an object in a converter specific manner.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractPatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractPatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter">Log4j1LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter">Log4j1MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter">Log4j1NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black">Black</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue">Blue</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan">Cyan</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green">Green</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta">Magenta</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red">Red</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White">White</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow">Yellow</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter">ClassNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter">DatePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter">EncodingPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter">EndOfBatchPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter">EqualsIgnoreCaseReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter">EqualsReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter">ExtendedThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter">FileLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter">FullLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter">HighlightConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter">IntegerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter">LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter">LineLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter">LineSeparatorPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter">LoggerFqcnPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter">LoggerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter">MapPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter">MarkerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter">MarkerSimpleNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter">MaxLengthConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter">MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter">MessagePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter">MethodLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter">NanoTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter">NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter">ProcessIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter">RegexReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter">RelativeTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter">RepeatPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter">RootThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter">SequenceNumberPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter">StyleConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter">ThreadIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter">ThreadNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter">ThreadPriorityPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter">ThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter">UuidPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter">VariablesNotEmptyReplacementConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter"></a><code>AbstractStyleNameConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black">Black</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue">Blue</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan">Cyan</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green">Green</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta">Magenta</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red">Red</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White">White</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow">Yellow</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black"></a>black</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Black</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Black style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><black/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue"></a>blue</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Blue</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Blue style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><blue/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan"></a>cyan</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Cyan</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Cyan style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><cyan/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green"></a>green</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Green</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Green style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><green/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta"></a>magenta</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Magenta</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Magenta style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><magenta/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red"></a>red</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Red</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Red style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><red/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White"></a>white</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.White</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>White style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><white/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow"></a>yellow</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter.Yellow</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Yellow style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><yellow/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AnsiConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AnsiConverter"></a><code>AnsiConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.AnsiConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Marks classes that implement ANSI escape code conversions.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AnsiConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AnsiConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter">HighlightConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter">StyleConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ArrayPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ArrayPatternConverter"></a><code>ArrayPatternConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ArrayPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-logging-log4j-core-pattern-PatternConverter">PatternConverter</a>s implement this interface to accept an array of objects when formatting.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ArrayPatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ArrayPatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter">DatePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter">IntegerPatternConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter"></a>ClassNamePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ClassNamePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the class name of the site of the logging request.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ClassNamePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter"></a>DatePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.DatePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts and formats the event’s date in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><DatePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter"></a>encode</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.EncodingPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converter that encodes the output from a pattern using a specified format.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Supported formats include HTML (default) and JSON.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><encode/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter"></a>EndOfBatchPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.EndOfBatchPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the EndOfBatch.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EndOfBatchPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsBaseReplacementConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsBaseReplacementConverter"></a><code>EqualsBaseReplacementConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.EqualsBaseReplacementConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Equals pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsBaseReplacementConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsBaseReplacementConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter">EqualsIgnoreCaseReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter">EqualsReplacementConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter"></a>equalsIgnoreCase</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.EqualsIgnoreCaseReplacementConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Equals ignore case pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><equalsIgnoreCase/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter"></a>equals</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.EqualsReplacementConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Equals pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><equals/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter"></a>ExtendedThrowablePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ExtendedThrowablePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter">ThrowablePatternConverter</a> variant where the rendered <code>java.lang.StackTraceElement</code>s are enriched with the enclosing JAR file and its version information, if available.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ExtendedThrowablePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileDatePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileDatePatternConverter"></a>FileDatePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.FileDatePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a date by delegating to <a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter">DatePatternConverter</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default date pattern for a %d specifier in a file name is different than the %d pattern in pattern layout.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileDatePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileDatePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><FileDatePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter"></a>FileLocationPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.FileLocationPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s line location information in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><FileLocationPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter"></a>FullLocationPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.FullLocationPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Format the event’s line location information.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><FullLocationPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter"></a>highlight</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.HighlightConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Highlight pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the result of a pattern using a color appropriate for the Level in the LogEvent.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You can define custom colors for each Level:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=cyan, |
| TRACE=black}</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You can use a predefined style:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT}</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The available predefined styles are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>Default</code></p> |
| </li> |
| <li> |
| <p><code>Log4j</code> - The same as <code>Default</code></p> |
| </li> |
| <li> |
| <p><code>Logback</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>You can use whitespace around the comma and equal sign. |
| The names in values MUST come from the <code>org.apache.logging.log4j.core.pattern.AnsiEscape</code> enum, case is normalized to upper-case internally.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To disable ANSI output unconditionally, specify an additional option <code>disableAnsi=true</code>, or to disable ANSI output if no console is detected, specify option <code>noConsoleNoAnsi=true</code> e.g..</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">%highlight{%d{ ISO8601 } [%t] %-5level: %msg%n%throwable}{STYLE=DEFAULT, noConsoleNoAnsi=true}</code></pre> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><highlight/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter"></a>IntegerPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.IntegerPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats an integer.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><IntegerPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter"></a>LevelPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LevelPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s level in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LevelPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter"></a>LineLocationPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LineLocationPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s line location information in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LineLocationPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter"></a>LineSeparatorPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LineSeparatorPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a line separator.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LineSeparatorPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LogEventPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LogEventPatternConverter"></a><code>LogEventPatternConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LogEventPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LogEventPatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LogEventPatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter">Log4j1LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter">Log4j1MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter">Log4j1NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black">Black</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue">Blue</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan">Cyan</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green">Green</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta">Magenta</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red">Red</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White">White</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow">Yellow</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter">ClassNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter">DatePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter">EncodingPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter">EndOfBatchPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter">EqualsIgnoreCaseReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter">EqualsReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter">ExtendedThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter">FileLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter">FullLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter">HighlightConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter">LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter">LineLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter">LineSeparatorPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter">LoggerFqcnPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter">LoggerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter">MapPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter">MarkerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter">MarkerSimpleNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter">MaxLengthConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter">MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter">MessagePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter">MethodLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter">NanoTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter">NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter">ProcessIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter">RegexReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter">RelativeTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter">RepeatPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter">RootThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter">SequenceNumberPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter">StyleConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter">ThreadIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter">ThreadNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter">ThreadPriorityPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter">ThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter">UuidPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter">VariablesNotEmptyReplacementConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter"></a>LoggerFqcnPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LoggerFqcnPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the Logger FQCN.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LoggerFqcnPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter"></a>LoggerPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.LoggerPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a logger name.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LoggerPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter"></a>MapPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MapPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Able to handle the contents of the LogEvent’s MapMessage and either output the entire contents of the properties in a similar format to the java. |
| util. |
| Hashtable. |
| toString(), or to output the value of a specific key within the Map.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MapPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter"></a>MarkerPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MarkerPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns events' full marker string in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MarkerPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter"></a>MarkerNamePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MarkerSimpleNamePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Appends an event’s maker name to a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MarkerNamePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter"></a>maxLength</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MaxLengthConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Max length pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Limit contained text to a maximum length. |
| On invalid length the default value 100 is used (and an error message is logged). If max length is greater than 20, an abbreviated text will get ellipsis ("…​") appended. |
| Example usage (for email subject):</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">`%maxLen{[AppName, ${hostName}, ${web:contextPath}] %p: %c{1} - %m%notEmpty{ =>%ex{short}}}{160}`</code></pre> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><maxLength/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter"></a>MdcPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MdcPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Able to handle the contents of the LogEvent’s MDC and either output the entire contents of the properties in a similar format to the java. |
| util. |
| Hashtable. |
| toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MdcPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter"></a>MessagePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MessagePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s rendered message in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MessagePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter"></a>MethodLocationPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.MethodLocationPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s line location information in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MethodLocationPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NamePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NamePatternConverter"></a><code>NamePatternConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.NamePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Abstract base class for other pattern converters which can return only parts of their name.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NamePatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NamePatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter">ClassNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter">LoggerPatternConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter"></a>NanoTimePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.NanoTimePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Converts and formats the event’s nanoTime in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><NanoTimePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter"></a>NdcPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.NdcPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the event’s NDC in a StringBuilder.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><NdcPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-PatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-PatternConverter"></a><code>PatternConverter</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.PatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interface that all PatternConverters must implement.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-PatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-PatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1LevelPatternConverter">Log4j1LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1MdcPatternConverter">Log4j1MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-1-2-api_org-apache-log4j-pattern-Log4j1NdcPatternConverter">Log4j1NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Black">Black</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Blue">Blue</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Cyan">Cyan</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Green">Green</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Magenta">Magenta</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Red">Red</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-White">White</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-AbstractStyleNameConverter-Yellow">Yellow</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ClassNamePatternConverter">ClassNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-DatePatternConverter">DatePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EncodingPatternConverter">EncodingPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EndOfBatchPatternConverter">EndOfBatchPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsIgnoreCaseReplacementConverter">EqualsIgnoreCaseReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-EqualsReplacementConverter">EqualsReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter">ExtendedThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FileLocationPatternConverter">FileLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-FullLocationPatternConverter">FullLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-HighlightConverter">HighlightConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-IntegerPatternConverter">IntegerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LevelPatternConverter">LevelPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineLocationPatternConverter">LineLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LineSeparatorPatternConverter">LineSeparatorPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerFqcnPatternConverter">LoggerFqcnPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-LoggerPatternConverter">LoggerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MapPatternConverter">MapPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerPatternConverter">MarkerPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MarkerSimpleNamePatternConverter">MarkerSimpleNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MaxLengthConverter">MaxLengthConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MdcPatternConverter">MdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MessagePatternConverter">MessagePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-MethodLocationPatternConverter">MethodLocationPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NanoTimePatternConverter">NanoTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-NdcPatternConverter">NdcPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter">ProcessIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter">RegexReplacementConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter">RelativeTimePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter">RepeatPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter">RootThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter">SequenceNumberPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter">StyleConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter">ThreadIdPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter">ThreadNamePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter">ThreadPriorityPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter">ThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter">UuidPatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter">VariablesNotEmptyReplacementConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter"></a>ProcessIdPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ProcessIdPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ProcessIdPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ProcessIdPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement"></a>Replace</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.RegexReplacement</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Replace tokens in the LogEvent message.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Replace regex="" |
| replacement=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacement-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>regex</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Pattern?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The regular expression to locate.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>replacement</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The replacement value.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter"></a>replace</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.RegexReplacementConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Replacement pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RegexReplacementConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><replace/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter"></a>RelativeTimePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.RelativeTimePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Returns the relative time in milliseconds since JVM Startup.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RelativeTimePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RelativeTimePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter"></a>repeat</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.RepeatPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Equals pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RepeatPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><repeat/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter"></a>RootThrowablePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.RootThrowablePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter">ThrowablePatternConverter</a> variant where the stack trace causal chain is rendered in reverse order.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RootThrowablePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter"></a>SequenceNumberPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.SequenceNumberPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the event sequence number.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-SequenceNumberPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SequenceNumberPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter"></a>style</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.StyleConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Style pattern converter.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Adds ANSI color styling to the result of the enclosed pattern.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To disable ANSI output unconditionally, specify an additional option <code>disableAnsi=true</code>, or to disable ANSI output if no console is detected, specify option <code>noConsoleNoAnsi=true</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-StyleConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><style/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter"></a>ThreadIdPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ThreadIdPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the event thread ID.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadIdPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadIdPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter"></a>ThreadPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ThreadNamePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the event thread name.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadNamePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter"></a>ThreadPriorityPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ThreadPriorityPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats the event thread priority.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThreadPriorityPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadPriorityPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter"></a>ThrowablePatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.ThrowablePatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Outputs certain information extracted from the <code>java.lang.Throwable</code> associated with a <code>org.apache.logging.log4j.core.LogEvent</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThrowablePatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ThrowablePatternConverter_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-ExtendedThrowablePatternConverter">ExtendedThrowablePatternConverter</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-RootThrowablePatternConverter">RootThrowablePatternConverter</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter"></a>UuidPatternConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.UuidPatternConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Formats a UUID.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-UuidPatternConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><UuidPatternConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter"></a>notEmpty</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.pattern.VariablesNotEmptyReplacementConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>VariablesNotEmpty pattern converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-pattern-VariablesNotEmptyReplacementConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><notEmpty/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript"></a><code>AbstractScript</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.script.AbstractScript</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for the language and body of a script.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-AbstractScript_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script">Script</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile">ScriptFile</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef">ScriptRef</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script"></a>Script</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.script.Script</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for the language and body of a script.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Script language="" |
| name="" |
| scriptText=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-Script-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>language</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>scriptText</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile"></a>ScriptFile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.script.ScriptFile</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Container for the language and body of a script file along with the file location.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptFile charset="" |
| isWatched="" |
| language="" |
| name="" |
| path=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptFile-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>isWatched</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>language</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>path</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef"></a>ScriptRef</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.script.ScriptRef</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Contains a reference to a script defined elsewhere in the configuration.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ScriptRef ref=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-script-ScriptRef-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ref</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-AbstractWatcher"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-AbstractWatcher"></a><code>AbstractWatcher</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.util.AbstractWatcher</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Watcher for configuration files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Causes a reconfiguration when a file changes.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-AbstractWatcher_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-AbstractWatcher_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher">HttpWatcher</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Builder"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Builder"></a><code>Builder</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.util.Builder</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A type of builder that can be used to configure and create a instances using a Java DSL instead of through a configuration file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>These builders are primarily useful for internal code and unit tests, but they can technically be used as a verbose alternative to configuration files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When creating <em>plugin</em> builders, it is customary to create the builder class as a public static inner class called <code>Builder</code>. For instance, the builder class for <em>PatternLayout</em> would be <code>PatternLayout. Builder</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Builder_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Builder_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketOptions">SocketOptions</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-net-SocketPerformancePreferences">SocketPerformancePreferences</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair"></a>KeyValuePair</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.util.KeyValuePair</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Key/Value pair configuration item.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><KeyValuePair key="" |
| value=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-KeyValuePair-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Watcher"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Watcher"></a><code>Watcher</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.util.Watcher</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-core</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Watches for changes in a Source and performs an action when it is modified.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Watcher_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-util-Watcher_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-HttpWatcher">HttpWatcher</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-couchdb"><a class="anchor" href="#org-apache-logging-log4j_log4j-couchdb"></a><code>log4j-couchdb</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider"><a class="anchor" href="#org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider"></a>CouchDB</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.couchdb.CouchDbProvider</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-couchdb</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The Apache CouchDB implementation of <a href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider">NoSqlProvider</a>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CouchDB databaseName="" |
| factoryClassName="" |
| factoryMethodName="" |
| password="" |
| port="" |
| protocol="" |
| server="" |
| username=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>databaseName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the database to which log event documents will be written.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryClassName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>A fully qualified class name containing a static factory method capable of returning a <code>org.lightcouch.CouchDbClient</code> or <code>org.lightcouch.CouchDbProperties</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryMethodName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the public static factory method belonging to the aforementioned factory class.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The password to authenticate against the MongoDB server with, mutually exclusive with <code>factoryClassName&factoryMethodName! =null</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>port</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The port that CouchDB is listening on, defaults to 80 if <code>protocol</code> is "http" and 443 if <code>protocol</code> is "https," and mutually exclusive with <code>factoryClassName&factoryMethodName! =null</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>protocol</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Either "http" or "https," defaults to "http" and mutually exclusive with <code>factoryClassName&factoryMethodName! =null</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>server</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The host name of the CouchDB server, defaults to localhost and mutually exclusive with <code>factoryClassName&factoryMethodName! =null</code>.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>username</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The username to authenticate against the MongoDB server with, mutually exclusive with <code>factoryClassName&factoryMethodName! =null</code>.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-docker"><a class="anchor" href="#org-apache-logging-log4j_log4j-docker"></a><code>log4j-docker</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup"></a>docker</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.docker.DockerLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-docker</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lookups up keys for a Docker container.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-docker_org-apache-logging-log4j-docker-DockerLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><docker/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-jakarta-jms"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-jms"></a><code>log4j-jakarta-jms</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender"></a>JMS-Jakarta</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.mom.jakarta.JmsAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jakarta-jms</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Jakarta JMS Appender plugin for both queues and topics.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JMS-Jakarta destinationBindingName="" |
| factoryBindingName="" |
| factoryName="" |
| ignoreExceptions="" |
| immediateFail="" |
| name="" |
| password="" |
| providerUrl="" |
| reconnectIntervalMillis="" |
| securityCredentials="" |
| securityPrincipalName="" |
| urlPkgPrefixes="" |
| userName=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </JMS-Jakarta></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>destinationBindingName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryBindingName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>factoryName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>immediateFail</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>providerUrl</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>reconnectIntervalMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityCredentials</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>securityPrincipalName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>urlPkgPrefixes</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>userName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-jms_org-apache-logging-log4j-core-appender-mom-jakarta-JmsAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-jakarta-web"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web"></a><code>log4j-jakarta-web</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup"></a>web</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.web.WebLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jakarta-web</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-WebLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><web/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender"></a>Servlet</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.web.appender.ServletAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jakarta-web</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Logs using the ServletContext’s log method</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><Servlet ignoreExceptions="" |
| logThrowables="" |
| name=""> |
| <a-Filter-implementation/> |
| <a-Layout-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </Servlet></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>logThrowables</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Logs with <code>jakarta.servlet.ServletContext#log(String,Throwable)</code> if true and with <code>jakarta.servlet.ServletContext#log(String)</code> if false.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Logs with <code>jakarta.servlet.ServletContext#log(String,Throwable)</code> if true and with <code>jakarta.servlet.ServletContext#log(String)</code> if false.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-jakarta-web_org-apache-logging-log4j-web-appender-ServletAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Layout">Layout</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-jdbc-dbcp2"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2"></a><code>log4j-jdbc-dbcp2</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig"></a>PoolableConnectionFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.PoolableConnectionFactoryConfig</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jdbc-dbcp2</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Configures an Apache Commons DBCP <code>org.apache.commons.dbcp2.PoolableConnectionFactory</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PoolableConnectionFactory autoCommitOnReturn="" |
| cacheState="" |
| defaultAutoCommit="" |
| defaultCatalog="" |
| defaultQueryTimeoutSeconds="" |
| defaultReadOnly="" |
| defaultTransactionIsolation="" |
| fastFailValidation="" |
| maxConnLifetimeMillis="" |
| maxOpenPreparedStatements="" |
| poolStatements="" |
| rollbackOnReturn="" |
| validationQuery="" |
| validationQueryTimeoutSeconds=""> |
| <a-String-implementation/><!-- multiple occurrences allowed --> |
| </PoolableConnectionFactory></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>autoCommitOnReturn</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>cacheState</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultAutoCommit</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultCatalog</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultQueryTimeoutSeconds</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultReadOnly</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>defaultTransactionIsolation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>fastFailValidation</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxConnLifetimeMillis</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxOpenPreparedStatements</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>poolStatements</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>rollbackOnReturn</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>validationQuery</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>validationQueryTimeoutSeconds</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource"></a>PoolingDriver</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jdbc.PoolingDriverConnectionSource</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jdbc-dbcp2</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-ConnectionSource">ConnectionSource</a> that uses a JDBC connection string, a user name, and a password to call <code>java.sql.DriverManager#getConnection(String,String,String)</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The connections are served from an Apache Commons DBCP pooling driver.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PoolingDriver connectionString="" |
| driverClassName="" |
| password="" |
| poolName="" |
| userName=""> |
| <PoolableConnectionFactory/> |
| <Property/><!-- multiple occurrences allowed --> |
| </PoolingDriver></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connectionString</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>driverClassName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>password</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>poolName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>userName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolingDriverConnectionSource_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PoolableConnectionFactory</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-jdbc-dbcp2_org-apache-logging-log4j-core-appender-db-jdbc-PoolableConnectionFactoryConfig">PoolableConnectionFactoryConfig</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-jpa"><a class="anchor" href="#org-apache-logging-log4j_log4j-jpa"></a><code>log4j-jpa</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender"><a class="anchor" href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender"></a>JPA</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.db.jpa.JpaAppender</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-jpa</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>This Appender writes logging events to a relational database using the Java Persistence API.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It requires a pre-configured JPA persistence unit and a concrete implementation of the abstract <code>org.apache.logging.log4j.core.appender.db.jpa.AbstractLogEventWrapperEntity</code> class decorated with JPA annotations.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JPA bufferSize="" |
| entityClassName="" |
| ignoreExceptions="" |
| name="" |
| persistenceUnitName=""> |
| <a-Filter-implementation/> |
| </JPA></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>bufferSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If an integer greater than 0, this causes the appender to buffer log events and flush whenever the buffer reaches this size.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>entityClassName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The fully qualified name of the concrete <code>org.apache.logging.log4j.core.appender.db.jpa.AbstractLogEventWrapperEntity</code> implementation that has JPA annotations mapping it to a database table.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>ignoreExceptions</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>If <code>"true"</code> (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the appender.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>persistenceUnitName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The name of the JPA persistence unit that should be used for persisting log events.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-jpa_org-apache-logging-log4j-core-appender-db-jpa-JpaAppender_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The filter, if any, to use.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-layout-template-json"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json"></a><code>log4j-layout-template-json</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout"></a>JsonTemplateLayout</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.JsonTemplateLayout</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><JsonTemplateLayout charset="" |
| eventDelimiter="" |
| eventTemplate="" |
| eventTemplateRootObjectKey="" |
| eventTemplateUri="" |
| locationInfoEnabled="" |
| maxStringLength="" |
| nullEventDelimiterEnabled="" |
| recyclerFactory="" |
| stackTraceElementTemplate="" |
| stackTraceElementTemplateUri="" |
| stackTraceEnabled="" |
| truncatedStringSuffix=""> |
| <EventTemplateAdditionalField/><!-- multiple occurrences allowed --> |
| </JsonTemplateLayout></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>charset</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Charset?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventDelimiter</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventTemplate</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventTemplateRootObjectKey</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>eventTemplateUri</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>locationInfoEnabled</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>maxStringLength</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>int?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>nullEventDelimiterEnabled</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>recyclerFactory</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactory">RecyclerFactory</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stackTraceElementTemplate</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stackTraceElementTemplateUri</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>stackTraceEnabled</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>truncatedStringSuffix</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>EventTemplateAdditionalField</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField">EventTemplateAdditionalField</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField"></a>EventTemplateAdditionalField</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.JsonTemplateLayout.EventTemplateAdditionalField</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EventTemplateAdditionalField format="" |
| key="" |
| value=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>format</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField-Format">Format</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>key</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>value</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField-Format"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField-Format"></a><code>Format</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.JsonTemplateLayout.EventTemplateAdditionalField.Format</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory"></a>CaseConverterResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CaseConverterResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory"></a>CounterResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.CounterResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><CounterResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory"></a>EndOfBatchResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EndOfBatchResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor"></a>EventAdditionalFieldInterceptor</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interceptor to add <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-JsonTemplateLayout-EventTemplateAdditionalField">additional fields</a> after event template read.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EventAdditionalFieldInterceptor/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverFactory"></a><code>EventResolverFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverFactory">TemplateResolverFactory</a> specialized for <code>org.apache.logging.log4j.core.LogEvent</code>s.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverFactory_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverFactory_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory">CaseConverterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory">CounterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory">EndOfBatchResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory">ExceptionResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory">ExceptionRootCauseResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory">LevelResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory">LoggerResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory">MainMapResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory">MapResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory">MarkerResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory">MessageParameterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory">MessageResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory">PatternResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory">SourceResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory">ThreadContextDataResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory">ThreadContextStackResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory">ThreadResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory">TimestampResolverFactory</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverInterceptor"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverInterceptor"></a><code>EventResolverInterceptor</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverInterceptor">TemplateResolverInterceptor</a> specialized for <code>org.apache.logging.log4j.core.LogEvent</code>s.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverInterceptor_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventResolverInterceptor_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor">EventAdditionalFieldInterceptor</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor">EventRootObjectKeyInterceptor</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor"></a>EventRootObjectKeyInterceptor</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.EventRootObjectKeyInterceptor</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Interceptor to add a root object key to the event template.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><EventRootObjectKeyInterceptor/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory"></a>ExceptionResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ExceptionResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory"></a>ExceptionRootCauseResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ExceptionRootCauseResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory"></a>LevelResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.LevelResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LevelResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory"></a>LoggerResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.LoggerResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><LoggerResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory"></a>MainMapResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MainMapResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MainMapResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory"></a>MapResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MapResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MapResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory"></a>MarkerResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MarkerResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MarkerResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory"></a>MessageParameterResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MessageParameterResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory"></a>MessageResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>A <code>org.apache.logging.log4j.layout.template.json.resolver.MessageResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MessageResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory"></a>PatternResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.PatternResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><PatternResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory"></a>SourceResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.SourceResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SourceResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverFactory"></a><code>TemplateResolverFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverFactory_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverFactory_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CaseConverterResolverFactory">CaseConverterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-CounterResolverFactory">CounterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EndOfBatchResolverFactory">EndOfBatchResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionResolverFactory">ExceptionResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ExceptionRootCauseResolverFactory">ExceptionRootCauseResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LevelResolverFactory">LevelResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-LoggerResolverFactory">LoggerResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MainMapResolverFactory">MainMapResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MapResolverFactory">MapResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MarkerResolverFactory">MarkerResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageParameterResolverFactory">MessageParameterResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-MessageResolverFactory">MessageResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-PatternResolverFactory">PatternResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-SourceResolverFactory">SourceResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory">ThreadContextDataResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory">ThreadContextStackResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory">ThreadResolverFactory</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory">TimestampResolverFactory</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverInterceptor"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverInterceptor"></a><code>TemplateResolverInterceptor</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Main <code>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolver</code> compilation interception interface.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverInterceptor_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TemplateResolverInterceptor_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventAdditionalFieldInterceptor">EventAdditionalFieldInterceptor</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-EventRootObjectKeyInterceptor">EventRootObjectKeyInterceptor</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory"></a>ThreadContextDataResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextDataResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadContextDataResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory"></a>ThreadContextStackResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadContextStackResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadContextStackResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory"></a>ThreadResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.ThreadResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-ThreadResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><ThreadResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory"></a>TimestampResolverFactory</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p><code>org.apache.logging.log4j.layout.template.json.resolver.TimestampResolver</code> factory.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-resolver-TimestampResolverFactory_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><TimestampResolverFactory/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactory"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactory"></a><code>RecyclerFactory</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.util.RecyclerFactory</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactoryConverter"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactoryConverter"></a>RecyclerFactoryConverter</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-layout-template-json</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The default string (i.e., recycler factory spec) to <a href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactory">RecyclerFactory</a> type converter.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactoryConverter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-layout-template-json_org-apache-logging-log4j-layout-template-json-util-RecyclerFactoryConverter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><RecyclerFactoryConverter/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-mongodb"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb"></a><code>log4j-mongodb</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider"></a><code>NoSqlProvider</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.appender.nosql.NoSqlProvider</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-mongodb</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-couchdb_org-apache-logging-log4j-couchdb-CouchDbProvider">CouchDbProvider</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider">MongoDbProvider</a></p> |
| </li> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider">MongoDb4Provider</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider"></a>MongoDb</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.mongodb.MongoDbProvider</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-mongodb</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Delegates to <a href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider">MongoDb4Provider</a> under the name <code>MongoDb</code>.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MongoDb capped="" |
| collectionName="" |
| collectionSize="" |
| connection="" |
| databaseName=""> |
| <a-Filter-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </MongoDb></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>capped</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>collectionName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>collectionSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connection</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>databaseName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb_org-apache-logging-log4j-mongodb-MongoDbProvider_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-mongodb4"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb4"></a><code>log4j-mongodb4</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider"></a>MongoDb4</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.mongodb4.MongoDb4Provider</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-mongodb4</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The MongoDB implementation of <a href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-core-appender-nosql-NoSqlProvider">NoSqlProvider</a> using the MongoDB driver version 4 API.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><MongoDb4 capped="" |
| collectionName="" |
| collectionSize="" |
| connection="" |
| databaseName=""> |
| <a-Filter-implementation/> |
| <Property/><!-- multiple occurrences allowed --> |
| </MongoDb4></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>capped</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>boolean?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets whether the MongoDB collection is capped.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>collectionName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets name of the collection for the appender to output to</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>collectionSize</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>long?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the maximum size in bytes of a capped collection.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Sets the maximum size in bytes of a capped collection.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>connection</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the MongoDB connection string.</p> |
| </div></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>databaseName</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the name of the logical database for the appender to output to.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider_components"><a class="anchor" href="#org-apache-logging-log4j_log4j-mongodb4_org-apache-logging-log4j-mongodb4-MongoDb4Provider_components"></a>Nested components</h5> |
| <div class="paragraph"> |
| <p>Optional components are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 14.2857%;"> |
| <col style="width: 14.2857%;"> |
| <col style="width: 71.4286%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Tag</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Property</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-Property">Property</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-Filter">Filter</a>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="org-apache-logging-log4j_log4j-spring-boot"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot"></a><code>log4j-spring-boot</code></h3> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-core-config-LoggerContextAware"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-core-config-LoggerContextAware"></a><code>LoggerContextAware</code></h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.core.config.LoggerContextAware</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-spring-boot</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-core-config-LoggerContextAware_implementations"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-core-config-LoggerContextAware_implementations"></a>Known implementations</h5> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup">SpringLookup</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup"></a>spring</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.spring.boot.SpringLookup</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-spring-boot</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>Lookup for Spring properties.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringLookup_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><spring/></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter"></a>SpringProfile</h4> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">Class</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j.spring.boot.SpringProfileArbiter</code></p> |
| </dd> |
| <dt class="hdlist1">Provider</dt> |
| <dd> |
| <p><code>org.apache.logging.log4j:log4j-spring-boot</code></p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>An Aribter that uses the active Spring profile to determine if configuration should be included.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter_XML-snippet"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter_XML-snippet"></a>XML snippet</h5> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><SpringProfile name=""/></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter-attributes"><a class="anchor" href="#org-apache-logging-log4j_log4j-spring-boot_org-apache-logging-log4j-spring-boot-SpringProfileArbiter-attributes"></a>Attributes</h5> |
| <div class="paragraph"> |
| <p>Optional attributes are denoted by <code>?</code>-suffixed types.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <colgroup> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 62.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Name</th> |
| <th class="tableblock halign-left valign-top">Type</th> |
| <th class="tableblock halign-left valign-top">Default</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>name</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String?</code></p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Sets the Profile Name or Names.</p> |
| </div></div></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </article> |
| </div> |
| </main> |
| </div> |
| <footer class="footer"> |
| <p> |
| Copyright © 1999-2026 <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License, Version 2.0</a>. |
| Please read our <a href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy policy</a>. |
| </p> |
| <p> |
| Apache, Log4j, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| Other names may be trademarks of their respective owners. |
| </p> |
| </footer> |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '42']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <noscript><p><img src="https://analytics.apache.org/matomo.php?idsite=42&rec=1" style="border:0;" alt="" /></p></noscript> |
| <!-- End Matomo Code --> |
| <script id="site-script" src="./_/js/site.js" data-ui-root-path="./_"></script> |
| <script async src="./_/js/vendor/highlight.js"></script> |
| <!-- `@asciidoctor/tabs` extension scripts --> |
| <script async src="./_/js/vendor/tabs.js"></script> |
| </body> |
| </html> |