uk.ac.ed.epcc.webapp.logging

Interface LoggerService

All Superinterfaces:

AppContextCleanup, AppContextService<LoggerService>

All Known Implementing Classes:

BufferLoggerService, CommandLineLoggerService, DebugLoggerService, EmailLoggerService, JavaLoggerService, Log4JLoggerService, PrintLoggerService, ServletEmailLoggerService

public interface LoggerService
extends AppContextService<LoggerService>

A service to provide logging capabilities.

   uk.ac.ed.epcc.webapp.Logger log = c.getService(LoggerService.class).getLogger(getClass()); // gets logger for this class
   log.debug("A debug message");
   log.error("A error message");

Logger is a locally defined interface. In a servlet context this is usually a wrapper round a Log4J Logger class. However in a stand-alone context a the Logger just prints to System.out This is to allow lightweight applications to run without the full Log4J jar files and makes it easier to switch to a different logging system.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
Logger	getLogger(java.lang.Class c)
Logger	getLogger(java.lang.String name)
default void	initialiseLogging() Initialise the logging system.
default void	securityEvent(java.lang.String event, SessionService sess)
default void	securityEvent(java.lang.String event, SessionService sess, java.util.Map context) Log a security event.
default void	shutdownLogging() shutdown the logging system called once per application

Methods inherited from interface uk.ac.ed.epcc.webapp.AppContextService

getType

Methods inherited from interface uk.ac.ed.epcc.webapp.AppContextCleanup

cleanup

Field Detail

SECURITY_LOG

static final java.lang.String SECURITY_LOG

See Also:

Constant Field Values

Method Detail

getLogger

Logger getLogger(java.lang.String name)

getLogger

Logger getLogger(java.lang.Class c)

initialiseLogging

default void initialiseLogging()

Initialise the logging system. Called once per application

shutdownLogging

default void shutdownLogging()

shutdown the logging system called once per application

securityEvent

default void securityEvent(java.lang.String event,
                           SessionService sess,
                           java.util.Map context)

Log a security event. To aid analysis the event string should be a fixed string for the type of event. Optionally a map of additional attributes can be passed to place the event in context. Attributes from the session such as the current user are generated automatically

Parameters:

event -

sess - SessionService

context -

securityEvent

default void securityEvent(java.lang.String event,
                           SessionService sess)