/*
* Copyright (c) OSGi Alliance (2000, 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;
import org.osgi.annotation.versioning.ProviderType;
import org.osgi.framework.ServiceReference;
LogService for logging information.
Replaced by LoggerFactory
.
Author: $Id: 55d10697b1d17e26f3a58a1c738dbc502b835fb9 $ @ThreadSafe
/**
* LogService for logging information.
* <p>
* Replaced by {@link LoggerFactory}.
*
* @ThreadSafe
* @author $Id: 55d10697b1d17e26f3a58a1c738dbc502b835fb9 $
*/
@ProviderType
public interface LogService extends LoggerFactory {
An error message (Value 1).
This log entry indicates the bundle or service may not be functional.
Deprecated: Since 1.4. Replaced by LogLevel.ERROR
.
/**
* An error message (Value 1).
* <p>
* This log entry indicates the bundle or service may not be functional.
*
* @deprecated Since 1.4. Replaced by {@link LogLevel#ERROR}.
*/
@Deprecated
int LOG_ERROR = 1;
A warning message (Value 2).
This log entry indicates a bundle or service is still functioning but may
experience problems in the future because of the warning condition.
Deprecated: Since 1.4. Replaced by LogLevel.WARN
.
/**
* A warning message (Value 2).
* <p>
* This log entry indicates a bundle or service is still functioning but may
* experience problems in the future because of the warning condition.
*
* @deprecated Since 1.4. Replaced by {@link LogLevel#WARN}.
*/
@Deprecated
int LOG_WARNING = 2;
An informational message (Value 3).
This log entry may be the result of any change in the bundle or service
and does not indicate a problem.
Deprecated: Since 1.4. Replaced by LogLevel.INFO
.
/**
* An informational message (Value 3).
* <p>
* This log entry may be the result of any change in the bundle or service
* and does not indicate a problem.
*
* @deprecated Since 1.4. Replaced by {@link LogLevel#INFO}.
*/
@Deprecated
int LOG_INFO = 3;
A debugging message (Value 4).
This log entry is used for problem determination and may be irrelevant to
anyone but the bundle developer.
Deprecated: Since 1.4. Replaced by LogLevel.DEBUG
.
/**
* A debugging message (Value 4).
* <p>
* This log entry is used for problem determination and may be irrelevant to
* anyone but the bundle developer.
*
* @deprecated Since 1.4. Replaced by {@link LogLevel#DEBUG}.
*/
@Deprecated
int LOG_DEBUG = 4;
Logs a message.
The ServiceReference
field and the Throwable
field of the LogEntry
object will be set to null
.
This method will log to the Logger
named "LogService"
for the bundle. The specified level is mapped to a LogLevel
as follows:
LOG_ERROR
- LogLevel.ERROR
LOG_WARNING
- LogLevel.WARN
LOG_INFO
- LogLevel.INFO
LOG_DEBUG
- LogLevel.DEBUG
- Any other value -
LogLevel.TRACE
In the generated log entry, LogEntry.getLevel()
must return the specified level. Params: - level – The severity of the message. This should be one of the
defined log levels but may be any integer that is interpreted
in a user defined way.
- message – Human readable string describing the condition or
null
.
Deprecated: Since 1.4. Replaced by Logger
. See LoggerFactory
.
/**
* Logs a message.
* <p>
* The {@code ServiceReference} field and the {@code Throwable} field of the
* {@code LogEntry} object will be set to {@code null}.
* <p>
* This method will log to the {@link Logger} named {@code "LogService"} for
* the bundle. The specified level is mapped to a {@link LogLevel} as
* follows:
* <ul>
* <li>{@link #LOG_ERROR} - {@link LogLevel#ERROR}</li>
* <li>{@link #LOG_WARNING} - {@link LogLevel#WARN}</li>
* <li>{@link #LOG_INFO} - {@link LogLevel#INFO}</li>
* <li>{@link #LOG_DEBUG} - {@link LogLevel#DEBUG}</li>
* <li>Any other value - {@link LogLevel#TRACE}</li>
* </ul>
* In the generated log entry, {@link LogEntry#getLevel()} must return the
* specified level.
*
* @param level The severity of the message. This should be one of the
* defined log levels but may be any integer that is interpreted
* in a user defined way.
* @param message Human readable string describing the condition or
* {@code null}.
* @deprecated Since 1.4. Replaced by {@link Logger}. See
* {@link LoggerFactory}.
*/
@Deprecated
void log(int level, String message);
Logs a message with an exception.
The ServiceReference
field of the LogEntry
object will be set to null
.
This method will log to the Logger
named "LogService"
for the bundle. The specified level is mapped to a LogLevel
as follows:
LOG_ERROR
- LogLevel.ERROR
LOG_WARNING
- LogLevel.WARN
LOG_INFO
- LogLevel.INFO
LOG_DEBUG
- LogLevel.DEBUG
- Any other value -
LogLevel.TRACE
In the generated log entry, LogEntry.getLevel()
must return the specified level. Params: - level – The severity of the message. This should be one of the
defined log levels but may be any integer that is interpreted
in a user defined way.
- message – The human readable string describing the condition or
null
. - exception – The exception that reflects the condition or
null
.
Deprecated: Since 1.4. Replaced by Logger
. See LoggerFactory
.
/**
* Logs a message with an exception.
* <p>
* The {@code ServiceReference} field of the {@code LogEntry} object will be
* set to {@code null}.
* <p>
* This method will log to the {@link Logger} named {@code "LogService"} for
* the bundle. The specified level is mapped to a {@link LogLevel} as
* follows:
* <ul>
* <li>{@link #LOG_ERROR} - {@link LogLevel#ERROR}</li>
* <li>{@link #LOG_WARNING} - {@link LogLevel#WARN}</li>
* <li>{@link #LOG_INFO} - {@link LogLevel#INFO}</li>
* <li>{@link #LOG_DEBUG} - {@link LogLevel#DEBUG}</li>
* <li>Any other value - {@link LogLevel#TRACE}</li>
* </ul>
* In the generated log entry, {@link LogEntry#getLevel()} must return the
* specified level.
*
* @param level The severity of the message. This should be one of the
* defined log levels but may be any integer that is interpreted
* in a user defined way.
* @param message The human readable string describing the condition or
* {@code null}.
* @param exception The exception that reflects the condition or
* {@code null}.
* @deprecated Since 1.4. Replaced by {@link Logger}. See
* {@link LoggerFactory}.
*/
@Deprecated
void log(int level, String message, Throwable exception);
Logs a message associated with a specific ServiceReference
object. The Throwable
field of the LogEntry
will be set to null
.
This method will log to the Logger
named "LogService"
for the bundle. The specified level is mapped to a LogLevel
as follows:
LOG_ERROR
- LogLevel.ERROR
LOG_WARNING
- LogLevel.WARN
LOG_INFO
- LogLevel.INFO
LOG_DEBUG
- LogLevel.DEBUG
- Any other value -
LogLevel.TRACE
In the generated log entry, LogEntry.getLevel()
must return the specified level. Params: - sr – The
ServiceReference
object of the service that this message is associated with or null
. - level – The severity of the message. This should be one of the
defined log levels but may be any integer that is interpreted
in a user defined way.
- message – Human readable string describing the condition or
null
.
Deprecated: Since 1.4. Replaced by Logger
. See LoggerFactory
.
/**
* Logs a message associated with a specific {@code ServiceReference}
* object.
* <p>
* The {@code Throwable} field of the {@code LogEntry} will be set to
* {@code null}.
* <p>
* This method will log to the {@link Logger} named {@code "LogService"} for
* the bundle. The specified level is mapped to a {@link LogLevel} as
* follows:
* <ul>
* <li>{@link #LOG_ERROR} - {@link LogLevel#ERROR}</li>
* <li>{@link #LOG_WARNING} - {@link LogLevel#WARN}</li>
* <li>{@link #LOG_INFO} - {@link LogLevel#INFO}</li>
* <li>{@link #LOG_DEBUG} - {@link LogLevel#DEBUG}</li>
* <li>Any other value - {@link LogLevel#TRACE}</li>
* </ul>
* In the generated log entry, {@link LogEntry#getLevel()} must return the
* specified level.
*
* @param sr The {@code ServiceReference} object of the service that this
* message is associated with or {@code null}.
* @param level The severity of the message. This should be one of the
* defined log levels but may be any integer that is interpreted
* in a user defined way.
* @param message Human readable string describing the condition or
* {@code null}.
* @deprecated Since 1.4. Replaced by {@link Logger}. See
* {@link LoggerFactory}.
*/
@Deprecated
void log(ServiceReference< ? > sr, int level, String message);
Logs a message with an exception associated and a ServiceReference
object. This method will log to the Logger
named "LogService"
for the bundle. The specified level is mapped to a LogLevel
as follows:
LOG_ERROR
- LogLevel.ERROR
LOG_WARNING
- LogLevel.WARN
LOG_INFO
- LogLevel.INFO
LOG_DEBUG
- LogLevel.DEBUG
- Any other value -
LogLevel.TRACE
In the generated log entry, LogEntry.getLevel()
must return the specified level. Params: - sr – The
ServiceReference
object of the service that this message is associated with. - level – The severity of the message. This should be one of the
defined log levels but may be any integer that is interpreted
in a user defined way.
- message – Human readable string describing the condition or
null
. - exception – The exception that reflects the condition or
null
.
Deprecated: Since 1.4. Replaced by Logger
. See LoggerFactory
.
/**
* Logs a message with an exception associated and a
* {@code ServiceReference} object.
* <p>
* This method will log to the {@link Logger} named {@code "LogService"} for
* the bundle. The specified level is mapped to a {@link LogLevel} as
* follows:
* <ul>
* <li>{@link #LOG_ERROR} - {@link LogLevel#ERROR}</li>
* <li>{@link #LOG_WARNING} - {@link LogLevel#WARN}</li>
* <li>{@link #LOG_INFO} - {@link LogLevel#INFO}</li>
* <li>{@link #LOG_DEBUG} - {@link LogLevel#DEBUG}</li>
* <li>Any other value - {@link LogLevel#TRACE}</li>
* </ul>
* In the generated log entry, {@link LogEntry#getLevel()} must return the
* specified level.
*
* @param sr The {@code ServiceReference} object of the service that this
* message is associated with.
* @param level The severity of the message. This should be one of the
* defined log levels but may be any integer that is interpreted
* in a user defined way.
* @param message Human readable string describing the condition or
* {@code null}.
* @param exception The exception that reflects the condition or
* {@code null}.
* @deprecated Since 1.4. Replaced by {@link Logger}. See
* {@link LoggerFactory}.
*/
@Deprecated
void log(ServiceReference< ? > sr, int level, String message,
Throwable exception);
}