com.technia.tvc.core

Class TVCLogManager

java.lang.Object

com.technia.tvc.core.TVCLogManager

public class TVCLogManager
extends java.lang.Object

Central class where all logger management takes place.

Since:

5.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TVCLogManager.LoggerInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
TVCLogManager()

Method Summary

Modifier and Type	Method and Description
static void	addConsoleAppender(java.lang.String loggerName, java.lang.String layoutPattern) Add an appender to a logger.
static void	addConsoleAppender(java.lang.String loggerName, java.lang.String layoutPattern, com.technia.tvc.log4j.Level threshold) Add an appender to a logger.
static void	addRollingFileAppender(java.lang.String loggerName, java.lang.String layoutPattern, java.lang.String filename) Add an appender to a logger.
static void	addRollingFileAppender(java.lang.String loggerName, java.lang.String layoutPattern, java.lang.String filename, long maxFileSize, int maxBackupFiles) Add an appender to a logger.
static void	addRollingFileAppender(java.lang.String loggerName, java.lang.String layoutPattern, java.lang.String filename, long maxFileSize, int maxBackupFiles, com.technia.tvc.log4j.Level threshold) Add an appender to a logger.
static void	addSMTPAppender(java.lang.String loggerName, java.lang.String layoutPattern, java.lang.String smtpHost, java.lang.String fromEmailAddress, java.lang.String toEmailAddress, java.lang.String subject, com.technia.tvc.log4j.spi.TriggeringEventEvaluator evaluator) Add an appender to a logger.
static com.technia.tvc.log4j.Logger	createFileLogger(java.lang.String loggerName, java.lang.String fileName, com.technia.tvc.log4j.Level level, java.lang.String layoutPattern, long maxFileSize, int maxBackupSize, boolean keepExistingAppenders)
static void	debug() Turn on debug level for entire TVC.
static com.technia.tvc.log4j.Level	getLevel(java.lang.String logger)
static java.io.File	getLogDir()
static java.util.Collection<TVCLogManager.LoggerInfo>	getLoggerInfos()
static com.technia.tvc.log4j.spi.Filter	getNoLoggingFilter()
static com.technia.tvc.log4j.Level	getRootLevel()
static com.technia.tvc.log4j.Logger	getTVCRootLogger()
static void	init(java.util.Properties props) Init Log4J sub-system based on configuration through init parameters.
static boolean	isSuspended()
static void	list() List logger information to stdout.
static void	resume() Resumes logging for the current thread.
static void	setLevel(java.lang.String logger, com.technia.tvc.log4j.Level level)
static void	setLevel(java.lang.String logger, com.technia.tvc.log4j.Level level, boolean deep)
static void	setRootLevel(com.technia.tvc.log4j.Level level) Sets the level of the root logger.
static void	setup() Basic setup of the log4j sub-system.
static void	suspend() Suspends all logging for the current thread until resume() is called.
static void	turnOff() Will turn off ALL logging!!!

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

Constructor Detail

TVCLogManager

public TVCLogManager()

Method Detail

setup

public static void setup()

Basic setup of the log4j sub-system.

init

public static void init(java.util.Properties props)

Init Log4J sub-system based on configuration through init parameters.

getLogDir

public static java.io.File getLogDir()

setRootLevel

public static void setRootLevel(com.technia.tvc.log4j.Level level)

Sets the level of the root logger.

Parameters:

level - The new level.

Since:

6.1.6

setLevel

public static void setLevel(java.lang.String logger,
                            com.technia.tvc.log4j.Level level)

Parameters:

logger - The name of a logger.

level - The new logger level.

setLevel

public static void setLevel(java.lang.String logger,
                            com.technia.tvc.log4j.Level level,
                            boolean deep)

Parameters:

logger - The name of a logger.

level - The new logger level.

deep - Whether to set the level of all loggers whose name starts with the specified name.

Since:

6.1.6

getRootLevel

public static com.technia.tvc.log4j.Level getRootLevel()

Returns:

Returns the level of the root logger.

Since:

6.1.6

getLevel

public static com.technia.tvc.log4j.Level getLevel(java.lang.String logger)

Parameters:

logger - The name of the logger.

Returns:

Returns the level of the logger.

Since:

6.1.6

debug

public static void debug()

Turn on debug level for entire TVC.

Since:

5.2.2

turnOff

public static void turnOff()

