forked from apache/felix-dev
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LogManager.java
318 lines (279 loc) · 8.53 KB
/
LogManager.java
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.felix.scr.impl.logger;
import java.io.Closeable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.BundleListener;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceReference;
import org.osgi.service.log.Logger;
import org.osgi.service.log.LoggerFactory;
import org.osgi.util.tracker.ServiceTracker;
/*
* A class that tracks the LoggerFactory of a bundle and its associated Logger objects.
* When a bundle is stopped and/or the service is unregistered, the logger objects are cleaned.
*
* The basic technique is to use a facade. Instead of returning a log object, we return a facade. The
* methods delegate to the actual logger object. If there is no logger object, we create one.
*
* The LogDomain represents every bundle. Per LogDomain, we keep the facades. If the factory goes,
* we reset the facades.
*/
class LogManager extends ServiceTracker<Object, Object> implements BundleListener
{
private static final String LOGGER_FACTORY_CLASS_NAME = "org.osgi.service.log.LoggerFactory";
final BundleContext scrContext;
final AtomicBoolean closed = new AtomicBoolean(false);
/*
* Locks access to guarded fields
*/
class Lock
{
final Map<Bundle, LogDomain> domains = new HashMap<>();
int trackingCount;
Object factory;
int ranking = 0;
synchronized LogDomain getLogDomain(Bundle bundle)
{
LogDomain domain = domains.get(bundle);
if (domain == null)
{
domain = new LogDomain(bundle);
domains.put(bundle, domain);
}
return domain;
}
synchronized void removedFactory(Object service)
{
if (this.factory == service)
{
this.factory = null;
reset();
}
}
synchronized void setFactory(int ranking, Object service)
{
if (this.factory == null)
{
this.factory = service;
this.ranking = ranking;
}
else if (this.ranking < ranking)
{
this.factory = service;
this.ranking = ranking;
reset();
}
}
synchronized void reset()
{
for (LogDomain domain : domains.values())
{
domain.reset();
}
}
synchronized Object getLogger(LoggerFacade facade, Bundle bundle, String name)
{
if (factory == null)
{
return facade.logger = null;
}
else
{
try
{
return facade.logger = ((LoggerFactory) factory).getLogger(bundle,
name, Logger.class);
}
catch (IllegalArgumentException e)
{
// The bundle probably got uninstalled or somehow unresolved,
// fallback to the SCR bundle's logger
return ((LoggerFactory) factory).getLogger(context.getBundle(), name,
Logger.class);
}
}
}
synchronized LogDomain remove(Bundle bundle)
{
return domains.remove(bundle);
}
synchronized void close()
{
reset();
domains.clear();
}
}
final Lock lock = new Lock();
private final LogConfiguration config;
LogManager(BundleContext context, LogConfiguration config)
{
super(context, LOGGER_FACTORY_CLASS_NAME, null);
this.scrContext = context;
this.config = config;
}
/**
* Initializes the log manager. This internally executes the following:
*
* <ul>
* <li>
* Track all bundles for retrieving the log levels of each bundles if the log extension
* is ({@code ds.log.extension}) not set or set to {@code false} (log extension disabled)
* </li>
* <li>
* Don't track any bundles if log extension is enabled since we don't need the log levels
* of the respective bundles. For log extension, we use the log level of the SCR bundle itself.
* <li>
* <li>
* Start the service tracker to track the OSGi LoggerFactory service
* </li>
* </ul>
*/
public void init()
{
if (!config.isLogExtensionEnabled())
{
scrContext.addBundleListener(this);
}
this.open();
}
@Override
public Object addingService(ServiceReference<Object> reference)
{
Object service = super.addingService(reference);
Integer ranking = (Integer) reference.getProperty(Constants.SERVICE_RANKING);
if (ranking == null)
ranking = 0;
lock.setFactory(ranking, service);
return service;
}
@Override
public void removedService(ServiceReference<Object> reference, Object service)
{
super.removedService(reference, service);
lock.removedFactory(service);
}
<T> T getLogger(Bundle bundle, String name, Class<T> type)
{
return type.cast(lock.getLogDomain(bundle).getLogger(name));
}
@SuppressWarnings("resource")
@Override
public void bundleChanged(BundleEvent event)
{
if (event.getType() == BundleEvent.STOPPED && !closed.get())
{
LogDomain domain = lock.remove(event.getBundle());
if (domain != null)
{
domain.close();
}
}
}
/*
* Tracks a bundle's LoggerFactory service
*/
class LogDomain implements Closeable
{
private final Bundle bundle;
private final Set<LoggerFacade> facades = new HashSet<>();
LogDomain(Bundle bundle)
{
this.bundle = bundle;
}
private void reset()
{
synchronized (facades)
{
for (LoggerFacade facade : facades)
{
facade.reset();
}
}
}
LoggerFacade getLogger(String name)
{
LoggerFacade facade = createLoggerFacade(this, name);
synchronized (facades)
{
facades.add(facade);
}
return facade;
}
@Override
public void close()
{
reset();
}
}
class LoggerFacade
{
private final String name;
private final LogDomain domain;
volatile Object logger;
volatile String prefix;
LoggerFacade(LogDomain logDomain, String name)
{
this.domain = logDomain;
this.name = name;
}
void reset()
{
logger = null;
}
Object getLogger()
{
Object l = this.logger;
if (l == null)
{
l = lock.getLogger(this, domain.bundle, name);
}
return l;
}
Bundle getBundle()
{
return domain.bundle;
}
String getName()
{
return name;
}
}
public void close()
{
if (closed.compareAndSet(false, true))
{
lock.close();
super.close();
this.context.removeBundleListener(this);
}
}
LoggerFacade createLoggerFacade(LogDomain logDomain, String name)
{
assert !closed.get();
return new LoggerFacade(logDomain, name);
}
}