Package org.apache.logging.log4j.core.appender

Class SocketAppender.AbstractBuilder<B extends SocketAppender.AbstractBuilder<B>>

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<B>

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>

org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder<B>

org.apache.logging.log4j.core.appender.SocketAppender.AbstractBuilder<B>

Type Parameters:

B - The type to build.

Direct Known Subclasses:

SocketAppender.Builder, SyslogAppender.Builder

Enclosing class:

SocketAppender

public abstract static class SocketAppender.AbstractBuilder<B extends SocketAppender.AbstractBuilder<B>>
extends AbstractOutputStreamAppender.Builder<B>

Subclasses can extend this abstract Builder.

Defaults

• host: "localhost"
• protocol: "TCP"

Changes

• Removed deprecated "delayMillis", use "reconnectionDelayMillis".
• Removed deprecated "reconnectionDelay", use "reconnectionDelayMillis".

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	advertise
private int	connectTimeoutMillis
private java.lang.String	host
private boolean	immediateFail
private int	port
private Protocol	protocol
private int	reconnectDelayMillis
private SocketOptions	socketOptions
private SslConfiguration	sslConfiguration

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
boolean	getAdvertise()
int	getConnectTimeoutMillis()
java.lang.String	getHost()
boolean	getImmediateFail()
int	getPort()
Protocol	getProtocol()
int	getReconnectDelayMillis()
SocketOptions	getSocketOptions()
SslConfiguration	getSslConfiguration()
B	setAdvertise(boolean advertise)
B	setConnectTimeoutMillis(int connectTimeoutMillis)
B	setHost(java.lang.String host)
B	setImmediateFail(boolean immediateFail)
B	setPort(int port)
B	setProtocol(Protocol protocol)
B	setReconnectDelayMillis(int reconnectDelayMillis)
B	setSocketOptions(SocketOptions socketOptions)
B	setSslConfiguration(SslConfiguration sslConfiguration)
B	withAdvertise(boolean advertise)	Deprecated.
B	withConnectTimeoutMillis(int connectTimeoutMillis)	Deprecated.
B	withHost(java.lang.String host)	Deprecated.
B	withImmediateFail(boolean immediateFail)	Deprecated.
B	withPort(int port)	Deprecated.
B	withProtocol(Protocol protocol)	Deprecated.
B	withReconnectDelayMillis(int reconnectDelayMillis)	Deprecated.
B	withSocketOptions(SocketOptions socketOptions)	Deprecated.
B	withSslConfiguration(SslConfiguration sslConfiguration)	Deprecated.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder

getBufferSize, isBufferedIo, isImmediateFlush, setBufferedIo, setBufferSize, setImmediateFlush, withBufferedIo, withBufferSize, withImmediateFlush

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender.Builder

getConfiguration, getErrorPrefix, getLayout, getName, getOrCreateLayout, getOrCreateLayout, isIgnoreExceptions, setConfiguration, setIgnoreExceptions, setLayout, setName, withConfiguration, withIgnoreExceptions, withLayout, withName

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class java.lang.Object

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

Field Detail

advertise

@PluginBuilderAttribute
private boolean advertise

connectTimeoutMillis

@PluginBuilderAttribute
private int connectTimeoutMillis

host

@PluginBuilderAttribute
@ValidHost
private java.lang.String host

immediateFail

@PluginBuilderAttribute
private boolean immediateFail

port

@PluginBuilderAttribute
@ValidPort
private int port

protocol

@PluginBuilderAttribute
private Protocol protocol

reconnectDelayMillis

@PluginBuilderAttribute
@PluginAliases({"reconnectDelay","reconnectionDelay","delayMillis","reconnectionDelayMillis"})
private int reconnectDelayMillis

socketOptions

@PluginElement("SocketOptions")
private SocketOptions socketOptions

sslConfiguration

@PluginElement("SslConfiguration")
@PluginAliases("SslConfig")
private SslConfiguration sslConfiguration

Constructor Detail

AbstractBuilder

public AbstractBuilder()

Method Detail

getAdvertise

public boolean getAdvertise()

getConnectTimeoutMillis

public int getConnectTimeoutMillis()

getHost

public java.lang.String getHost()

getPort

public int getPort()

getProtocol

public Protocol getProtocol()

getSslConfiguration

public SslConfiguration getSslConfiguration()

getImmediateFail

public boolean getImmediateFail()

setAdvertise

public B setAdvertise(boolean advertise)

setConnectTimeoutMillis

public B setConnectTimeoutMillis(int connectTimeoutMillis)

setHost

public B setHost(java.lang.String host)

setImmediateFail

public B setImmediateFail(boolean immediateFail)

setPort

public B setPort(int port)

setProtocol

public B setProtocol(Protocol protocol)

setReconnectDelayMillis

public B setReconnectDelayMillis(int reconnectDelayMillis)

setSocketOptions

public B setSocketOptions(SocketOptions socketOptions)

setSslConfiguration

public B setSslConfiguration(SslConfiguration sslConfiguration)

withAdvertise

@Deprecated
public B withAdvertise(boolean advertise)

Deprecated.

withConnectTimeoutMillis

@Deprecated
public B withConnectTimeoutMillis(int connectTimeoutMillis)

Deprecated.

withHost

@Deprecated
public B withHost(java.lang.String host)

Deprecated.

withImmediateFail

@Deprecated
public B withImmediateFail(boolean immediateFail)

Deprecated.

withPort

@Deprecated
public B withPort(int port)

Deprecated.

withProtocol

@Deprecated
public B withProtocol(Protocol protocol)

Deprecated.

withReconnectDelayMillis

@Deprecated
public B withReconnectDelayMillis(int reconnectDelayMillis)

Deprecated.

withSocketOptions

@Deprecated
public B withSocketOptions(SocketOptions socketOptions)

Deprecated.

withSslConfiguration

@Deprecated
public B withSslConfiguration(SslConfiguration sslConfiguration)

Deprecated.

getReconnectDelayMillis

public int getReconnectDelayMillis()

getSocketOptions

public SocketOptions getSocketOptions()