OSGi 8.1.0 · org.osgi.service.log.admin.LoggerContext

Modifier and Type	Field and Description
public static final String	LOGGER_CONTEXT_DEFAULT_LOGLEVEL Framework launching property specifying the default log level of the root Logger Context.
public static final String	LOGGER_CONTEXT_PID Logger Context PID.

Method Summary

Modifier and Type	Method and Description
public void	clear() Clear the configuration of this Logger Context.
public LogLevel	Returns: The effective log level of the logger name in this Logger Context. getEffectiveLogLevel(String The logger name. name) Returns the effective log level of the logger name in this Logger Context.
public Map<String, LogLevel>	Returns: The configured log levels for this Logger Context. The keys are the logger names and the values are the log levels. The returned map may be empty if no logger names are configured for this Logger Context. The returned map is the property of the caller who can modify the map and use it as input to `setLogLevels(Map)`. The returned map must support all optional Map operations. getLogLevels() Returns the configured log levels for this Logger Context.
public String	Returns: The name for this Logger Context. The root Logger Context has no name and returns `null`. getName() Returns the name for this Logger Context.
public boolean	Returns: `true` if this Logger Context has no configuration. That is, the configured log levels are empty. Otherwise `false` is returned. isEmpty() Returns whether the configuration of this Logger Context is empty.
public void	setLogLevels(Map<String, LogLevel> The log levels to configure for this Logger Context. The keys are the logger names and the values are the log levels. The specified map is the property of the caller and this method must not modify or retain the specified map. logLevels) Configure the log levels for this Logger Context.

Field Detail

LOGGER_CONTEXT_DEFAULT_LOGLEVEL back to summary

LOGGER_CONTEXT_DEFAULT_LOGLEVEL	back to summary
public static final String LOGGER_CONTEXT_DEFAULT_LOGLEVEL Framework launching property specifying the default log level of the root Logger Context. The value of this property must be the name of the one of the `LogLevel`s. If not specified, or the specified value is not the name of the one of the `LogLevel`s, the default log level of the root Logger Context is `LogLevel#WARN`. See Also `LogLevel`

public static final String LOGGER_CONTEXT_DEFAULT_LOGLEVEL

Framework launching property specifying the default log level of the root Logger Context.

The value of this property must be the name of the one of the LogLevels.

If not specified, or the specified value is not the name of the one of the LogLevels, the default log level of the root Logger Context is LogLevel#WARN.

See Also: LogLevel

LOGGER_CONTEXT_PID back to summary

LOGGER_CONTEXT_PID	back to summary
public static final String LOGGER_CONTEXT_PID Logger Context PID. If Configuration Admin is present, Logger Context configuration information in Configuration Admin must be used. The name of the Logger Context is mapped to a Configuration Admin targeted PID as follows: The root Logger Context, which has no name, is mapped to the PID `org.osgi.service.log.admin`. A named Logger Context is mapped to a targeted PID by prefixing the Logger Context's name with `org.osgi.service.log.admin` followed by vertical line (`'\|'` \u007c). For example, the Logger Context named `com.foo.bar` is mapped to the targeted PID `org.osgi.service.log.admin\|com.foo.bar`.

public static final String LOGGER_CONTEXT_PID

Logger Context PID.

If Configuration Admin is present, Logger Context configuration information in Configuration Admin must be used. The name of the Logger Context is mapped to a Configuration Admin targeted PID as follows:

The root Logger Context, which has no name, is mapped to the PID org.osgi.service.log.admin.
A named Logger Context is mapped to a targeted PID by prefixing the Logger Context's name with org.osgi.service.log.admin followed by vertical line ('|' \u007c). For example, the Logger Context named com.foo.bar is mapped to the targeted PID org.osgi.service.log.admin|com.foo.bar.

Method Detail

clear	back to summary
public void clear() Clear the configuration of this Logger Context. The configured log levels will be cleared.

clear

back to summary

public void clear()

Clear the configuration of this Logger Context.

The configured log levels will be cleared.

getEffectiveLogLevel back to summary

