uk.ac.ed.epcc.webapp.apps

Class CommandLineLoggerService

java.lang.Object

uk.ac.ed.epcc.webapp.apps.CommandLineLoggerService

All Implemented Interfaces:

AppContextCleanup, AppContextService<LoggerService>, Logger, LoggerService

public class CommandLineLoggerService
extends java.lang.Object
implements LoggerService, Logger

Logger service for command line tools. It is assumed that command line applications will use standard output to output their result. To avoid polluting their output, this logger writes all logging messages to standard error (even info and debug messages). This has the advantage that applications can have their output piped into another application or file but logging information to the user will still be printed on the command line (unless, of course standard error is redirected)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandLineLoggerService.Level The various levels the debugger can log at

Field Summary

Fields inherited from interface uk.ac.ed.epcc.webapp.logging.LoggerService

SECURITY_LOG

Constructor Summary

Constructors

Constructor and Description
CommandLineLoggerService() Constructs a new CommandLineLoggerService that will not print stack traces when exceptions are presented and with level set to Level.INFO.

Method Summary

Modifier and Type	Method and Description
void	cleanup() AppContext is being closed.
void	debug(java.lang.Object message)
void	debug(java.lang.Object message, java.lang.Throwable t)
void	error(java.lang.Object message)
void	error(java.lang.Object message, java.lang.Throwable t)
void	fatal(java.lang.Object message)
void	fatal(java.lang.Object message, java.lang.Throwable t)
Logger	getLogger(java.lang.Class c)
Logger	getLogger(java.lang.String name)
java.lang.Class<? super LoggerService>	getType() Returns the type of service the class should be registered under.
void	info(java.lang.Object message)
void	info(java.lang.Object message, java.lang.Throwable t)
void	printMessages(boolean b) Sets whether or not this logger prints the exception message when it's logging messages are passed exceptions
void	printStackTraces(boolean b) Sets whether or not this logger prints stack traces when it's logging messages are passed exceptions
void	setLevel(CommandLineLoggerService.Level level) Sets the level at which this logger logs
void	warn(java.lang.Object message)
void	warn(java.lang.Object message, java.lang.Throwable t)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.logging.LoggerService

initialiseLogging, securityEvent, securityEvent, shutdownLogging

Methods inherited from interface uk.ac.ed.epcc.webapp.logging.Logger

debug, debug, error, error, fatal, fatal, info, info, warn, warn

Constructor Detail

CommandLineLoggerService

public CommandLineLoggerService()

Constructs a new CommandLineLoggerService that will not print stack traces when exceptions are presented and with level set to Level.INFO.

Method Detail

printStackTraces

public void printStackTraces(boolean b)

Sets whether or not this logger prints stack traces when it's logging messages are passed exceptions

Parameters:

b - If true stack traces will be printed. If false they won't

printMessages

public void printMessages(boolean b)

Sets whether or not this logger prints the exception message when it's logging messages are passed exceptions

Parameters:

b - If true message will be printed. If false they won't

setLevel

public void setLevel(CommandLineLoggerService.Level level)

Sets the level at which this logger logs

Parameters:

level - The level at which this logger logs

getLogger

public Logger getLogger(java.lang.String name)

Specified by:

getLogger in interface LoggerService

getLogger

public Logger getLogger(java.lang.Class c)

Specified by:

getLogger in interface LoggerService

debug

public void debug(java.lang.Object message)

Specified by:

debug in interface Logger

debug

public void debug(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

debug in interface Logger

error

public void error(java.lang.Object message)

Specified by:

error in interface Logger

error

public void error(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

error in interface Logger

fatal

public void fatal(java.lang.Object message)

Specified by:

fatal in interface Logger

fatal

public void fatal(java.lang.Object message,
                  java.lang.Throwable t)

Specified by:

fatal in interface Logger

info

public void info(java.lang.Object message)

Specified by:

info in interface Logger

info

public void info(java.lang.Object message,
                 java.lang.Throwable t)

Specified by:

info in interface Logger

warn

public void warn(java.lang.Object message)

Specified by:

warn in interface Logger

warn

public void warn(java.lang.Object message,
                 java.lang.Throwable t)

Specified by:

warn in interface Logger

cleanup

public void cleanup()

Description copied from interface: AppContextCleanup

AppContext is being closed. Only use this for cleanup that can't be handled by normal garbage collection or for state which is never returned by reference.

Specified by:

cleanup in interface AppContextCleanup

getType

public java.lang.Class<? super LoggerService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<LoggerService>

Returns:

registration type