org.ops4j.pax.logging.spi.support

Class BackendSupport

java.lang.Object

org.ops4j.pax.logging.spi.support.BackendSupport

public class BackendSupport
extends Object

Some helper methods for backends (Log4J1, Log4J2, Logback) to share common internal classes.

Method Summary

Modifier and Type	Method and Description
static String	category(org.osgi.framework.Bundle bundle) LogService doesn't know the concept of logger name (or category), so we have to derive it from what we have - a bundle
static String	convertLogServiceLevel(int level) Returns level name for given integer value that should match one of constants from LogService.
static int	convertLogServiceLevel(String levelName) Returns one of the log level constants from LogService based on level name (case insensitive).
static RegisteredService<org.osgi.service.log.LogReaderService,LogReaderServiceImpl>	createAndRegisterLogReaderService(org.osgi.framework.BundleContext context) Registers LogReaderService and makes it available for actual PaxLoggingService implementation
static String	defaultLogLevel(org.osgi.framework.BundleContext bundleContext) Gets the default level name as configured for pax-logging.
static RegisteredService<ConfigurationNotifier,ConfigurationNotifier>	eventAdminConfigurationNotifier(org.osgi.framework.BundleContext context) Prepares (without registration) ConfigurationNotifier regardles of availability of Event Admin service
static RegisteredService<EventAdminPoster,EventAdminPoster>	eventAdminSupport(org.osgi.framework.BundleContext context) Prepares (without registration) EventAdminPoster regardles of availability of Event Admin service
static String	externalFile(org.osgi.framework.BundleContext bundleContext, String defaultFile)
static boolean	isConfigurationAdminAvailable()
static int	paxLoggingServiceRanking(org.osgi.framework.BundleContext context) Returns configured service ranking for pax-logging services.
static Level	toJULLevel(String levelName) Converts pax-logging level name (anything that pax-logging supports, case-insensitive) to Level from java.util.logging.

Methods inherited from class java.lang.Object

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

Method Detail

paxLoggingServiceRanking

public static int paxLoggingServiceRanking(org.osgi.framework.BundleContext context)

Returns configured service ranking for pax-logging services.

Returns:

createAndRegisterLogReaderService

public static RegisteredService<org.osgi.service.log.LogReaderService,LogReaderServiceImpl> createAndRegisterLogReaderService(org.osgi.framework.BundleContext context)

Registers LogReaderService and makes it available for actual PaxLoggingService implementation

Parameters:

context -

Returns:

eventAdminSupport

public static RegisteredService<EventAdminPoster,EventAdminPoster> eventAdminSupport(org.osgi.framework.BundleContext context)

Prepares (without registration) EventAdminPoster regardles of availability of Event Admin service

Returns:

eventAdminConfigurationNotifier

public static RegisteredService<ConfigurationNotifier,ConfigurationNotifier> eventAdminConfigurationNotifier(org.osgi.framework.BundleContext context)

Prepares (without registration) ConfigurationNotifier regardles of availability of Event Admin service

Returns:

defaultLogLevel

public static String defaultLogLevel(org.osgi.framework.BundleContext bundleContext)

Gets the default level name as configured for pax-logging. The name may not be valid. Simply value specified by user (in system or context properties) is returned (or default DEBUG value).

Parameters:

bundleContext -

Returns:

convertLogServiceLevel

public static int convertLogServiceLevel(String levelName)

Returns one of the log level constants from LogService based on level name (case insensitive). If level is not recognized, DEBUG is assumed.

Parameters:

levelName -

Returns:

one of LogService.LOG_ERROR, LogService.LOG_WARNING, LogService.LOG_INFO, LogService.LOG_DEBUG or ZERO (meaning off).

convertLogServiceLevel

public static String convertLogServiceLevel(int level)

Returns level name for given integer value that should match one of constants from LogService. For zero, OFF value is returned.

Parameters:

level -

Returns:

toJULLevel

public static Level toJULLevel(String levelName)

Converts pax-logging level name (anything that pax-logging supports, case-insensitive) to Level from java.util.logging. If nothing can be parsed, Level.INFO is returned.

Parameters:

levelName -

Returns:

category

public static String category(org.osgi.framework.Bundle bundle)

LogService doesn't know the concept of logger name (or category), so we have to derive it from what we have - a bundle

Parameters:

bundle -

Returns:

isConfigurationAdminAvailable

public static boolean isConfigurationAdminAvailable()

externalFile

public static String externalFile(org.osgi.framework.BundleContext bundleContext,
                                  String defaultFile)