#include <odbcappender.h>

Inheritance diagram for log4cxx::db::ODBCAppender:

Public Member Functions
virtual void	setOption (const LogString &option, const LogString &value)
	Set options.

virtual void	activateOptions (log4cxx::helpers::Pool &p)
	Activate the specified options.

void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &)
	Adds the event to the buffer. More...

virtual void	close ()
	Closes the appender, flushing the buffer first then closing the default connection if it is open.

virtual void	flushBuffer (log4cxx::helpers::Pool &p)
	loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute(). More...

virtual bool	requiresLayout () const
	ODBCAppender requires a layout.

void	setSql (const LogString &s)
	Set pre-formated statement eg: insert into LogTable (msg) values ("%m")

const LogString &	getSql () const
	Returns pre-formated statement eg: insert into LogTable (msg) values ("%m")

void	setUser (const LogString &user)

void	setURL (const LogString &url)

void	setPassword (const LogString &password)

void	setBufferSize (size_t newBufferSize)

const LogString &	getUser () const

const LogString &	getURL () const

const LogString &	getPassword () const

size_t	getBufferSize () const

Public Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton (const LayoutPtr &layout)

void	addRef () const

void	releaseRef () const

void	finalize ()
	Finalize this appender by calling the derived class' `close` method.

void	addFilter (const spi::FilterPtr &newFilter)
	Add a filter to end of the filter list.

void	clearFilters ()
	Clear the filters chain.

const spi::ErrorHandlerPtr &	getErrorHandler () const
	Return the currently set spi::ErrorHandler for this Appender.

spi::FilterPtr	getFilter () const
	Returns the head Filter.

const spi::FilterPtr &	getFirstFilter () const
	Return the first filter in the filter chain for this Appender. More...

LayoutPtr	getLayout () const
	Returns the layout of this appender. More...

LogString	getName () const
	Returns the name of this Appender.

const LevelPtr &	getThreshold () const
	Returns this appenders threshold level. More...

bool	isAsSevereAsThreshold (const LevelPtr &level) const
	Check whether the message level is below the appender's threshold. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)
	This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.

void	setErrorHandler (const spi::ErrorHandlerPtr &eh)
	Set the ErrorHandler for this Appender.

void	setLayout (const LayoutPtr &layout1)
	Set the layout for this appender. More...

void	setName (const LogString &name1)
	Set the name of this Appender.

void	setThreshold (const LevelPtr &threshold)
	Set the threshold level. More...

Public Member Functions inherited from log4cxx::helpers::Object
virtual bool	instanceof (const Class &clazz) const =0

virtual const void *	cast (const Class &clazz) const =0

Public Member Functions inherited from log4cxx::helpers::ObjectImpl
void	addRef () const

void	releaseRef () const

Protected Types
typedef void *	SQLHDBC

typedef void *	SQLHENV

typedef void *	SQLHANDLE

typedef short	SQLSMALLINT

Protected Member Functions
LogString	getLogStatement (const spi::LoggingEventPtr &event, helpers::Pool &p) const
	By default getLogStatement sends the event to the required Layout object. More...

virtual void	execute (const LogString &sql, log4cxx::helpers::Pool &p)
	Override this to provide an alertnate method of getting connections (such as caching). More...

virtual void	closeConnection (SQLHDBC con)
	Override this to return the connection to a pool, or to clean up the resource. More...

virtual SQLHDBC	getConnection (log4cxx::helpers::Pool &p)
	Override this to link with your connection pooling system. More...

Protected Member Functions inherited from log4cxx::AppenderSkeleton
void	doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)

Protected Attributes
LogString	databaseURL
	URL of the DB for default connection handling.

LogString	databaseUser
	User to connect as for default connection handling.

LogString	databasePassword
	User to use for default connection handling.

SQLHDBC	connection
	Connection used by default. More...

SQLHENV	env

LogString	sqlStatement
	Stores the string given to the pattern layout for conversion into a SQL statement, eg: insert into LogTable (Thread, File, Message) values ("%t", "%F", "%m") More...

size_t	bufferSize
	size of LoggingEvent buffer before writing to the database. More...

std::list< spi::LoggingEventPtr >	buffer
	ArrayList holding the buffer of Logging Events.

Protected Attributes inherited from log4cxx::AppenderSkeleton
LayoutPtr	layout
	The layout variable does not need to be set if the appender implementation has its own layout. More...

LogString	name
	Appenders are named. More...