getEffectiveLogLevel	back to summary
public LogLevel getEffectiveLogLevel(String name) Returns the effective log level of the logger name in this Logger Context. The effective log level for a logger name is found by the following steps: If the specified logger name is configured with a log level, return the configured log level. For each ancestor logger name of the specified logger name, if the ancestor logger name is configured with a log level, return the configured log level. If this Logger Context is named, return the result of calling this method on the root Logger Context with the specified logger name. If this Logger Context is the root Logger Context, return the `default log level of the root Logger Context`. Parameters name:String The logger name. Returns:LogLevel The effective log level of the logger name in this Logger Context.

public LogLevel getEffectiveLogLevel(String name)

Returns the effective log level of the logger name in this Logger Context.

The effective log level for a logger name is found by the following steps:

If the specified logger name is configured with a log level, return the configured log level.
For each ancestor logger name of the specified logger name, if the ancestor logger name is configured with a log level, return the configured log level.
If this Logger Context is named, return the result of calling this method on the root Logger Context with the specified logger name.
If this Logger Context is the root Logger Context, return the default log level of the root Logger Context.

Parameters

name:String: The logger name.

Returns:LogLevel

The effective log level of the logger name in this Logger Context.

getLogLevels back to summary

getLogLevels	back to summary
public Map<String, LogLevel> getLogLevels() Returns the configured log levels for this Logger Context. Returns:Map<String, LogLevel> The configured log levels for this Logger Context. The keys are the logger names and the values are the log levels. The returned map may be empty if no logger names are configured for this Logger Context. The returned map is the property of the caller who can modify the map and use it as input to `setLogLevels(Map)`. The returned map must support all optional Map operations.

public Map<String, LogLevel> getLogLevels()

Returns the configured log levels for this Logger Context.

Returns:Map<String, LogLevel>: The configured log levels for this Logger Context. The keys are the logger names and the values are the log levels. The returned map may be empty if no logger names are configured for this Logger Context. The returned map is the property of the caller who can modify the map and use it as input to setLogLevels(Map). The returned map must support all optional Map operations.

getName back to summary

getName	back to summary
public String getName() Returns the name for this Logger Context. Returns:String The name for this Logger Context. The root Logger Context has no name and returns `null`.

public String getName()

Returns the name for this Logger Context.

Returns:String: The name for this Logger Context. The root Logger Context has no name and returns null.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Returns whether the configuration of this Logger Context is empty. Returns:boolean `true` if this Logger Context has no configuration. That is, the configured log levels are empty. Otherwise `false` is returned.

public boolean isEmpty()

Returns whether the configuration of this Logger Context is empty.

Returns:boolean: true if this Logger Context has no configuration. That is, the configured log levels are empty. Otherwise false is returned.

setLogLevels	back to summary
public void setLogLevels(Map<String, LogLevel> logLevels) Configure the log levels for this Logger Context. All previous log levels configured for this Logger Context are cleared and then the log levels in the specified map are configured. The configured log levels for this Logger Context can be set by both this method and by configuration information in Configuration Admin, if Configuration Admin is present. The configured log levels for this Logger Context are based upon the last technique used to update the configured log levels. This method must not modify or set configuration information in Configuration Admin. Parameters logLevels:Map<String, LogLevel> The log levels to configure for this Logger Context. The keys are the logger names and the values are the log levels. The specified map is the property of the caller and this method must not modify or retain the specified map.

setLogLevels

back to summary

public void setLogLevels(Map<String, LogLevel> logLevels)

Configure the log levels for this Logger Context.

All previous log levels configured for this Logger Context are cleared and then the log levels in the specified map are configured.

The configured log levels for this Logger Context can be set by both this method and by configuration information in Configuration Admin, if Configuration Admin is present. The configured log levels for this Logger Context are based upon the last technique used to update the configured log levels. This method must not modify or set configuration information in Configuration Admin.

Parameters

logLevels:Map<String, LogLevel>: The log levels to configure for this Logger Context. The keys are the logger names and the values are the log levels. The specified map is the property of the caller and this method must not modify or retain the specified map.

public Interface LoggerContext

Field Summary

Method Summary

Field Detail

Method Detail