public abstract class AbstractDatabaseManager extends AbstractManager
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractDatabaseManager.AbstractFactoryData
Implementations should extend this class for passing data between the getManager method and the manager factory
class.
|
count, LOGGER
Modifier | Constructor and Description |
---|---|
protected |
AbstractDatabaseManager(String name,
int bufferSize)
Instantiates the base manager.
|
Modifier and Type | Method and Description |
---|---|
void |
connect()
This method is called within the appender when the appender is started.
|
protected abstract void |
connectInternal()
Implementations should implement this method to perform any proprietary connection operations.
|
void |
disconnect()
This method is called from the
AbstractManager.release() method when the appender is stopped or the appender's manager
is replaced. |
protected abstract void |
disconnectInternal()
Implementations should implement this method to perform any proprietary disconnection / shutdown operations.
|
void |
flush()
This method is called automatically when the buffer size reaches its maximum or at the beginning of a call to
disconnect() . |
protected static <M extends AbstractDatabaseManager,T extends AbstractDatabaseManager.AbstractFactoryData> |
getManager(String name,
T data,
ManagerFactory<M,T> factory)
Implementations should define their own getManager method and call this method from that to create or get
existing managers.
|
boolean |
isConnected()
Indicates whether the manager is currently connected
connect() has been called and disconnect()
has not been called). |
void |
releaseSub()
May be overridden by Managers to perform processing while the Manager is being released and the
lock is held.
|
String |
toString() |
void |
write(LogEvent event)
This method manages buffering and writing of events.
|
protected abstract void |
writeInternal(LogEvent event)
Performs the actual writing of the event in an implementation-specific way.
|
getContentFormat, getCount, getName, hasManager, release
protected AbstractDatabaseManager(String name, int bufferSize)
name
- The manager name, which should include any configuration details that one might want to be able to
reconfigure at runtime, such as database name, username, (hashed) password, etc.bufferSize
- The size of the log event buffer.protected abstract void connectInternal() throws Exception
Exception
public final void connect()
connectInternal()
and catches any exceptions it might throw.protected abstract void disconnectInternal() throws Exception
connectInternal()
. It is safe to throw any exceptions from this method.Exception
public final void disconnect()
AbstractManager.release()
method when the appender is stopped or the appender's manager
is replaced. If it has not already been called, it calls disconnectInternal()
and catches any exceptions
it might throw.public final boolean isConnected()
connect()
has been called and disconnect()
has not been called).true
if the manager is connected.protected abstract void writeInternal(LogEvent event)
write(LogEvent)
if buffering is off, or from flush()
if the buffer has reached its limit.event
- The event to write to the database.public final void flush()
disconnect()
. It can also be called manually to flush events to the database.public final void write(LogEvent event)
event
- The event to write to the database.public final void releaseSub()
AbstractManager
releaseSub
in class AbstractManager
protected static <M extends AbstractDatabaseManager,T extends AbstractDatabaseManager.AbstractFactoryData> M getManager(String name, T data, ManagerFactory<M,T> factory)
M
- The concrete manager type.T
- The concrete AbstractDatabaseManager.AbstractFactoryData
type.name
- The manager name, which should include any configuration details that one might want to be able to
reconfigure at runtime, such as database name, username, (hashed) password, etc.data
- The concrete instance of AbstractDatabaseManager.AbstractFactoryData
appropriate for the given manager.factory
- A factory instance for creating the appropriate manager.Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.