Will turn off ALL logging!!!

list

public static void list()

List logger information to stdout.

getLoggerInfos

public static java.util.Collection<TVCLogManager.LoggerInfo> getLoggerInfos()

Returns:

Returns information about the current loggers.

Since:

5.2.2

addConsoleAppender

public static void addConsoleAppender(java.lang.String loggerName,
                                      java.lang.String layoutPattern)

Add an appender to a logger. The appender will print log messages to the console.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

Since:

6.0.0

addConsoleAppender

public static void addConsoleAppender(java.lang.String loggerName,
                                      java.lang.String layoutPattern,
                                      com.technia.tvc.log4j.Level threshold)

Add an appender to a logger. The appender will print log messages to the console.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

threshold - The threshold. Log messages with a lower level than this will not be printed.

Since:

6.0.0

addRollingFileAppender

public static void addRollingFileAppender(java.lang.String loggerName,
                                          java.lang.String layoutPattern,
                                          java.lang.String filename)
                                   throws java.io.IOException

Add an appender to a logger. The appender will print log messages to a file.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

filename - The filename.

Throws:

java.io.IOException

Since:

6.0.0

addRollingFileAppender

public static void addRollingFileAppender(java.lang.String loggerName,
                                          java.lang.String layoutPattern,
                                          java.lang.String filename,
                                          long maxFileSize,
                                          int maxBackupFiles)
                                   throws java.io.IOException

Add an appender to a logger. The appender will print log messages to a file.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

filename - The filename.

maxFileSize - The maximum file size.

maxBackupFiles - The maximum number of backup files.

Throws:

java.io.IOException

Since:

6.0.0

addRollingFileAppender

public static void addRollingFileAppender(java.lang.String loggerName,
                                          java.lang.String layoutPattern,
                                          java.lang.String filename,
                                          long maxFileSize,
                                          int maxBackupFiles,
                                          com.technia.tvc.log4j.Level threshold)
                                   throws java.io.IOException

Add an appender to a logger. The appender will print log messages to a file.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

filename - The filename.

maxFileSize - The maximum file size.

maxBackupFiles - The maximum number of backup files.

threshold - The threshold. Log messages with a lower level than this will not be printed.

Throws:

java.io.IOException

Since:

6.0.0

addSMTPAppender

public static void addSMTPAppender(java.lang.String loggerName,
                                   java.lang.String layoutPattern,
                                   java.lang.String smtpHost,
                                   java.lang.String fromEmailAddress,
                                   java.lang.String toEmailAddress,
                                   java.lang.String subject,
                                   com.technia.tvc.log4j.spi.TriggeringEventEvaluator evaluator)
                            throws java.io.IOException

Add an appender to a logger. The appender will send log messages as emails.

Parameters:

loggerName - The name of the logger.

layoutPattern - The layout pattern that will be used by the appender.

smtpHost - The host to send the email to.

fromEmailAddress - The from email address.

toEmailAddress - The to email address.

subject - The subject of the message.

evaluator - Will evaluate log events and return whether they should be sent as emails.

Throws:

java.io.IOException

Since:

6.0.0

createFileLogger

public static com.technia.tvc.log4j.Logger createFileLogger(java.lang.String loggerName,
                                                            java.lang.String fileName,
                                                            com.technia.tvc.log4j.Level level,
                                                            java.lang.String layoutPattern,
                                                            long maxFileSize,
                                                            int maxBackupSize,
                                                            boolean keepExistingAppenders)

Parameters:

loggerName -

fileName -

level -

layoutPattern -

maxFileSize -

maxBackupSize -

keepExistingAppenders -

Returns:

The logger

Since:

6.0.0

getTVCRootLogger

public static com.technia.tvc.log4j.Logger getTVCRootLogger()

Returns:

Returns the TVC root logger.

Since:

6.0.0

suspend

public static void suspend()

Suspends all logging for the current thread until resume() is called.

Since:

6.0.0

resume

public static void resume()

Resumes logging for the current thread.

Since:

6.0.0

isSuspended

public static boolean isSuspended()

Returns:

True if logging is suspended

Since:

2011.1.0

getNoLoggingFilter

public static com.technia.tvc.log4j.spi.Filter getNoLoggingFilter()

Returns:

Returns the Filter that should be added to Appenders if they wish to support suspend() and resume().

Since:

6.0.0