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
111
112
113
114
|
/*
* Copyright (c) OSGi Alliance (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.admin;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
import org.osgi.service.log.LogLevel;
/**
* Logger Context for a bundle.
* <p>
* Any change to the configuration of this Logger Context must be effective
* immediately for all loggers that would rely upon the configuration of this
* Logger Context.
*
* @ThreadSafe
* @author $Id$
*/
@ProviderType
public interface LoggerContext {
/**
* Returns the name for this Logger Context.
*
* @return The name for this Logger Context. The root Logger Context has no
* name and returns {@code null}.
*/
String getName();
/**
* Returns the effective log level of the logger name in this Logger
* Context.
* <p>
* The effective log level for a logger name is found by the following
* steps:
* <ol>
* <li>If the specified logger name is configured with a non-null log level
* in this Logger Context, return the configured log level.</li>
* <li>For each ancestor logger name of the specified logger name, if the
* ancestor logger name is configured with a non-null log level in this
* Logger Context, return the configured log level.</li>
* <li>If the specified logger name is configured with a non-null log level
* in the root Logger Context, return the configured log level.</li>
* <li>For each ancestor logger name of the specified logger name, if the
* ancestor logger name is configured with a non-null log level in the root
* Logger Context, return the configured log level.</li>
* <li>Return {@link LogLevel#WARN} because no non-null log level has been
* found for the specified logger name or any of its ancestor logger names.
* </li>
* </ol>
*
* @param name The logger name.
* @return The effective log level of the logger name in this Logger
* Context.
*/
LogLevel getEffectiveLogLevel(String name);
/**
* Returns the configured log levels for this Logger Context.
*
* @return The configured log levels for this Logger Context. The keys are
* the logger names and the values are the log levels. The returned
* map may be empty if no logger names are configured for this
* Logger Context. The log level value can be {@code null}. The
* returned map is the property of the caller who can modify the map
* and use it as input to {@link #setLogLevels(Map)}. The returned
* map must support all optional Map operations.
*/
Map<String,LogLevel> getLogLevels();
/**
* Configure the log levels for this Logger Context.
* <p>
* All previous log levels configured for this Logger Context are cleared
* and then the log levels in the specified map are configured.
*
* @param logLevels The log levels to configure for this Logger Context. The
* keys are the logger names and the values are the log levels.
* The log level value can be {@code null}. The specified map is
* the property of the caller and this method must not modify or
* retain the specified map.
*/
void setLogLevels(Map<String,LogLevel> logLevels);
/**
* Clear the configuration of this Logger Context.
* <p>
* The configured log levels will be cleared.
*/
void clear();
/**
* Returns whether the configuration of this Logger Context is empty.
*
* @return {@code true} if this Logger Context has no configuration. That
* is, the configured log levels are empty. Otherwise {@code false}
* is returned.
*/
boolean isEmpty();
}
|
