1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.filter;
18
19 import java.util.ArrayList;
20 import java.util.Arrays;
21 import java.util.Iterator;
22 import java.util.List;
23 import java.util.concurrent.TimeUnit;
24
25 import org.apache.logging.log4j.Level;
26 import org.apache.logging.log4j.Marker;
27 import org.apache.logging.log4j.core.AbstractLifeCycle;
28 import org.apache.logging.log4j.core.Filter;
29 import org.apache.logging.log4j.core.LifeCycle2;
30 import org.apache.logging.log4j.core.LogEvent;
31 import org.apache.logging.log4j.core.Logger;
32 import org.apache.logging.log4j.core.config.Node;
33 import org.apache.logging.log4j.core.config.plugins.Plugin;
34 import org.apache.logging.log4j.core.config.plugins.PluginElement;
35 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
36 import org.apache.logging.log4j.core.util.ObjectArrayIterator;
37 import org.apache.logging.log4j.message.Message;
38 import org.apache.logging.log4j.util.PerformanceSensitive;
39
40
41
42
43 @Plugin(name = "filters", category = Node.CATEGORY, printObject = true)
44 @PerformanceSensitive("allocation")
45 public final class CompositeFilter extends AbstractLifeCycle implements Iterable<Filter>, Filter {
46
47 private static final Filter[] EMPTY_FILTERS = new Filter[0];
48 private final Filter[] filters;
49
50 private CompositeFilter() {
51 this.filters = EMPTY_FILTERS;
52 }
53
54 private CompositeFilter(final Filter[] filters) {
55 this.filters = filters == null ? EMPTY_FILTERS : filters;
56 }
57
58 public CompositeFilter addFilter(final Filter filter) {
59 if (filter == null) {
60
61 return this;
62 }
63 if (filter instanceof CompositeFilter) {
64 final int size = this.filters.length + ((CompositeFilter) filter).size();
65 final Filter[] copy = Arrays.copyOf(this.filters, size);
66 final int index = this.filters.length;
67 for (final Filter currentFilter : ((CompositeFilter) filter).filters) {
68 copy[index] = currentFilter;
69 }
70 return new CompositeFilter(copy);
71 }
72 final Filter[] copy = Arrays.copyOf(this.filters, this.filters.length + 1);
73 copy[this.filters.length] = filter;
74 return new CompositeFilter(copy);
75 }
76
77 public CompositeFilter removeFilter(final Filter filter) {
78 if (filter == null) {
79
80 return this;
81 }
82
83
84
85 final List<Filter> filterList = new ArrayList<>(Arrays.asList(this.filters));
86 if (filter instanceof CompositeFilter) {
87 for (final Filter currentFilter : ((CompositeFilter) filter).filters) {
88 filterList.remove(currentFilter);
89 }
90 } else {
91 filterList.remove(filter);
92 }
93 return new CompositeFilter(filterList.toArray(new Filter[this.filters.length - 1]));
94 }
95
96 @Override
97 public Iterator<Filter> iterator() {
98 return new ObjectArrayIterator<>(filters);
99 }
100
101
102
103
104
105
106
107 @Deprecated
108 public List<Filter> getFilters() {
109 return Arrays.asList(filters);
110 }
111
112 public Filter[] getFiltersArray() {
113 return filters;
114 }
115
116
117
118
119
120
121 public boolean isEmpty() {
122 return this.filters.length == 0;
123 }
124
125 public int size() {
126 return filters.length;
127 }
128
129 @Override
130 public void start() {
131 this.setStarting();
132 for (final Filter filter : filters) {
133 filter.start();
134 }
135 this.setStarted();
136 }
137
138 @Override
139 public boolean stop(final long timeout, final TimeUnit timeUnit) {
140 this.setStopping();
141 for (final Filter filter : filters) {
142 if (filter instanceof LifeCycle2) {
143 ((LifeCycle2) filter).stop(timeout, timeUnit);
144 } else {
145 filter.stop();
146 }
147 }
148 setStopped();
149 return true;
150 }
151
152
153
154
155
156
157 @Override
158 public Result getOnMismatch() {
159 return Result.NEUTRAL;
160 }
161
162
163
164
165
166
167 @Override
168 public Result getOnMatch() {
169 return Result.NEUTRAL;
170 }
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187 @Override
188 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
189 final Object... params) {
190 Result result = Result.NEUTRAL;
191 for (int i = 0; i < filters.length; i++) {
192 result = filters[i].filter(logger, level, marker, msg, params);
193 if (result == Result.ACCEPT || result == Result.DENY) {
194 return result;
195 }
196 }
197 return result;
198 }
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214 @Override
215 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
216 final Object p0) {
217 Result result = Result.NEUTRAL;
218 for (int i = 0; i < filters.length; i++) {
219 result = filters[i].filter(logger, level, marker, msg, p0);
220 if (result == Result.ACCEPT || result == Result.DENY) {
221 return result;
222 }
223 }
224 return result;
225 }
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242 @Override
243 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
244 final Object p0, final Object p1) {
245 Result result = Result.NEUTRAL;
246 for (int i = 0; i < filters.length; i++) {
247 result = filters[i].filter(logger, level, marker, msg, p0, p1);
248 if (result == Result.ACCEPT || result == Result.DENY) {
249 return result;
250 }
251 }
252 return result;
253 }
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271 @Override
272 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
273 final Object p0, final Object p1, final Object p2) {
274 Result result = Result.NEUTRAL;
275 for (int i = 0; i < filters.length; i++) {
276 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2);
277 if (result == Result.ACCEPT || result == Result.DENY) {
278 return result;
279 }
280 }
281 return result;
282 }
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301 @Override
302 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
303 final Object p0, final Object p1, final Object p2, final Object p3) {
304 Result result = Result.NEUTRAL;
305 for (int i = 0; i < filters.length; i++) {
306 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3);
307 if (result == Result.ACCEPT || result == Result.DENY) {
308 return result;
309 }
310 }
311 return result;
312 }
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332 @Override
333 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
334 final Object p0, final Object p1, final Object p2, final Object p3,
335 final Object p4) {
336 Result result = Result.NEUTRAL;
337 for (int i = 0; i < filters.length; i++) {
338 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4);
339 if (result == Result.ACCEPT || result == Result.DENY) {
340 return result;
341 }
342 }
343 return result;
344 }
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365 @Override
366 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
367 final Object p0, final Object p1, final Object p2, final Object p3,
368 final Object p4, final Object p5) {
369 Result result = Result.NEUTRAL;
370 for (int i = 0; i < filters.length; i++) {
371 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4, p5);
372 if (result == Result.ACCEPT || result == Result.DENY) {
373 return result;
374 }
375 }
376 return result;
377 }
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399 @Override
400 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
401 final Object p0, final Object p1, final Object p2, final Object p3,
402 final Object p4, final Object p5, final Object p6) {
403 Result result = Result.NEUTRAL;
404 for (int i = 0; i < filters.length; i++) {
405 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4, p5, p6);
406 if (result == Result.ACCEPT || result == Result.DENY) {
407 return result;
408 }
409 }
410 return result;
411 }
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434 @Override
435 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
436 final Object p0, final Object p1, final Object p2, final Object p3,
437 final Object p4, final Object p5, final Object p6,
438 final Object p7) {
439 Result result = Result.NEUTRAL;
440 for (int i = 0; i < filters.length; i++) {
441 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4, p5, p6, p7);
442 if (result == Result.ACCEPT || result == Result.DENY) {
443 return result;
444 }
445 }
446 return result;
447 }
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471 @Override
472 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
473 final Object p0, final Object p1, final Object p2, final Object p3,
474 final Object p4, final Object p5, final Object p6,
475 final Object p7, final Object p8) {
476 Result result = Result.NEUTRAL;
477 for (int i = 0; i < filters.length; i++) {
478 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4, p5, p6, p7, p8);
479 if (result == Result.ACCEPT || result == Result.DENY) {
480 return result;
481 }
482 }
483 return result;
484 }
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509 @Override
510 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
511 final Object p0, final Object p1, final Object p2, final Object p3,
512 final Object p4, final Object p5, final Object p6,
513 final Object p7, final Object p8, final Object p9) {
514 Result result = Result.NEUTRAL;
515 for (int i = 0; i < filters.length; i++) {
516 result = filters[i].filter(logger, level, marker, msg, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9);
517 if (result == Result.ACCEPT || result == Result.DENY) {
518 return result;
519 }
520 }
521 return result;
522 }
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539 @Override
540 public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,
541 final Throwable t) {
542 Result result = Result.NEUTRAL;
543 for (int i = 0; i < filters.length; i++) {
544 result = filters[i].filter(logger, level, marker, msg, t);
545 if (result == Result.ACCEPT || result == Result.DENY) {
546 return result;
547 }
548 }
549 return result;
550 }
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567 @Override
568 public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,
569 final Throwable t) {
570 Result result = Result.NEUTRAL;
571 for (int i = 0; i < filters.length; i++) {
572 result = filters[i].filter(logger, level, marker, msg, t);
573 if (result == Result.ACCEPT || result == Result.DENY) {
574 return result;
575 }
576 }
577 return result;
578 }
579
580
581
582
583
584
585
586
587 @Override
588 public Result filter(final LogEvent event) {
589 Result result = Result.NEUTRAL;
590 for (int i = 0; i < filters.length; i++) {
591 result = filters[i].filter(event);
592 if (result == Result.ACCEPT || result == Result.DENY) {
593 return result;
594 }
595 }
596 return result;
597 }
598
599 @Override
600 public String toString() {
601 final StringBuilder sb = new StringBuilder();
602 for (int i = 0; i < filters.length; i++) {
603 if (sb.length() == 0) {
604 sb.append('{');
605 } else {
606 sb.append(", ");
607 }
608 sb.append(filters[i].toString());
609 }
610 if (sb.length() > 0) {
611 sb.append('}');
612 }
613 return sb.toString();
614 }
615
616
617
618
619
620
621
622
623 @PluginFactory
624 public static CompositeFilter createFilters(@PluginElement("Filters") final Filter[] filters) {
625 return new CompositeFilter(filters);
626 }
627
628 }