net.shibboleth.utilities.java.support.logging

Class LogbackConfigurationListener

java.lang.Object

net.shibboleth.utilities.java.support.logging.LogbackConfigurationListener

All Implemented Interfaces:

EventListener, ServletContextListener

public class LogbackConfigurationListener
extends Object
implements ServletContextListener

ServletContextListener that can be used in web applications to load a logback configuration file. This listener supports logback configuration locations specified either as an absolute file path or as a 'classpath:' URL.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_URL_SCHEME URL scheme used to for classpath URLs.
static String	CONFIG_LOCATION_PARAM Name of context parameter giving location of logback configuration file.
static String	FILE_URL_SCHEME URL scheme used to for file URLs.

Constructor Summary

Constructors

Constructor and Description
LogbackConfigurationListener()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(ServletContext servletContext, URL configLocation, ch.qos.logback.classic.LoggerContext loggerContext) Configures logback using the given configuration file.
void	contextDestroyed(ServletContextEvent sce)
void	contextInitialized(ServletContextEvent sce)
protected URL	toUrl(ServletContext servletContext, String location) Converts the given location in to an absolute URL.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_LOCATION_PARAM

public static final String CONFIG_LOCATION_PARAM

Name of context parameter giving location of logback configuration file.

See Also:

Constant Field Values

FILE_URL_SCHEME

public static final String FILE_URL_SCHEME

URL scheme used to for file URLs.

See Also:

Constant Field Values

CLASSPATH_URL_SCHEME

public static final String CLASSPATH_URL_SCHEME

URL scheme used to for classpath URLs.

See Also:

Constant Field Values

Constructor Detail

LogbackConfigurationListener

public LogbackConfigurationListener()

Method Detail

contextInitialized

public void contextInitialized(ServletContextEvent sce)

Specified by:

contextInitialized in interface ServletContextListener

contextDestroyed

public void contextDestroyed(ServletContextEvent sce)

Specified by:

contextDestroyed in interface ServletContextListener

configure

protected void configure(ServletContext servletContext,
             URL configLocation,
             ch.qos.logback.classic.LoggerContext loggerContext)

Configures logback using the given configuration file.

Parameters:

servletContext - current servlet context

configLocation - logback configuration file location

loggerContext - logger context to be configured

toUrl

protected URL toUrl(ServletContext servletContext,
        String location)

Converts the given location in to an absolute URL.

Parameters:

servletContext - current servlet context

location - logback configuration file location

Returns:

the absolute URL representing the logback configuration file