Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

/*******************************************************************************
 * Copyright (c) 2006, 2017 IBM Corporation and others
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 ******************************************************************************/
package org.eclipse.equinox.log;

import org.osgi.framework.Bundle;
import org.osgi.service.log.LogService;

/**
 * Extends the OSGi <code>Log Service</code> to support the use of named loggers that provide
 * some additional context when logging.
 * @ThreadSafe
 * @see Logger
 * @since 3.7
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface ExtendedLogService extends LogService, Logger {

	/**
	 * Returns the <code>Logger<code> object associated with this logger name for the bundle that retrieved this log service.
	 * If loggerName is null the default <code>Logger</code> for this bundle is returned. 
	 * 
	 * @param loggerName The logger name. 
	 * @return <code>Logger</code> associated with the logger name.
	 */
	public Logger getLogger(String loggerName);

	/**
	 * Returns the logger associated with this logger name and bundle.
	 * 
	 * @param loggerName The logger name. 
	 * @param bundle The bundles associated with this logger. If null the bundle that retrieved this log service is used.
	 * @return <code>Logger</code> associated with the logger name.
	* @throws SecurityException if the caller does not have <code>LogPermission[*,LOG]</code>.
	*/
	public Logger getLogger(Bundle bundle, String loggerName);
}