blob: 1a6c322e64ee1470fb1b2d6b57b610b4df962089 (
plain) (
blame)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Copyright (c) OSGi Alliance (2000, 2013). 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.
*
* <p>
* A {@code LogEntry} object may be acquired from the
* {@code LogReaderService.getLog} method or by registering a
* {@code LogListener} object.
*
* @ThreadSafe
* @noimplement
* @author $Id$
* @see LogReaderService#getLog
* @see LogListener
*/
public interface LogEntry {
/**
* Returns the bundle that created this {@code LogEntry} object.
*
* @return The bundle that created this {@code LogEntry} object;
* {@code null} if no bundle is associated with this
* {@code LogEntry} object.
*/
public Bundle getBundle();
/**
* Returns the {@code ServiceReference} object for the service associated
* with this {@code LogEntry} object.
*
* @return {@code ServiceReference} object for the service associated with
* this {@code LogEntry} object; {@code null} if no
* {@code ServiceReference} object was provided.
*/
public ServiceReference getServiceReference();
/**
* Returns the severity level of this {@code LogEntry} object.
*
* <p>
* This is one of the severity levels defined by the {@code LogService}
* interface.
*
* @return Severity level of this {@code 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 {@code LogEntry}
* object.
*
* @return {@code String} containing the message associated with this
* {@code LogEntry} object.
*/
public String getMessage();
/**
* Returns the exception object associated with this {@code LogEntry}
* object.
*
* <p>
* 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 {@code Throwable} object of the exception associated with this
* {@code LogEntry};{@code null} if no exception is associated with
* this {@code LogEntry} object.
*/
public Throwable getException();
/**
* Returns the value of {@code currentTimeMillis()} at the time this
* {@code LogEntry} object was created.
*
* @return The system time in milliseconds when this {@code LogEntry} object
* was created.
* @see "System.currentTimeMillis()"
*/
public long getTime();
}
|
