Top Description Fields Constructors Methods
org.apache.log.output.db

public abstract Class AbstractJDBCTarget

extends AbstractTarget
Class Inheritance
Known Direct Subclasses
org.apache.log.output.db.DefaultJDBCTarget
Imports
java.sql.Connection, .SQLException, javax.sql.DataSource, org.apache.log.LogEvent, org.apache.log.output.AbstractTarget
Abstract JDBC target.
Authors
Avalon Development Team, Peter Donald

Field Summary

Modifier and TypeField and Description
private Connection
m_connection

private DataSource
m_dataSource

Constructor Summary

AccessConstructor and Description
protected
AbstractJDBCTarget(final DataSource
the JDBC datasource
dataSource)

Creation of a new instance of the AbstractJDBCTarget.

Method Summary

Modifier and TypeMethod and Description
protected final synchronized void
checkConnection()

Utility method to check connection and bring it back up if necessary.

public synchronized void
close()

Overrides org.apache.log.output.AbstractTarget.close.

Implements org.apache.log.util.Closeable.close.

Shutdown target.
protected synchronized void
closeConnection()

Close connection to underlying database.

protected synchronized void
doProcessEvent(final LogEvent
the log event
event)

Implements abstract org.apache.log.output.AbstractTarget.doProcessEvent.

Process a log event, via formatting and outputting it.
protected final synchronized Connection

Returns:

the Connection
getConnection()

Utility method for subclasses to access connection.

protected synchronized boolean

Returns:

true if connection is stale, false otherwise
isStale()

Detect if connection is stale and should be reopened.

protected synchronized void
open()

Overrides org.apache.log.output.AbstractTarget.open.

Startup log session.
protected synchronized void
openConnection()

Open connection to underlying database.

protected abstract void
output(LogEvent
the log event.
event)

Output a log event to DB.

Inherited from org.apache.log.output.AbstractTarget:
getErrorHandlerisOpenprocessEventsetErrorHandler

Field Detail

m_connectionback to summary
private Connection m_connection
m_dataSourceback to summary
private DataSource m_dataSource

Constructor Detail

AbstractJDBCTargetback to summary
protected AbstractJDBCTarget(final DataSource dataSource)

Creation of a new instance of the AbstractJDBCTarget.

Parameters
dataSource:DataSource

the JDBC datasource

Method Detail

checkConnectionback to summary
protected final synchronized void checkConnection()

Utility method to check connection and bring it back up if necessary.

closeback to summary
public synchronized void close()

Overrides org.apache.log.output.AbstractTarget.close.

Implements org.apache.log.util.Closeable.close.

Shutdown target. Attempting to write to target after close() will cause errors to be logged.

closeConnectionback to summary
protected synchronized void closeConnection()

Close connection to underlying database.

doProcessEventback to summary
protected synchronized void doProcessEvent(final LogEvent event) throws Exception

Implements abstract org.apache.log.output.AbstractTarget.doProcessEvent.

Process a log event, via formatting and outputting it.

Parameters
event:LogEvent

the log event

Exceptions
Exception:
if an event processing error occurs
getConnectionback to summary
protected final synchronized Connection getConnection()

Utility method for subclasses to access connection.

Returns:Connection

the Connection

isStaleback to summary
protected synchronized boolean isStale()

Detect if connection is stale and should be reopened.

Returns:boolean

true if connection is stale, false otherwise

openback to summary
protected synchronized void open()

Overrides org.apache.log.output.AbstractTarget.open.

Startup log session.

openConnectionback to summary
protected synchronized void openConnection()

Open connection to underlying database.

outputback to summary
protected abstract void output(LogEvent event)

Output a log event to DB. This must be implemented by subclasses.

Parameters
event:LogEvent

the log event.