org.safs.logging.slf4j

Class SAFSLoggerFactory

java.lang.Object

org.safs.logging.slf4j.SAFSLoggerFactory

All Implemented Interfaces:

org.slf4j.ILoggerFactory

public class SAFSLoggerFactory
extends java.lang.Object
implements org.slf4j.ILoggerFactory

SLF4J Logger Factory capable of returning Adapters for the SAFSLOG and the SAFS Debug Log.

The Factory supports 3 kinds of Loggers that can be retrieved by Name:

1. "TEST" -- Logger writes only to the active SAFS Test Log.
2. "DEBUG" -- Logger writes only to the active SAFS Debug Log--if running.
3. <other> -- Anything else gets a single Logger that writes to both:
   • info, warn, error messages to SAFS Test Log.
   • debug, trace to SAFS Debug Log--if running.

At this time, SAFS Loggers that write to the SAFS Test Log *MUST* be further initialized AFTER they are returned by the SAFSLogFactory. Since these Adapters are primarily intended for integrating non-SAFS tools using SLF4J logging into the SAFS framework or test, this is usually not an issue.

The typical mechanism for using the SAFS Logger Adapters would be:

Logger logger = LoggerFactory.getLogger(MySAFSAwareClass.class); SAFSLoggerFactory.initializeTestLoggerAdapter(logger, driver);

Author:

Carl Nagle

See Also:

initializeTestLoggerAdapter(Logger, AbstractDriver)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	accpetDebugLog If the message from slf4j will go into safs debug log.
static boolean	accpetTestLog If the message from slf4j will go into safs test log.
static java.lang.String	DEBUG_LOGNAME "DEBUG" Name of the Adapter to facilitate SAFS Debug Logging.
protected DebugLoggerAdapter	debuglog
protected CombinedLoggerAdapter	duallog
protected TestLoggerAdapter	safslog
static java.lang.String	TEST_LOGNAME "TEST" Name of the Adapter to facilitate SAFS Test Logging.
protected VoidLoggerAdapter	voidlog

Constructor Summary

Constructors

Constructor and Description
SAFSLoggerFactory()

Method Summary

Modifier and Type	Method and Description
org.slf4j.Logger	getLogger(java.lang.String logname) Specify which Logger Adapter is desired. DEBUG_LOGNAME returns the SAFS Debug Log Adapter. TEST_LOGNAME returns the SAFS Test Log Adapter. An unrecognized or unknown logname/classname will return the SAFS Combined Logger Adapter.
static void	initializeTestLoggerAdapter(org.slf4j.Logger logger, AbstractDriver driver) At this time, SAFS Loggers that write to the SAFS Test Log *MUST* be further initialized AFTER they are returned by the SAFSLogFactory.

Methods inherited from class java.lang.Object

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

Field Detail

accpetDebugLog

public static boolean accpetDebugLog

If the message from slf4j will go into safs debug log.

accpetTestLog

public static boolean accpetTestLog

If the message from slf4j will go into safs test log.

DEBUG_LOGNAME

public static final java.lang.String DEBUG_LOGNAME

"DEBUG" Name of the Adapter to facilitate SAFS Debug Logging.

See Also:

Constant Field Values

TEST_LOGNAME

public static final java.lang.String TEST_LOGNAME

"TEST" Name of the Adapter to facilitate SAFS Test Logging.

See Also:

Constant Field Values

safslog

protected final TestLoggerAdapter safslog

debuglog

protected final DebugLoggerAdapter debuglog

duallog

protected final CombinedLoggerAdapter duallog

voidlog

protected final VoidLoggerAdapter voidlog

Constructor Detail

SAFSLoggerFactory

public SAFSLoggerFactory()

Method Detail

getLogger

public org.slf4j.Logger getLogger(java.lang.String logname)

Specify which Logger Adapter is desired.
DEBUG_LOGNAME returns the SAFS Debug Log Adapter.
TEST_LOGNAME returns the SAFS Test Log Adapter.
An unrecognized or unknown logname/classname will return the SAFS Combined Logger Adapter.

Specified by:

getLogger in interface org.slf4j.ILoggerFactory

See Also:

ILoggerFactory.getLogger(java.lang.String), DebugLoggerAdapter, TestLoggerAdapter, CombinedLoggerAdapter

initializeTestLoggerAdapter

public static void initializeTestLoggerAdapter(org.slf4j.Logger logger,
                                               AbstractDriver driver)

At this time, SAFS Loggers that write to the SAFS Test Log *MUST* be further initialized AFTER they are returned by the SAFSLogFactory. Since these Adapters are primarily intended for integrating non-SAFS tools using SLF4J logging into the SAFS framework or test, this is usually not an issue.

The typical mechanism for using the SAFS Logger Adapters would be:

Logger logger = LoggerFactory.getLogger(MySAFSAwareClass.class); SAFSLoggerFactory.initializeTestLoggerAdapter(logger, driver);

Parameters:

logger -

driver - --AbstractDrivers like JSAFSDriver, SAFSDRIVER, and STAFProcessContainer providing access to a SAFS CoreInterface (STAFHelper subclass).