package log4plsql.backgroundProcess;

import org.apache.log4j.Logger;

/**
 * <p>Title:        DbLogHelper</p>
 * <p>Description:  Project specific extension point for Log4Plsql logging management.</p>
 * Places to override: <br>
 * <ul>
 * <li><code>getLogger()</code> - to override the default logger name for a given message.  All message values are available at
 * the point of this call via the get*() methods, and MDC values have been set.</li>
 * <li><code>close()</code> - to perform any log clean-up needed.  This method may not be called, if the thread is stopped by
 * killing the Java process running it.  close() is only called when logging stops due to an error or calling setStillWatching(false).</li>
 * <li><code>preLog()</code> - perform any message-prep needed before each new message is logged.</li>
 * <li><code>postLog()</code> - perform any message cleanup needed after each logging call.</li>
 * </ul><p>
 * <p>Copyright:    Copyright (c) 2004 Sabrix, Inc.  This material is confidential and may not be reproduced by any means.</p>
 * <p>Company:      Sabrix, Inc.</p>
 * <p>Header:       $Header: $</p>
 * @author gregw
 * @version $Version:$
 */
public class DbLogHelper {

	DbLogListener dbLogListener_;
	
	public DbLogHelper(DbLogListener logListener) {
		setDbLogListener(logListener);
	}
	
	
	private DbLogListener getDbLogListener() {
		return this.dbLogListener_;
	}
	
	private void setDbLogListener(DbLogListener dbLogListener) {
		this.dbLogListener_ = dbLogListener;
	}
	
	/**
	 * Perform any desired pre-logging actions here - set up NDC/MDC further, etc.
	 * Default MDC has been set at this point.
	 * Does nothing in the default implementation.
	 */
	public void preLog() {}
	/**
	 * Perform any post-logging cleanup here.
	 * Default MDC is still set at this point, and removed immediately after this call in preparation for the next one.
	 * Does nothing in the default implementation.
	 */
	public void postLog() {}
	
	/**
	 * Defaults to the one matching the section name. 
	 * <p>
	 * Override this in child classes to customize which logger to use.  It is called after MDC has been set
	 * for the current message.  All Oracle pipe message pieces are available by their getter methods for use in this method. 
	 * <p>
	 * @return the logger to use for this message.
	 */
	public Logger getLogger() {
		return Logger.getLogger(getDbLogListener().getRootLoggerName() + getDbLogListener().getSection());
	}
	
	/**
	 * Do any steps needed when we know we are done reading from this pipe. This could include closing 
	 * Appenders, removing MDC or NDC data, closing Loggers, etc.
	 * Does nothing in the default implementation.
	 */
	public void close() {}
}