| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SyslogAppender (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender, class: SyslogAppender"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/SyslogAppender.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.appender</a></div> |
| <h1 title="Class SyslogAppender" class="title">Class SyslogAppender</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable</a> |
| <div class="inheritance"><a href="AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractAppender</a> |
| <div class="inheritance"><a href="AbstractOutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender</a><<a href="../net/AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a>> |
| <div class="inheritance"><a href="SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.SocketAppender</a> |
| <div class="inheritance">org.apache.logging.log4j.core.appender.SyslogAppender</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></code>, <code><a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></code>, <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../config/plugins/Plugin.html#name()">name</a>="Syslog", |
| <a href="../config/plugins/Plugin.html#category()">category</a>="Core", |
| <a href="../config/plugins/Plugin.html#elementType()">elementType</a>="appender", |
| <a href="../config/plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">SyslogAppender</span> |
| <span class="extends-implements">extends <a href="SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></span></div> |
| <div class="block">The Syslog Appender.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="SyslogAppender.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><<a href="SyslogAppender.Builder.html" title="type parameter in SyslogAppender.Builder">B</a> extends <a href="SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><<a href="SyslogAppender.Builder.html" title="type parameter in SyslogAppender.Builder">B</a>>></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.appender.SocketAppender">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.<a href="SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></h2> |
| <code><a href="SocketAppender.AbstractBuilder.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender.AbstractBuilder</a><<a href="SocketAppender.AbstractBuilder.html" title="type parameter in SocketAppender.AbstractBuilder">B</a> extends <a href="SocketAppender.AbstractBuilder.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender.AbstractBuilder</a><<a href="SocketAppender.AbstractBuilder.html" title="type parameter in SocketAppender.AbstractBuilder">B</a>>></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2> |
| <code><a href="../LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#RFC5424" class="member-name-link">RFC5424</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../AbstractLifeCycle.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Appender">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a></h3> |
| <code><a href="../Appender.html#ELEMENT_TYPE">ELEMENT_TYPE</a>, <a href="../Appender.html#EMPTY_ARRAY">EMPTY_ARRAY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser)" class="member-name-link">SyslogAppender</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| boolean ignoreExceptions, |
| boolean immediateFlush, |
| <a href="../net/AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a> manager, |
| <a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser,org.apache.logging.log4j.core.config.Property%5B%5D)"><code>SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[])</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser,org.apache.logging.log4j.core.config.Property%5B%5D)" class="member-name-link">SyslogAppender</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| boolean ignoreExceptions, |
| boolean immediateFlush, |
| <a href="../net/AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a> manager, |
| <a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser, |
| <a href="../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <B extends <a href="SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><B>><br><a href="SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createAppender(java.lang.String,int,java.lang.String,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,int,boolean,java.lang.String,boolean,boolean,org.apache.logging.log4j.core.net.Facility,java.lang.String,int,boolean,java.lang.String,java.lang.String,java.lang.String,boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,java.lang.String,org.apache.logging.log4j.core.layout.LoggerFields%5B%5D,boolean)" class="member-name-link">createAppender</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> protocolStr, |
| <a href="../net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a> sslConfiguration, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean immediateFlush, |
| boolean ignoreExceptions, |
| <a href="../net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a> facility, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id, |
| int enterpriseNumber, |
| boolean includeMdc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mdcId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mdcPrefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventPrefix, |
| boolean newLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> escapeNL, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msgId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> excludes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> includes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> required, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> format, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> exceptionPattern, |
| <a href="../layout/LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[] loggerFields, |
| boolean advertise)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#newSyslogAppenderBuilder()"><code>newSyslogAppenderBuilder()</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <B extends <a href="SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><B>><br>B</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newSyslogAppenderBuilder()" class="member-name-link">newSyslogAppenderBuilder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.SocketAppender">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></h3> |
| <code><a href="SocketAppender.html#createAppender(java.lang.String,int,org.apache.logging.log4j.core.net.Protocol,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,int,boolean,java.lang.String,boolean,boolean,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,org.apache.logging.log4j.core.config.Configuration)">createAppender</a>, <a href="SocketAppender.html#createAppender(java.lang.String,java.lang.String,java.lang.String,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,java.lang.String,org.apache.logging.log4j.core.config.Configuration)">createAppender</a>, <a href="SocketAppender.html#createSocketManager(java.lang.String,org.apache.logging.log4j.core.net.Protocol,java.lang.String,int,int,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,boolean,org.apache.logging.log4j.core.Layout,int)">createSocketManager</a>, <a href="SocketAppender.html#createSocketManager(java.lang.String,org.apache.logging.log4j.core.net.Protocol,java.lang.String,int,int,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,boolean,org.apache.logging.log4j.core.Layout,int,org.apache.logging.log4j.core.net.SocketOptions)">createSocketManager</a>, <a href="SocketAppender.html#directEncodeEvent(org.apache.logging.log4j.core.LogEvent)">directEncodeEvent</a>, <a href="SocketAppender.html#newBuilder()">newBuilder</a>, <a href="SocketAppender.html#stop(long,java.util.concurrent.TimeUnit)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractOutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractOutputStreamAppender</a></h3> |
| <code><a href="AbstractOutputStreamAppender.html#append(org.apache.logging.log4j.core.LogEvent)">append</a>, <a href="AbstractOutputStreamAppender.html#getImmediateFlush()">getImmediateFlush</a>, <a href="AbstractOutputStreamAppender.html#getManager()">getManager</a>, <a href="AbstractOutputStreamAppender.html#start()">start</a>, <a href="AbstractOutputStreamAppender.html#stop(long,java.util.concurrent.TimeUnit,boolean)">stop</a>, <a href="AbstractOutputStreamAppender.html#writeByteArrayToManager(org.apache.logging.log4j.core.LogEvent)">writeByteArrayToManager</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractAppender">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></h3> |
| <code><a href="AbstractAppender.html#error(java.lang.String)">error</a>, <a href="AbstractAppender.html#error(java.lang.String,java.lang.Throwable)">error</a>, <a href="AbstractAppender.html#error(java.lang.String,org.apache.logging.log4j.core.LogEvent,java.lang.Throwable)">error</a>, <a href="AbstractAppender.html#getHandler()">getHandler</a>, <a href="AbstractAppender.html#getLayout()">getLayout</a>, <a href="AbstractAppender.html#getName()">getName</a>, <a href="AbstractAppender.html#ignoreExceptions()">ignoreExceptions</a>, <a href="AbstractAppender.html#parseInt(java.lang.String,int)">parseInt</a>, <a href="AbstractAppender.html#requiresLocation()">requiresLocation</a>, <a href="AbstractAppender.html#setHandler(org.apache.logging.log4j.core.ErrorHandler)">setHandler</a>, <a href="AbstractAppender.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">toSerializable</a>, <a href="AbstractAppender.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h3> |
| <code><a href="../filter/AbstractFilterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../filter/AbstractFilterable.html#getFilter()">getFilter</a>, <a href="../filter/AbstractFilterable.html#getPropertyArray()">getPropertyArray</a>, <a href="../filter/AbstractFilterable.html#hasFilter()">hasFilter</a>, <a href="../filter/AbstractFilterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../filter/AbstractFilterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../AbstractLifeCycle.html#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../AbstractLifeCycle.html#stop()">stop</a>, <a href="../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3> |
| <code><a href="../LifeCycle.html#getState()">getState</a>, <a href="../LifeCycle.html#initialize()">initialize</a>, <a href="../LifeCycle.html#isStarted()">isStarted</a>, <a href="../LifeCycle.html#isStopped()">isStopped</a>, <a href="../LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="RFC5424"> |
| <h3>RFC5424</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">RFC5424</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.appender.SyslogAppender.RFC5424">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser,org.apache.logging.log4j.core.config.Property[])"> |
| <h3>SyslogAppender</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">SyslogAppender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| boolean ignoreExceptions, |
| boolean immediateFlush, |
| <a href="../net/AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a> manager, |
| <a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser, |
| <a href="../config/Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser)"> |
| <h3>SyslogAppender</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">SyslogAppender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| boolean ignoreExceptions, |
| boolean immediateFlush, |
| <a href="../net/AbstractSocketManager.html" title="class in org.apache.logging.log4j.core.net">AbstractSocketManager</a> manager, |
| <a href="../net/Advertiser.html" title="interface in org.apache.logging.log4j.core.net">Advertiser</a> advertiser)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.core.Layout,org.apache.logging.log4j.core.Filter,boolean,boolean,org.apache.logging.log4j.core.net.AbstractSocketManager,org.apache.logging.log4j.core.net.Advertiser,org.apache.logging.log4j.core.config.Property%5B%5D)"><code>SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[])</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createAppender(java.lang.String,int,java.lang.String,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,int,boolean,java.lang.String,boolean,boolean,org.apache.logging.log4j.core.net.Facility,java.lang.String,int,boolean,java.lang.String,java.lang.String,java.lang.String,boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,java.lang.String,org.apache.logging.log4j.core.layout.LoggerFields[],boolean)"> |
| <h3>createAppender</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="type-parameters"><B extends <a href="SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><B>></span> |
| <span class="return-type"><a href="SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></span> <span class="element-name">createAppender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| int port, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> protocolStr, |
| <a href="../net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a> sslConfiguration, |
| int connectTimeoutMillis, |
| int reconnectDelayMillis, |
| boolean immediateFail, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean immediateFlush, |
| boolean ignoreExceptions, |
| <a href="../net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a> facility, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id, |
| int enterpriseNumber, |
| boolean includeMdc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mdcId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mdcPrefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventPrefix, |
| boolean newLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> escapeNL, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> msgId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> excludes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> includes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> required, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> format, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> exceptionPattern, |
| <a href="../layout/LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[] loggerFields, |
| boolean advertise)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#newSyslogAppenderBuilder()"><code>newSyslogAppenderBuilder()</code></a>.</div> |
| </div> |
| <div class="block">Creates a SyslogAppender.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - The name of the host to connect to.</dd> |
| <dd><code>port</code> - The port to connect to on the target host.</dd> |
| <dd><code>protocolStr</code> - The Protocol to use.</dd> |
| <dd><code>sslConfiguration</code> - TODO</dd> |
| <dd><code>connectTimeoutMillis</code> - the connect timeout in milliseconds.</dd> |
| <dd><code>reconnectDelayMillis</code> - The interval in which failed writes should be retried.</dd> |
| <dd><code>immediateFail</code> - True if the write should fail if no socket is immediately available.</dd> |
| <dd><code>name</code> - The name of the Appender.</dd> |
| <dd><code>immediateFlush</code> - "true" if data should be flushed on each write.</dd> |
| <dd><code>ignoreExceptions</code> - If <code>"true"</code> (default) exceptions encountered when appending events are logged; |
| otherwise they are propagated to the caller.</dd> |
| <dd><code>facility</code> - The Facility is used to try to classify the message.</dd> |
| <dd><code>id</code> - The default structured data id to use when formatting according to RFC 5424.</dd> |
| <dd><code>enterpriseNumber</code> - The IANA enterprise number.</dd> |
| <dd><code>includeMdc</code> - Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog |
| record. Defaults to "true:.</dd> |
| <dd><code>mdcId</code> - The id to use for the MDC Structured Data Element.</dd> |
| <dd><code>mdcPrefix</code> - The prefix to add to MDC key names.</dd> |
| <dd><code>eventPrefix</code> - The prefix to add to event key names.</dd> |
| <dd><code>newLine</code> - If true, a newline will be appended to the end of the syslog record. The default is false.</dd> |
| <dd><code>escapeNL</code> - String that should be used to replace newlines within the message text.</dd> |
| <dd><code>appName</code> - The value to use as the APP-NAME in the RFC 5424 syslog record.</dd> |
| <dd><code>msgId</code> - The default value to be used in the MSGID field of RFC 5424 syslog records.</dd> |
| <dd><code>excludes</code> - A comma separated list of mdc keys that should be excluded from the LogEvent.</dd> |
| <dd><code>includes</code> - A comma separated list of mdc keys that should be included in the FlumeEvent.</dd> |
| <dd><code>required</code> - A comma separated list of mdc keys that must be present in the MDC.</dd> |
| <dd><code>format</code> - If set to "RFC5424" the data will be formatted in accordance with RFC 5424. Otherwise, |
| it will be formatted as a BSD Syslog record.</dd> |
| <dd><code>filter</code> - A Filter to determine if the event should be handled by this Appender.</dd> |
| <dd><code>configuration</code> - The Configuration.</dd> |
| <dd><code>charset</code> - The character set to use when converting the syslog String to a byte array.</dd> |
| <dd><code>exceptionPattern</code> - The converter pattern to use for formatting exceptions.</dd> |
| <dd><code>loggerFields</code> - The logger fields</dd> |
| <dd><code>advertise</code> - Whether to advertise</dd> |
| <dt>Returns:</dt> |
| <dd>A SyslogAppender.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newSyslogAppenderBuilder()"> |
| <h3>newSyslogAppenderBuilder</h3> |
| <div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a> |
| </span><span class="modifiers">public static</span> <span class="type-parameters"><B extends <a href="SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a><B>></span> |
| <span class="return-type">B</span> <span class="element-name">newSyslogAppenderBuilder</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
