org.ops4j.pax.logging.logback.internal

Class PaxLoggingServiceImpl

java.lang.Object

org.ops4j.pax.logging.logback.internal.PaxLoggingServiceImpl

All Implemented Interfaces:

org.ops4j.pax.logging.PaxLoggingService, org.osgi.framework.ServiceFactory<Object>, org.osgi.service.log.LoggerFactory, org.osgi.service.log.LogService

public class PaxLoggingServiceImpl
extends Object
implements org.ops4j.pax.logging.PaxLoggingService, org.osgi.framework.ServiceFactory<Object>

An implementation of PaxLoggingService that delegates to Logback. This implementation is registered with the OSGi ConfigAdmin with a configuration PID of "org.ops4j.pax.logging". That configuration should have a property "org.ops4j.pax.logging.logback.config.file" which should be a path to a Logback Joran XML configuration file. This class has a fair bit of code copied from from org.ops4j.pax.logging.service.internal.PaxLoggingServiceImpl v1.6.0. Changes include:

• massive overhaul for logback vs. log4j
• configuration is completely different
• removed setLevelToJavaLogging() because logback already has it's own support for synchronizing with JUL. See below!
• Unification of logging backends in 1.11+

To sync java.util.logging logger levels with Logback logger levels, be sure to include this in your logback.xml:

    <contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator">
        <resetJUL>true</resetJUL>
    </contextListener>
 

This is an important performance optimization, as discussed in the Logback docs

Author:

Chris Dolan

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGGER_CONTEXT_BUNDLECONTEXT_KEY

Fields inherited from interface org.osgi.service.log.LogService

LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_WARNING

Constructor Summary

Constructors

Constructor and Description
PaxLoggingServiceImpl(org.osgi.framework.BundleContext bundleContext, org.ops4j.pax.logging.spi.support.LogReaderServiceImpl logReader, org.ops4j.pax.logging.EventAdminPoster eventAdmin, org.ops4j.pax.logging.spi.support.ConfigurationNotifier configNotifier, org.ops4j.pax.logging.PaxLogger logLog)

Method Summary

Modifier and Type	Method and Description
<L extends org.osgi.service.log.Logger> L	getLogger(org.osgi.framework.Bundle bundle, String name, Class<L> loggerType)
org.ops4j.pax.logging.PaxLogger	getLogger(org.osgi.framework.Bundle bundle, String category, String fqcn)
org.osgi.service.log.Logger	getLogger(Class<?> clazz)
<L extends org.osgi.service.log.Logger> L	getLogger(Class<?> clazz, Class<L> loggerType)
org.osgi.service.log.Logger	getLogger(String name)
<L extends org.osgi.service.log.Logger> L	getLogger(String name, Class<L> loggerType)
org.osgi.service.log.LogLevel	getLogLevel()
org.ops4j.pax.logging.PaxContext	getPaxContext()
Object	getService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration registration) Use local class to delegate calls to underlying instance while keeping bundle reference.
void	log(int level, String message)
void	log(int level, String message, Throwable exception)
void	log(org.osgi.framework.ServiceReference sr, int level, String message)
void	log(org.osgi.framework.ServiceReference sr, int level, String message, Throwable exception)
void	setDefaultConfiguration(Dictionary<String,String> config) When there's system/context property specified using PaxLoggingConstants.LOGGING_CFG_PROPERTY_FILE, and ConfigurationAdmin is available, Pax Logging may first get null configuration.
void	shutdown() Shut down the Pax Logging service.
void	ungetService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration registration, Object service)
void	updated(Dictionary<String,?> configuration) ManagedService-like method but not requiring Configuration Admin

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER_CONTEXT_BUNDLECONTEXT_KEY

public static final String LOGGER_CONTEXT_BUNDLECONTEXT_KEY

See Also:

Constant Field Values

Constructor Detail

PaxLoggingServiceImpl

public PaxLoggingServiceImpl(org.osgi.framework.BundleContext bundleContext,
                             org.ops4j.pax.logging.spi.support.LogReaderServiceImpl logReader,
                             org.ops4j.pax.logging.EventAdminPoster eventAdmin,
                             org.ops4j.pax.logging.spi.support.ConfigurationNotifier configNotifier,
                             org.ops4j.pax.logging.PaxLogger logLog)

Method Detail

shutdown

public void shutdown()

Shut down the Pax Logging service. Cleans up LoggerContext.

getLogger

public org.ops4j.pax.logging.PaxLogger getLogger(org.osgi.framework.Bundle bundle,
                                                 String category,
                                                 String fqcn)

Specified by:

getLogger in interface org.ops4j.pax.logging.PaxLoggingService

getLogLevel

public org.osgi.service.log.LogLevel getLogLevel()

Specified by:

getLogLevel in interface org.ops4j.pax.logging.PaxLoggingService

log

public void log(int level,
                String message)

Specified by:

log in interface org.osgi.service.log.LogService

log

public void log(int level,
                String message,
                Throwable exception)

Specified by:

log in interface org.osgi.service.log.LogService

log

public void log(org.osgi.framework.ServiceReference sr,
                int level,
                String message)

Specified by:

log in interface org.osgi.service.log.LogService

log

public void log(org.osgi.framework.ServiceReference sr,
                int level,
                String message,
                Throwable exception)

Specified by:

log in interface org.osgi.service.log.LogService

getPaxContext

public org.ops4j.pax.logging.PaxContext getPaxContext()

Specified by:

getPaxContext in interface org.ops4j.pax.logging.PaxLoggingService

getLogger

public org.osgi.service.log.Logger getLogger(String name)

Specified by:

getLogger in interface org.osgi.service.log.LoggerFactory

getLogger

public org.osgi.service.log.Logger getLogger(Class<?> clazz)

Specified by:

getLogger in interface org.osgi.service.log.LoggerFactory

getLogger

public <L extends org.osgi.service.log.Logger> L getLogger(String name,
                                                           Class<L> loggerType)

Specified by:

getLogger in interface org.osgi.service.log.LoggerFactory

getLogger

public <L extends org.osgi.service.log.Logger> L getLogger(Class<?> clazz,
                                                           Class<L> loggerType)

Specified by:

getLogger in interface org.osgi.service.log.LoggerFactory

getLogger

public <L extends org.osgi.service.log.Logger> L getLogger(org.osgi.framework.Bundle bundle,
                                                           String name,
                                                           Class<L> loggerType)

Specified by:

getLogger in interface org.osgi.service.log.LoggerFactory

setDefaultConfiguration

public void setDefaultConfiguration(Dictionary<String,String> config)

When there's system/context property specified using PaxLoggingConstants.LOGGING_CFG_PROPERTY_FILE, and ConfigurationAdmin is available, Pax Logging may first get null configuration. When "default configuration" is set before that, we'll use it instead of empty configuration.

Parameters:

config -

updated

public void updated(Dictionary<String,?> configuration)

ManagedService-like method but not requiring Configuration Admin

Parameters:

configuration -

getService

public Object getService(org.osgi.framework.Bundle bundle,
                         org.osgi.framework.ServiceRegistration registration)

Use local class to delegate calls to underlying instance while keeping bundle reference. We don't need anything special from bundle-scoped service (ServiceFactory) except the reference to client bundle.

Specified by:

getService in interface org.osgi.framework.ServiceFactory<Object>

ungetService

public void ungetService(org.osgi.framework.Bundle bundle,
                         org.osgi.framework.ServiceRegistration registration,
                         Object service)

Specified by:

ungetService in interface org.osgi.framework.ServiceFactory<Object>