com.goldencode.p2j.persist.orm

Class SQLStatementLoggerConfiguration

java.lang.Object

com.goldencode.p2j.persist.orm.SQLStatementLoggerConfiguration

public final class SQLStatementLoggerConfiguration
extends java.lang.Object

Class responsible with storing the configuration for SQLStatementLogger.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLStatementLoggerConfiguration.LoggingType Enum denoting what should happen with a statement: should it just be executed or the intention is to log things about it?

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ALLOW_SENSITIVE Flag that marks whether potential sensitive data is allowed to be logged.
private static java.util.Map<java.lang.String,SQLStatementLoggerConfiguration>	configs Map that includes a configuration for each given database.
private SQLLoggingDatabaseHelper	dbHelper The helper object to facilitate logging to H2 database
private static CentralLoggerFile	fileLogger The file logger, responsible for writing logs to files.
private static java.lang.String	GLOBAL_DIR_PATH Global directory path, used if a local one does not exist.
private boolean	IGNORE_META_LOGGING Flag for ignoring the SQL queries that belong to the meta database.
private static CentralLogger	LOG Logger.
private static java.util.logging.Formatter	LOG_FORMATTER The log formatter.
private SQLStatementLoggerConfiguration.LoggingType	loggingType The type of logging intended.
private double	MIN_TIME_THRESHOLD Flag for a minimum time threshold.
private java.lang.String	OUTPUT_DB The file name for the h2 database that will receive the logging output .
private java.lang.String	OUTPUT_FILE The file that will receive the logging output.
private java.lang.String	PASS_DB The password for the h2 database that will receive the logging output .
private boolean	STACK_TRACING Is stack tracing of SQL queries intended? If LOGGING_ENABLED is false, then this flag won't matter.
private java.lang.String	USER_DB The user for the h2 database that will receive the logging output .

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SQLStatementLoggerConfiguration(java.lang.String databaseName) Constructor of a configuration.

Method Summary

Modifier and Type	Method and Description
static SQLStatementLoggerConfiguration	getConfiguration(java.lang.String databaseName) Get the logging configuration of a specific database.
SQLLoggingDatabaseHelper	getDbHelper() Getter for the dbHelper field.
CentralLoggerFile	getFileLogger() Getter for the fileLogger field.
SQLStatementLoggerConfiguration.LoggingType	getLoggingType() Getter for the loggingType field.
double	getMinTimeThreshold() Getter for the MIN_TIME_THRESHOLD field.
boolean	isAllowSensitive() Getter for the ALLOW_SENSITIVE field.
boolean	isIgnoreMetaLogging() Getter for the IGNORE_META_LOGGING field.
boolean	isStackTracingEnabled() Getter for the STACK_TRACING field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configs

private static final java.util.Map<java.lang.String,SQLStatementLoggerConfiguration> configs

Map that includes a configuration for each given database.

LOG

private static final CentralLogger LOG

Logger.

LOG_FORMATTER

private static final java.util.logging.Formatter LOG_FORMATTER

The log formatter.

GLOBAL_DIR_PATH

private static final java.lang.String GLOBAL_DIR_PATH

Global directory path, used if a local one does not exist.

See Also:

Constant Field Values

loggingType

private final SQLStatementLoggerConfiguration.LoggingType loggingType

The type of logging intended.

fileLogger

private static CentralLoggerFile fileLogger

The file logger, responsible for writing logs to files.

STACK_TRACING

private final boolean STACK_TRACING

Is stack tracing of SQL queries intended? If LOGGING_ENABLED is false, then this flag won't matter.

MIN_TIME_THRESHOLD

private final double MIN_TIME_THRESHOLD

Flag for a minimum time threshold. SQL queries that execute in less time than this threshold will not be logged. The default value is 0.0 milliseconds.

IGNORE_META_LOGGING

private final boolean IGNORE_META_LOGGING

Flag for ignoring the SQL queries that belong to the meta database.

ALLOW_SENSITIVE

private final boolean ALLOW_SENSITIVE

Flag that marks whether potential sensitive data is allowed to be logged.

OUTPUT_FILE

private final java.lang.String OUTPUT_FILE

The file that will receive the logging output.

OUTPUT_DB

private final java.lang.String OUTPUT_DB

The file name for the h2 database that will receive the logging output .

USER_DB

private final java.lang.String USER_DB

The user for the h2 database that will receive the logging output .

PASS_DB

private final java.lang.String PASS_DB

The password for the h2 database that will receive the logging output .

dbHelper

private volatile SQLLoggingDatabaseHelper dbHelper

The helper object to facilitate logging to H2 database

Constructor Detail

SQLStatementLoggerConfiguration

private SQLStatementLoggerConfiguration(java.lang.String databaseName)

Constructor of a configuration. First, it checks if logging is enabled. If this condition is met, it then proceeds with computing the other details (such as profiling, stack tracing, etc.). Lastly, it creates the corresponding FileHandler.

Parameters:

databaseName - The name of the database in use.

Method Detail

getConfiguration

public static SQLStatementLoggerConfiguration getConfiguration(java.lang.String databaseName)

Get the logging configuration of a specific database.

Parameters:

databaseName - The name of the database in use.

Returns:

SQLStatementLoggerConfiguration If it exists, an already created configuration for that database, or a new one otherwise.

getLoggingType

public SQLStatementLoggerConfiguration.LoggingType getLoggingType()

Getter for the loggingType field.

Returns:

LoggingType The type of logger.

isStackTracingEnabled

public boolean isStackTracingEnabled()

Getter for the STACK_TRACING field.

Returns:

boolean The value of STACK_TRACING.

isIgnoreMetaLogging

public boolean isIgnoreMetaLogging()

Getter for the IGNORE_META_LOGGING field.

Returns:

boolean The value of IGNORE_META_LOGGING.

isAllowSensitive

public boolean isAllowSensitive()

Getter for the ALLOW_SENSITIVE field.

Returns:

boolean The value of ALLOW_SENSITIVE.

getMinTimeThreshold

public double getMinTimeThreshold()

Getter for the MIN_TIME_THRESHOLD field.

Returns:

double The value of MIN_TIME_THRESHOLD.

getDbHelper

public SQLLoggingDatabaseHelper getDbHelper()

Getter for the dbHelper field.

Returns:

SQLLoggingDatabaseHelper The value of dbHelper.

getFileLogger

public CentralLoggerFile getFileLogger()

Getter for the fileLogger field.

Returns:

CentralLoggerFile The value of fileLogger.