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.utilities.java.support.service.AbstractReloadableService<Object>

net.shibboleth.idp.log.LogbackLoggingService

All Implemented Interfaces:

LoggingService, 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, net.shibboleth.utilities.java.support.service.ReloadableService<Object>, Aware, ApplicationContextAware

public class LogbackLoggingService
extends net.shibboleth.utilities.java.support.service.AbstractReloadableService<Object>
implements LoggingService, ApplicationContextAware

Simple LoggingService 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.utilities.java.support.service.AbstractReloadableService

net.shibboleth.utilities.java.support.service.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 LoggerContext	loggerContext Logback logger context.
private 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()
Resource	getLoggingConfiguration() Gets the logging configuration.
net.shibboleth.utilities.java.support.service.ServiceableComponent<Object>	getServiceableComponent() .
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.
protected void	logImplementationDetails() Log the IdP version and Java version and vendor at INFO level.
void	setApplicationContext(ApplicationContext context)
void	setLoggingConfiguration(Resource configuration) Sets the logging configuration.
protected boolean	shouldReload()

Methods inherited from class net.shibboleth.utilities.java.support.service.AbstractReloadableService

doDestroy, getLastReloadAttemptInstant, getLastSuccessfulReloadInstant, getLogPrefix, getReloadCheckDelay, getReloadFailureCause, getReloadTaskTimer, isFailFast, reload, setFailFast, setReloadCheckDelay, setReloadTaskTimer

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, 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.service.ReloadableService

getLastReloadAttemptInstant, getLastSuccessfulReloadInstant, getReloadFailureCause, reload

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

initialize, isInitialized

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

getId

Field Detail

loggerContext

private LoggerContext loggerContext

Logback logger context.

statusManager

private StatusManager statusManager

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

fallbackConfiguration

@NonnullAfterInit
private Resource fallbackConfiguration

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

configurationResource

@NonnullAfterInit
private Resource configurationResource

Logging configuration resource.

applicationContext

@Nullable
private ApplicationContext applicationContext

Spring application context.

Constructor Detail

LogbackLoggingService

public LogbackLoggingService()

Method Detail

getLoggingConfiguration

@NonnullAfterInit
public Resource getLoggingConfiguration()

Gets the logging configuration.

Returns:

logging configuration

setLoggingConfiguration

public void setLoggingConfiguration(@Nonnull
                           Resource configuration)

Sets the logging configuration.

Specified by:

setLoggingConfiguration in interface LoggingService

Parameters:

configuration - logging configuration

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

getServiceableComponent

@Nullable
public net.shibboleth.utilities.java.support.service.ServiceableComponent<Object> getServiceableComponent()

. This service does not support a ServiceableComponent, so return null.

Specified by:

getServiceableComponent in interface net.shibboleth.utilities.java.support.service.ReloadableService<Object>

doInitialize

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

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<Object>

Throws:

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

shouldReload

protected boolean shouldReload()

Specified by:

shouldReload in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<Object>

doReload

protected void doReload()

Overrides:

doReload in class net.shibboleth.utilities.java.support.service.AbstractReloadableService<Object>

loadLoggingConfiguration

protected void loadLoggingConfiguration()

Reads and loads in a new logging configuration.

Throws:

net.shibboleth.utilities.java.support.service.ServiceException - thrown if there is a problem loading the logging configuration

loadLoggingConfiguration

protected void loadLoggingConfiguration(InputStream loggingConfig)

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:

net.shibboleth.utilities.java.support.service.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.

logImplementationDetails

protected void logImplementationDetails()

Log the IdP version and Java version and vendor at INFO level. Log system properties defined by StandardSystemProperty at DEBUG level.