org.osgi.service.log.LogEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pax-logging-api Show documentation

The Pax Logging API Library is to allow for the Pax Logging Service to be reloaded without stopping the many dependent bundles. It also contains the OSGi Log Service API and the Knopflerfish Log API.

There is a newer version: 2.2.7

Show newest version

/*
 * $Header: /cvshome/build/org.osgi.service.log/src/org/osgi/service/log/LogEntry.java,v 1.9 2006/06/16 16:31:49 hargrave Exp $
 *
 * Copyright (c) OSGi Alliance (2000, 2006). 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.framework.Bundle;
import org.osgi.framework.ServiceReference;

/**
 * Provides methods to access the information contained in an individual Log
 * Service log entry.
 * 
 * 
 * A LogEntry object may be acquired from the
 * LogReaderService.getLog method or by registering a
 * LogListener object.
 * 
 * @version $Revision: 1.9 $
 * @see LogReaderService#getLog
 * @see LogListener
 */
public interface LogEntry {
	/**
	 * Returns the bundle that created this LogEntry object.
	 * 
	 * @return The bundle that created this LogEntry object;
	 *         null if no bundle is associated with this
	 *         LogEntry object.
	 */
	public Bundle getBundle();

	/**
	 * Returns the ServiceReference object for the service associated
	 * with this LogEntry object.
	 * 
	 * @return ServiceReference object for the service associated
	 *         with this LogEntry object; null if no
	 *         ServiceReference object was provided.
	 */
	public ServiceReference getServiceReference();

	/**
	 * Returns the severity level of this LogEntry object.
	 * 
	 * 

	 * This is one of the severity levels defined by the LogService
	 * interface.
	 * 
	 * @return Severity level of this LogEntry object.
	 * 
	 * @see LogService#LOG_ERROR
	 * @see LogService#LOG_WARNING
	 * @see LogService#LOG_INFO
	 * @see LogService#LOG_DEBUG
	 */
	public int getLevel();

	/**
	 * Returns the human readable message associated with this LogEntry
	 * object.
	 * 
	 * @return String containing the message associated with this
	 *         LogEntry object.
	 */
	public String getMessage();

	/**
	 * Returns the exception object associated with this LogEntry
	 * object.
	 * 
	 * 
	 * In some implementations, the returned exception may not be the original
	 * exception. To avoid references to a bundle defined exception class, thus
	 * preventing an uninstalled bundle from being garbage collected, the Log
	 * Service may return an exception object of an implementation defined
	 * Throwable subclass. The returned object will attempt to provide as much
	 * information as possible from the original exception object such as the
	 * message and stack trace.
	 * 
	 * @return Throwable object of the exception associated with this
	 *         LogEntry;null if no exception is
	 *         associated with this LogEntry object.
	 */
	public Throwable getException();

	/**
	 * Returns the value of currentTimeMillis() at the time this
	 * LogEntry object was created.
	 * 
	 * @return The system time in milliseconds when this LogEntry
	 *         object was created.
	 * @see "System.currentTimeMillis()"
	 */
	public long getTime();
}