LevelPtr	threshold
	There is no level threshold filtering by default. More...

spi::ErrorHandlerPtr	errorHandler
	It is assumed and enforced that errorHandler is never null.

spi::FilterPtr	headFilter
	The first filter in the filter chain. More...

spi::FilterPtr	tailFilter
	The last filter in the filter chain. More...

bool	closed
	Is this appender closed?

log4cxx::helpers::Pool	pool

SHARED_MUTEX	mutex

Protected Attributes inherited from log4cxx::helpers::ObjectImpl
unsigned int volatile	ref

Detailed Description

WARNING: This version of ODBCAppender is very likely to be completely replaced in the future. Moreoever, it does not log exceptions.

The ODBCAppender provides for sending log events to a database.

Each append call adds to an ArrayList buffer. When the buffer is filled each log event is placed in a sql statement (configurable) and executed.

BufferSize, db URL, User, & Password are configurable options in the standard log4j ways.

The setSql(String sql) sets the SQL statement to be used for logging – this statement is sent to a PatternLayout (either created automaticly by the appender or added by the user). Therefore by default all the conversion patterns in PatternLayout can be used inside of the statement. (see the test cases for examples)

Overriding the getLogStatement method allows more explicit control of the statement used for logging.

For use as a base class:

Override getConnection() to pass any connection you want. Typically this is used to enable application wide connection pooling.
Override closeConnection – if you override getConnection make sure to implement closeConnection to handle the connection you generated. Typically this would return the connection to the pool it came from.
Override getLogStatement to produce specialized or dynamic statements. The default uses the sql option value.

Member Function Documentation

◆ append()

void log4cxx::db::ODBCAppender::append	(	const spi::LoggingEventPtr &	event,
		log4cxx::helpers::Pool &
	)

virtual

Adds the event to the buffer.

When full the buffer is flushed.

Implements log4cxx::AppenderSkeleton.

◆ closeConnection()

virtual void log4cxx::db::ODBCAppender::closeConnection ( SQLHDBC con )

protectedvirtual

Override this to return the connection to a pool, or to clean up the resource.

The default behavior holds a single connection open until the appender is closed (typically when garbage collected).

◆ execute()

virtual void log4cxx::db::ODBCAppender::execute	(	const LogString &	sql,
		log4cxx::helpers::Pool &	p
	)

protectedvirtual

Override this to provide an alertnate method of getting connections (such as caching).

One method to fix this is to open connections at the start of flushBuffer() and close them at the end. I use a connection pool outside of ODBCAppender which is accessed in an override of this method.

◆ flushBuffer()

virtual void log4cxx::db::ODBCAppender::flushBuffer ( log4cxx::helpers::Pool & p )

virtual

loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute().

Errors are sent to the errorHandler.

If a statement fails the LoggingEvent stays in the buffer!

◆ getConnection()

virtual SQLHDBC log4cxx::db::ODBCAppender::getConnection ( log4cxx::helpers::Pool & p )

protectedvirtual

Override this to link with your connection pooling system.

By default this creates a single connection which is held open until the object is garbage collected.

◆ getLogStatement()

LogString log4cxx::db::ODBCAppender::getLogStatement	(	const spi::LoggingEventPtr &	event,
		helpers::Pool &	p
	)		const

protected

By default getLogStatement sends the event to the required Layout object.

The layout will format the given pattern into a workable SQL string.

Overriding this provides direct access to the LoggingEvent when constructing the logging statement.

Member Data Documentation

◆ bufferSize

size_t log4cxx::db::ODBCAppender::bufferSize

protected

size of LoggingEvent buffer before writing to the database.

Default is 1.

◆ connection

SQLHDBC log4cxx::db::ODBCAppender::connection

protected

Connection used by default.

The connection is opened the first time it is needed and then held open until the appender is closed (usually at garbage collection). This behavior is best modified by creating a sub-class and overriding the getConnection and closeConnection methods.

◆ sqlStatement

LogString log4cxx::db::ODBCAppender::sqlStatement

protected

Stores the string given to the pattern layout for conversion into a SQL statement, eg: insert into LogTable (Thread, File, Message) values ("%t", "%F", "%m")

Be careful of quotes in your messages!

Also see PatternLayout.

The documentation for this class was generated from the following file:

odbcappender.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ append()

◆ closeConnection()

◆ execute()

◆ flushBuffer()

◆ getConnection()

◆ getLogStatement()

Member Data Documentation

◆ bufferSize

◆ connection

◆ sqlStatement