1 files changed, 114 insertions, 0 deletions
diff --git a/bundles/org.eclipse.osgi/osgi/src/org/osgi/service/log/admin/LoggerContext.java b/bundles/org.eclipse.osgi/osgi/src/org/osgi/service/log/admin/LoggerContext.java
new file mode 100644
index 000000000..33b9e4b6f
--- /dev/null
+++ b/bundles/org.eclipse.osgi/osgi/src/org/osgi/service/log/admin/LoggerContext.java
@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) OSGi Alliance (2016). All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.osgi.service.log.admin;
+
+import java.util.Map;
+
+import org.osgi.annotation.versioning.ProviderType;
+import org.osgi.service.log.LogLevel;
+
+/**
+ * Logger Context for a bundle.
+ * <p>
+ * Any change to the configuration of this Logger Context must be effective
+ * immediately for all loggers that would rely upon the configuration of this
+ * Logger Context.
+ * 
+ * @ThreadSafe
+ * @author $Id$
+ */
+@ProviderType
+public interface LoggerContext {
+	/**
+	 * Returns the name for this Logger Context.
+	 * 
+	 * @return The name for this Logger Context. The root Logger Context has no
+	 *         name and returns {@code null}.
+	 */
+	String getName();
+
+	/**
+	 * Returns the effective log level of the logger name in this Logger
+	 * Context.
+	 * <p>
+	 * The effective log level for a logger name is found by the following
+	 * steps:
+	 * <ol>
+	 * <li>If the specified logger name is configured with a non-null log level
+	 * in this Logger Context, return the configured log level.</li>
+	 * <li>For each ancestor logger name of the specified logger name, if the
+	 * ancestor logger name is configured with a non-null log level in this
+	 * Logger Context, return the configured log level.</li>
+	 * <li>If the specified logger name is configured with a non-null log level
+	 * in the root Logger Context, return the configured log level.</li>
+	 * <li>For each ancestor logger name of the specified logger name, if the
+	 * ancestor logger name is configured with a non-null log level in the root
+	 * Logger Context, return the configured log level.</li>
+	 * <li>Return {@link LogLevel#WARN} because no non-null log level has been
+	 * found for the specified logger name or any of its ancestor logger names.
+	 * </li>
+	 * </ol>
+	 * 
+	 * @param name The logger name.
+	 * @return The effective log level of the logger name in this Logger
+	 *         Context.
+	 */
+	LogLevel getEffectiveLogLevel(String name);
+
+	/**
+	 * Returns the configured log levels for this Logger Context.
+	 * 
+	 * @return 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 log level value can be {@code null}. The
+	 *         returned map is the property of the caller who can modify the map
+	 *         and use it as input to {@link #setLogLevels(Map)}. The returned
+	 *         map must support all optional Map operations.
+	 */
+	Map<String,LogLevel> getLogLevels();
+
+	/**
+	 * Configure the log levels for this Logger Context.
+	 * <p>
+	 * All previous log levels configured for this Logger Context are cleared
+	 * and then the log levels in the specified map are configured.
+	 * 
+	 * @param logLevels The log levels to configure for this Logger Context. The
+	 *            keys are the logger names and the values are the log levels.
+	 *            The log level value can be {@code null}. The specified map is
+	 *            the property of the caller and this method must not modify or
+	 *            retain the specified map.
+	 */
+	void setLogLevels(Map<String,LogLevel> logLevels);
+
+	/**
+	 * Clear the configuration of this Logger Context.
+	 * <p>
+	 * The configured log levels will be cleared.
+	 */
+	void clear();
+
+	/**
+	 * Returns whether the configuration of this Logger Context is empty.
+	 * 
+	 * @return {@code true} if this Logger Context has no configuration. That
+	 *         is, the configured log levels are empty. Otherwise {@code false}
+	 *         is returned.
+	 */
+	boolean isEmpty();
+}