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