View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.filter;
18  
19  import org.apache.logging.log4j.Level;
20  import org.apache.logging.log4j.Marker;
21  import org.apache.logging.log4j.core.Filter;
22  import org.apache.logging.log4j.core.LogEvent;
23  import org.apache.logging.log4j.core.Logger;
24  import org.apache.logging.log4j.core.config.Node;
25  import org.apache.logging.log4j.core.config.plugins.Plugin;
26  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
27  import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
28  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
29  import org.apache.logging.log4j.message.Message;
30  import org.apache.logging.log4j.util.PerformanceSensitive;
31  
32  /**
33   * This filter causes all logging events to be dropped.
34   */
35  @Plugin(name = "DenyAllFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
36  @PerformanceSensitive("allocation")
37  public final class DenyAllFilter extends AbstractFilter {
38  
39      private DenyAllFilter(final Result onMatch, final Result onMismatch) {
40          super(onMatch, onMismatch);
41      }
42  
43      @Override
44      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
45                           final Object... params) {
46          return Result.DENY;
47      }
48  
49      @Override
50      public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,
51                           final Throwable t) {
52          return Result.DENY;
53      }
54  
55      @Override
56      public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,
57                           final Throwable t) {
58          return Result.DENY;
59      }
60  
61      @Override
62      public Result filter(final LogEvent event) {
63          return Result.DENY;
64      }
65  
66      private Result filter(final Marker marker) {
67          return Result.DENY;
68      }
69  
70      @Override
71      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
72              final Object p0) {
73          return Result.DENY;
74      }
75  
76      @Override
77      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
78              final Object p0, final Object p1) {
79          return Result.DENY;
80      }
81  
82      @Override
83      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
84              final Object p0, final Object p1, final Object p2) {
85          return filter(marker);
86      }
87  
88      @Override
89      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
90              final Object p0, final Object p1, final Object p2, final Object p3) {
91          return Result.DENY;
92      }
93  
94      @Override
95      public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
96              final Object p0, final Object p1, final Object p2, final Object p3,
97              final Object p4) {
98          return Result.DENY;
99      }
100 
101     @Override
102     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
103             final Object p0, final Object p1, final Object p2, final Object p3,
104             final Object p4, final Object p5) {
105         return Result.DENY;
106     }
107 
108     @Override
109     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
110             final Object p0, final Object p1, final Object p2, final Object p3,
111             final Object p4, final Object p5, final Object p6) {
112         return Result.DENY;
113     }
114 
115     @Override
116     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
117             final Object p0, final Object p1, final Object p2, final Object p3,
118             final Object p4, final Object p5, final Object p6,
119             final Object p7) {
120         return Result.DENY;
121     }
122 
123     @Override
124     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
125             final Object p0, final Object p1, final Object p2, final Object p3,
126             final Object p4, final Object p5, final Object p6,
127             final Object p7, final Object p8) {
128         return Result.DENY;
129     }
130 
131     @Override
132     public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
133             final Object p0, final Object p1, final Object p2, final Object p3,
134             final Object p4, final Object p5, final Object p6,
135             final Object p7, final Object p8, final Object p9) {
136         return Result.DENY;
137     }
138 
139     @Override
140     public String toString() {
141         return "DenyAll";
142     }
143 
144     @PluginBuilderFactory
145     public static DenyAllFilter.Builder newBuilder() {
146         return new DenyAllFilter.Builder();
147     }
148 
149     public static class Builder extends AbstractFilterBuilder<DenyAllFilter.Builder> implements org.apache.logging.log4j.core.util.Builder<DenyAllFilter> {
150 
151         @Override
152         public DenyAllFilter build() {
153             return new DenyAllFilter(this.getOnMatch(), this.getOnMismatch());
154         }
155     }
156 
157 }