Apache log4cxx  Version 0.12.0
log4cxx::db::ODBCAppender Class Reference

#include <odbcappender.h>

Inheritance diagram for log4cxx::db::ODBCAppender:
log4cxx::AppenderSkeleton log4cxx::Appender log4cxx::helpers::Object log4cxx::spi::OptionHandler log4cxx::helpers::Object

Public Member Functions

 ODBCAppender ()
 
virtual ~ODBCAppender ()
 
virtual void setOption (const LogString &option, const LogString &value)
 Set options. More...
 
virtual void activateOptions (log4cxx::helpers::Pool &p)
 Activate the specified options. More...
 
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. More...
 
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. More...
 
void setSql (const LogString &s)
 Set pre-formated statement eg: insert into LogTable (msg) values ("%m") More...
 
const LogStringgetSql () const
 Returns pre-formated statement eg: insert into LogTable (msg) values ("%m") More...
 
void setUser (const LogString &user)
 
void setURL (const LogString &url)
 
void setPassword (const LogString &password)
 
void setBufferSize (size_t newBufferSize)
 
const LogStringgetUser () const
 
const LogStringgetURL () const
 
const LogStringgetPassword () const
 
size_t getBufferSize () const
 
- Public Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton ()
 
 AppenderSkeleton (const LayoutPtr &layout)
 
void finalize ()
 Finalize this appender by calling the derived class' close method. More...
 
void addFilter (const spi::FilterPtr &newFilter)
 Add a filter to end of the filter list. More...
 
void clearFilters ()
 Clear the filters chain. More...
 
const spi::ErrorHandlerPtrgetErrorHandler () const
 Return the currently set spi::ErrorHandler for this Appender. More...
 
spi::FilterPtr getFilter () const
 Returns the head Filter. More...
 
const spi::FilterPtrgetFirstFilter () 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. More...
 
const LevelPtrgetThreshold () 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. More...
 
void setErrorHandler (const spi::ErrorHandlerPtr eh)
 Set the ErrorHandler for this Appender. More...
 
void setLayout (const LayoutPtr &layout1)
 Set the layout for this appender. More...
 
void setName (const LogString &name1)
 Set the name of this Appender. More...
 
void setThreshold (const LevelPtr &threshold)
 Set the threshold level. More...
 
- Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
 
void asdf ()
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

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. More...
 
LogString databaseUser
 User to connect as for default connection handling. More...
 
LogString databasePassword
 User to use for default connection handling. More...
 
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::LoggingEventPtrbuffer
 ArrayList holding the buffer of Logging Events. More...
 
- 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. More...
 
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? More...
 
log4cxx::helpers::Pool pool
 
log4cxx::shared_mutex mutex
 

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 Typedef Documentation

◆ SQLHANDLE

typedef void* log4cxx::db::ODBCAppender::SQLHANDLE
protected

◆ SQLHDBC

typedef void* log4cxx::db::ODBCAppender::SQLHDBC
protected

◆ SQLHENV

typedef void* log4cxx::db::ODBCAppender::SQLHENV
protected

◆ SQLSMALLINT

typedef short log4cxx::db::ODBCAppender::SQLSMALLINT
protected

Constructor & Destructor Documentation

◆ ODBCAppender()

log4cxx::db::ODBCAppender::ODBCAppender ( )

◆ ~ODBCAppender()

virtual log4cxx::db::ODBCAppender::~ODBCAppender ( )
virtual

Member Function Documentation

◆ activateOptions()

virtual void log4cxx::db::ODBCAppender::activateOptions ( log4cxx::helpers::Pool p)
virtual

Activate the specified options.

Reimplemented from log4cxx::AppenderSkeleton.

◆ 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.

◆ close()

virtual void log4cxx::db::ODBCAppender::close ( )
virtual

Closes the appender, flushing the buffer first then closing the default connection if it is open.

Implements log4cxx::Appender.

◆ 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!

◆ getBufferSize()

size_t log4cxx::db::ODBCAppender::getBufferSize ( ) const
inline

◆ 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.

◆ getPassword()

const LogString& log4cxx::db::ODBCAppender::getPassword ( ) const
inline

◆ getSql()

const LogString& log4cxx::db::ODBCAppender::getSql ( ) const
inline

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

◆ getURL()

const LogString& log4cxx::db::ODBCAppender::getURL ( ) const
inline

◆ getUser()

const LogString& log4cxx::db::ODBCAppender::getUser ( ) const
inline

◆ requiresLayout()

virtual bool log4cxx::db::ODBCAppender::requiresLayout ( ) const
inlinevirtual

ODBCAppender requires a layout.

Implements log4cxx::Appender.

◆ setBufferSize()

void log4cxx::db::ODBCAppender::setBufferSize ( size_t  newBufferSize)
inline

◆ setOption()

virtual void log4cxx::db::ODBCAppender::setOption ( const LogString option,
const LogString value 
)
virtual

Set options.

Reimplemented from log4cxx::AppenderSkeleton.

◆ setPassword()

void log4cxx::db::ODBCAppender::setPassword ( const LogString password)
inline

◆ setSql()

void log4cxx::db::ODBCAppender::setSql ( const LogString s)

Set pre-formated statement eg: insert into LogTable (msg) values ("%m")

◆ setURL()

void log4cxx::db::ODBCAppender::setURL ( const LogString url)
inline

◆ setUser()

void log4cxx::db::ODBCAppender::setUser ( const LogString user)
inline

Member Data Documentation

◆ buffer

std::list<spi::LoggingEventPtr> log4cxx::db::ODBCAppender::buffer
protected

ArrayList holding the buffer of Logging Events.

◆ 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.

◆ databasePassword

LogString log4cxx::db::ODBCAppender::databasePassword
protected

User to use for default connection handling.

◆ databaseURL

LogString log4cxx::db::ODBCAppender::databaseURL
protected

URL of the DB for default connection handling.

◆ databaseUser

LogString log4cxx::db::ODBCAppender::databaseUser
protected

User to connect as for default connection handling.

◆ env

SQLHENV log4cxx::db::ODBCAppender::env
protected

◆ 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: