net.shibboleth.idp.log

Class LogbackLoggingService

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.service.AbstractReloadableService<Object>

net.shibboleth.idp.log.LogbackLoggingService

All Implemented Interfaces:

ReloadableService<Object>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, Aware, ApplicationContextAware, Lifecycle

public class LogbackLoggingService
extends AbstractReloadableService<Object>
implements ApplicationContextAware

Simple logging service that watches for logback configuration file changes and reloads the file when a change occurs.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.service.AbstractReloadableService

AbstractReloadableService.ServiceReloadTask

Field Summary

Fields

Modifier and Type	Field and Description
private ApplicationContext	applicationContext Spring application context.
private Resource	configurationResource Logging configuration resource.
private Resource	fallbackConfiguration URL to the fallback logback configuration found in the IdP jar.
private ch.qos.logback.classic.LoggerContext	loggerContext Logback logger context.
private ch.qos.logback.core.status.StatusManager	statusManager Logger used to log messages without relying on the logging system to be full initialized.

Constructor Summary

Constructors

Constructor and Description
LogbackLoggingService()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doReload() Performs the actual reload.
Resource	getLoggingConfiguration() Gets the logging configuration.
ServiceableComponent<Object>	getServiceableComponent() Get the serviceable component that this service supports .
protected void	loadIdPHomeProperty() Add the IdPPropertiesApplicationContextInitializer.IDP_HOME_PROPERTY property from the Spring application context to the logger context.
protected void	loadLoggingConfiguration() Reads and loads in a new logging configuration.
protected void	loadLoggingConfiguration(InputStream loggingConfig) Loads a logging configuration in to the active logger context.
void	setApplicationContext(ApplicationContext context)
void	setLoggingConfiguration(Resource configuration) Sets the logging configuration.
protected boolean	shouldReload() Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

Methods inherited from class net.shibboleth.idp.service.AbstractReloadableService

getLastReloadAttemptInstant, getLastSuccessfulReloadInstant, getLogPrefix, getReloadCheckDelay, getReloadFailureCause, getReloadTaskTimer, isFailFast, isRunning, reload, setFailFast, setReloadCheckDelay, setReloadTaskTimer, start, stop

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

loggerContext

private ch.qos.logback.classic.LoggerContext loggerContext

Logback logger context.

statusManager

private ch.qos.logback.core.status.StatusManager statusManager

Logger used to log messages without relying on the logging system to be full initialized.

fallbackConfiguration

private Resource fallbackConfiguration

URL to the fallback logback configuration found in the IdP jar.

configurationResource

private Resource configurationResource

Logging configuration resource.

applicationContext

@Nullable
private ApplicationContext applicationContext

Spring application context.

Constructor Detail

LogbackLoggingService

public LogbackLoggingService()

Method Detail

getLoggingConfiguration

public Resource getLoggingConfiguration()

Gets the logging configuration.

Returns:

logging configuration

setLoggingConfiguration

public void setLoggingConfiguration(Resource configuration)

Sets the logging configuration.

Parameters:

configuration - logging configuration

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

shouldReload

protected boolean shouldReload()

Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

No lock is held when this method is called, so any locking needed should be handled internally.

Specified by:

shouldReload in class AbstractReloadableService<Object>

Returns:

true iff the service should be reloaded

doReload

protected void doReload()
                 throws ServiceException

Performs the actual reload.

No lock is held when this method is called, so any locking needed should be handled internally.

Overrides:

doReload in class AbstractReloadableService<Object>

Throws:

ServiceException - thrown if there is a problem reloading the service

loadLoggingConfiguration

protected void loadLoggingConfiguration()
                                 throws ServiceException

Reads and loads in a new logging configuration.

Throws:

ServiceException - thrown if there is a problem loading the logging configuration

loadLoggingConfiguration

protected void loadLoggingConfiguration(InputStream loggingConfig)
                                 throws ServiceException

Loads a logging configuration in to the active logger context. Error messages are printed out to the status manager.

Parameters:

loggingConfig - logging configuration file

Throws:

ServiceException - thrown is there is a problem loading the logging configuration

loadIdPHomeProperty

protected void loadIdPHomeProperty()

Add the IdPPropertiesApplicationContextInitializer.IDP_HOME_PROPERTY property from the Spring application context to the logger context.

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractReloadableService<Object>

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

getServiceableComponent

@Nullable
public ServiceableComponent<Object> getServiceableComponent()

Get the serviceable component that this service supports . If The component hasn't been successfully loaded yet or if this service does not support a ServiceableComponent return null. This service does not support a ServiceableComponent, so return null.

Specified by:

getServiceableComponent in interface ReloadableService<Object>

Returns:

the component, if appropriate.