Class JdbcAppender.Builder<B extends JdbcAppender.Builder<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.db.AbstractDatabaseAppender.Builder<B>

org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.Builder<B>

All Implemented Interfaces:

Builder<JdbcAppender>

Enclosing class:

JdbcAppender

public static class JdbcAppender.Builder<B extends JdbcAppender.Builder<B>>
extends AbstractDatabaseAppender.Builder<B>
implements Builder<JdbcAppender>

Field Summary

Fields

Modifier and Type	Field	Description
private int	bufferSize
private ColumnConfig[]	columnConfigs
private ColumnMapping[]	columnMappings
private ConnectionSource	connectionSource
private boolean	immediateFail
private long	reconnectIntervalMillis
private String	tableName
private boolean	truncateStrings

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JdbcAppender	build()	Builds the object after all configuration has been set.
long	getReconnectIntervalMillis()
boolean	isImmediateFail()
B	setBufferSize(int bufferSize)	If an integer greater than 0, this causes the appender to buffer log events and flush whenever the buffer reaches this size.
B	setColumnConfigs(ColumnConfig... columnConfigs)	Information about the columns that log event data should be inserted into and how to insert that data.
B	setColumnMappings(ColumnMapping... columnMappings)
B	setConnectionSource(ConnectionSource connectionSource)	The connections source from which database connections should be retrieved.
void	setImmediateFail(boolean immediateFail)
void	setReconnectIntervalMillis(long reconnectIntervalMillis)
B	setTableName(String tableName)	The name of the database table to insert log events into.
B	setTruncateStrings(boolean truncateStrings)

Methods inherited from class AbstractAppender.Builder

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

Methods inherited from class AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setFilter, setPropertyArray, withFilter

Methods inherited from class Object

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

Methods inherited from interface Builder

getErrorPrefix, isValid

Field Details

connectionSource

@PluginElement("ConnectionSource")
@Required(message="No ConnectionSource provided")
private ConnectionSource connectionSource

immediateFail

@PluginBuilderAttribute
private boolean immediateFail

bufferSize

@PluginBuilderAttribute
private int bufferSize

tableName

@PluginBuilderAttribute
@Required(message="No table name provided")
private String tableName

columnConfigs

@PluginElement("ColumnConfigs")
private ColumnConfig[] columnConfigs

columnMappings

@PluginElement("ColumnMappings")
private ColumnMapping[] columnMappings

truncateStrings

@PluginBuilderAttribute
private boolean truncateStrings

reconnectIntervalMillis

@PluginBuilderAttribute
private long reconnectIntervalMillis

Constructor Details

Builder

public Builder()

Method Details

build

public JdbcAppender build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<B extends JdbcAppender.Builder<B>>

Returns:

the configured instance.

getReconnectIntervalMillis

public long getReconnectIntervalMillis()

isImmediateFail

public boolean isImmediateFail()

setBufferSize

public B setBufferSize(int bufferSize)

If an integer greater than 0, this causes the appender to buffer log events and flush whenever the buffer reaches this size.

Parameters:

bufferSize - buffer size.

Returns:

this

setColumnConfigs

public B setColumnConfigs(ColumnConfig... columnConfigs)

Information about the columns that log event data should be inserted into and how to insert that data.

Parameters:

columnConfigs - Column configurations.

Returns:

this

setColumnMappings

public B setColumnMappings(ColumnMapping... columnMappings)

setConnectionSource

public B setConnectionSource(ConnectionSource connectionSource)

The connections source from which database connections should be retrieved.

Parameters:

connectionSource - The connections source.

Returns:

this

setImmediateFail

public void setImmediateFail(boolean immediateFail)

setReconnectIntervalMillis

public void setReconnectIntervalMillis(long reconnectIntervalMillis)

setTableName

public B setTableName(String tableName)

The name of the database table to insert log events into.

Parameters:

tableName - The database table name.

Returns:

this

setTruncateStrings

public B setTruncateStrings(boolean truncateStrings)