logservice.java

OSGI这是一个中间件,与UPNP齐名,是用于移植到嵌入式平台之上

/*
 * $Header: /home/wistrand/cvs/knopflerfish.org/osgi/bundles/log/src/org/osgi/service/log/LogService.java,v 1.1.1.1 2004/03/05 20:35:13 wistrand Exp $
 *
 * Copyright (c) The Open Services Gateway Initiative (2000, 2002).
 * All Rights Reserved.
 *
 * Implementation of certain elements of the Open Services Gateway Initiative
 * (OSGI) Specification may be subject to third party intellectual property
 * rights, including without limitation, patent rights (such a third party may
 * or may not be a member of OSGi). OSGi is not responsible and shall not be
 * held responsible in any manner for identifying or failing to identify any or
 * all such third party intellectual property rights.
 *
 * This document and the information contained herein are provided on an "AS
 * IS" basis and OSGI DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL
 * NOT INFRINGE ANY RIGHTS AND ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL OSGI BE LIABLE FOR ANY
 * LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF
 * BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL,
 * PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH THIS
 * DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH LOSS OR DAMAGE.
 *
 * All Company, brand and product names may be trademarks that are the sole
 * property of their respective owners. All rights reserved.
 */

package org.osgi.service.log;

import org.osgi.framework.ServiceReference;

/**
 * Provides methods for bundles to write messages to the log.
 * 
 * <p>
 * <tt>LogService</tt> methods are provided to log messages; optionally with a
 * <tt>ServiceReference</tt> object or an exception.
 * 
 * <p>
 * Bundles must log messages in the OSGi environment with a severity level
 * according to the following hierarchy:
 * <ol>
 * <li>{@link #LOG_ERROR}
 * <li>{@link #LOG_WARNING}
 * <li>{@link #LOG_INFO}
 * <li>{@link #LOG_DEBUG}
 * </ol>
 * 
 * @version $Revision: 1.1.1.1 $
 * @author Open Services Gateway Initiative
 */
public abstract interface LogService {
    /**
     * An error message (Value 1).
     * 
     * <p>
     * This log entry indicates the bundle or service may not be functional.
     */
    public static final int LOG_ERROR = 1;

    /**
     * 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.
     */
    public static final int LOG_WARNING = 2;

    /**
     * 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.
     */
    public static final int LOG_INFO = 3;

    /**
     * A debugging message (Value 4).
     * 
     * <p>
     * This log entry is used for problem determination and may be irrelevant to
     * anyone but the bundle developer.
     */
    public static final int LOG_DEBUG = 4;

    /**
     * Logs a message.
     * 
     * <p>
     * The <tt>ServiceReference</tt> field and the <tt>Throwable</tt> field
     * of the <tt>LogEntry</tt> object will be set to <tt>null</tt>.
     * 
     * @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
     *            <tt>null</tt>.
     * @see #LOG_ERROR
     * @see #LOG_WARNING
     * @see #LOG_INFO
     * @see #LOG_DEBUG
     */
    public abstract void log(int level, String message);

    /**
     * Logs a message with an exception.
     * 
     * <p>
     * The <tt>ServiceReference</tt> field of the <tt>LogEntry</tt> object
     * will be set to <tt>null</tt>.
     * 
     * @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
     *            <tt>null</tt>.
     * @param exception
     *            The exception that reflects the condition or <tt>null</tt>.
     * @see #LOG_ERROR
     * @see #LOG_WARNING
     * @see #LOG_INFO
     * @see #LOG_DEBUG
     */
    public abstract void log(int level, String message, Throwable exception);

    /**
     * Logs a message associated with a specific <tt>ServiceReference</tt>
     * object.
     * 
     * <p>
     * The <tt>Throwable</tt> field of the <tt>LogEntry</tt> will be set to
     * <tt>null</tt>.
     * 
     * @param sr
     *            The <tt>ServiceReference</tt> object of the service that
     *            this message is associated with or <tt>null</tt>.
     * @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
     *            <tt>null</tt>.
     * @see #LOG_ERROR
     * @see #LOG_WARNING
     * @see #LOG_INFO
     * @see #LOG_DEBUG
     */
    public abstract void log(ServiceReference sr, int level, String message);

    /**
     * Logs a message with an exception associated and a
     * <tt>ServiceReference</tt> object.
     * 
     * @param sr
     *            The <tt>ServiceReference</tt> 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
     *            <tt>null</tt>.
     * @param exception
     *            The exception that reflects the condition or <tt>null</tt>.
     * @see #LOG_ERROR
     * @see #LOG_WARNING
     * @see #LOG_INFO
     * @see #LOG_DEBUG
     */
    public abstract void log(ServiceReference sr, int level, String message,
            Throwable exception);
}