View Javadoc
1   /*
2    * This file is part of dependency-check-ant.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * Copyright (c) 2015 The OWASP Foundation. All Rights Reserved.
17   */
18  package org.owasp.dependencycheck.ant.logging;
19  
20  import java.util.Objects;
21  import org.apache.tools.ant.Project;
22  import org.apache.tools.ant.Task;
23  import org.slf4j.Logger;
24  import org.slf4j.Marker;
25  import org.slf4j.helpers.FormattingTuple;
26  import org.slf4j.helpers.MessageFormatter;
27  
28  /**
29   * An instance of {@link org.slf4j.Logger} which simply calls the log method on
30   * the current Ant task obtained from {@link AntTaskHolder}.
31   *
32   * @author colezlaw
33   */
34  public class AntLoggerAdapter implements Logger {
35  
36  
37      /**
38       * The logger name.
39       */
40      private final String name;
41  
42      /**
43       * Constructor.
44       *
45       * @param name the logger name
46       */
47      public AntLoggerAdapter(String name) {
48          this.name = Objects.requireNonNull(name, "Logger name cannot be null");
49      }
50  
51      @Override
52      public String getName() {
53          return name;
54      }
55  
56      private Task task() {
57          return AntTaskHolder.getTask();
58      }
59  
60      // --- TRACE ---
61  
62      @Override
63      public boolean isTraceEnabled() {
64          return true;
65      }
66  
67      @Override
68      public void trace(String msg) {
69          final Task t = task();
70          if (t != null) {
71              t.log(msg, Project.MSG_VERBOSE);
72          }
73      }
74  
75      @Override
76      public void trace(String format, Object arg) {
77          final Task t = task();
78          if (t != null) {
79              final FormattingTuple tp = MessageFormatter.format(format, arg);
80              t.log(tp.getMessage(), Project.MSG_VERBOSE);
81          }
82      }
83  
84      @Override
85      public void trace(String format, Object arg1, Object arg2) {
86          final Task t = task();
87          if (t != null) {
88              final FormattingTuple tp = MessageFormatter.format(format, arg1, arg2);
89              t.log(tp.getMessage(), Project.MSG_VERBOSE);
90          }
91      }
92  
93      @Override
94      public void trace(String format, Object... arguments) {
95          final Task t = task();
96          if (t != null) {
97              final FormattingTuple tp = MessageFormatter.arrayFormat(format, arguments);
98              t.log(tp.getMessage(), Project.MSG_VERBOSE);
99          }
100     }
101 
102     @Override
103     public void trace(String msg, Throwable throwable) {
104         final Task t = task();
105         if (t != null) {
106             t.log(msg, throwable, Project.MSG_VERBOSE);
107         }
108     }
109 
110     @Override
111     public boolean isTraceEnabled(Marker marker) {
112         return isTraceEnabled();
113     }
114 
115     @Override
116     public void trace(Marker marker, String msg) {
117         trace(msg);
118     }
119 
120     @Override
121     public void trace(Marker marker, String format, Object arg) {
122         trace(format, arg);
123     }
124 
125     @Override
126     public void trace(Marker marker, String format, Object arg1, Object arg2) {
127         trace(format, arg1, arg2);
128     }
129 
130     @Override
131     public void trace(Marker marker, String format, Object... argArray) {
132         trace(format, argArray);
133     }
134 
135     @Override
136     public void trace(Marker marker, String msg, Throwable throwable) {
137         trace(msg, throwable);
138     }
139 
140     // --- DEBUG ---
141 
142     @Override
143     public boolean isDebugEnabled() {
144         return true;
145     }
146 
147     @Override
148     public void debug(String msg) {
149         final Task t = task();
150         if (t != null) {
151             t.log(msg, Project.MSG_DEBUG);
152         }
153     }
154 
155     @Override
156     public void debug(String format, Object arg) {
157         final Task t = task();
158         if (t != null) {
159             final FormattingTuple tp = MessageFormatter.format(format, arg);
160             t.log(tp.getMessage(), Project.MSG_DEBUG);
161         }
162     }
163 
164     @Override
165     public void debug(String format, Object arg1, Object arg2) {
166         final Task t = task();
167         if (t != null) {
168             final FormattingTuple tp = MessageFormatter.format(format, arg1, arg2);
169             t.log(tp.getMessage(), Project.MSG_DEBUG);
170         }
171     }
172 
173     @Override
174     public void debug(String format, Object... arguments) {
175         final Task t = task();
176         if (t != null) {
177             final FormattingTuple tp = MessageFormatter.arrayFormat(format, arguments);
178             t.log(tp.getMessage(), Project.MSG_DEBUG);
179         }
180     }
181 
182     @Override
183     public void debug(String msg, Throwable throwable) {
184         final Task t = task();
185         if (t != null) {
186             t.log(msg, throwable, Project.MSG_DEBUG);
187         }
188     }
189 
190     @Override
191     public boolean isDebugEnabled(Marker marker) {
192         return isDebugEnabled();
193     }
194 
195     @Override
196     public void debug(Marker marker, String msg) {
197         debug(msg);
198     }
199 
200     @Override
201     public void debug(Marker marker, String format, Object arg) {
202         debug(format, arg);
203     }
204 
205     @Override
206     public void debug(Marker marker, String format, Object arg1, Object arg2) {
207         debug(format, arg1, arg2);
208     }
209 
210     @Override
211     public void debug(Marker marker, String format, Object... arguments) {
212         debug(format, arguments);
213     }
214 
215     @Override
216     public void debug(Marker marker, String msg, Throwable throwable) {
217         debug(msg, throwable);
218     }
219 
220     // --- INFO ---
221 
222     @Override
223     public boolean isInfoEnabled() {
224         return true;
225     }
226 
227     @Override
228     public void info(String msg) {
229         final Task t = task();
230         if (t != null) {
231             t.log(msg, Project.MSG_INFO);
232         }
233     }
234 
235     @Override
236     public void info(String format, Object arg) {
237         final Task t = task();
238         if (t != null) {
239             final FormattingTuple tp = MessageFormatter.format(format, arg);
240             t.log(tp.getMessage(), Project.MSG_INFO);
241         }
242     }
243 
244     @Override
245     public void info(String format, Object arg1, Object arg2) {
246         final Task t = task();
247         if (t != null) {
248             final FormattingTuple tp = MessageFormatter.format(format, arg1, arg2);
249             t.log(tp.getMessage(), Project.MSG_INFO);
250         }
251     }
252 
253     @Override
254     public void info(String format, Object... arguments) {
255         final Task t = task();
256         if (t != null) {
257             final FormattingTuple tp = MessageFormatter.arrayFormat(format, arguments);
258             t.log(tp.getMessage(), Project.MSG_INFO);
259         }
260     }
261 
262     @Override
263     public void info(String msg, Throwable throwable) {
264         final Task t = task();
265         if (t != null) {
266             t.log(msg, throwable, Project.MSG_INFO);
267         }
268     }
269 
270     @Override
271     public boolean isInfoEnabled(Marker marker) {
272         return isInfoEnabled();
273     }
274 
275     @Override
276     public void info(Marker marker, String msg) {
277         info(msg);
278     }
279 
280     @Override
281     public void info(Marker marker, String format, Object arg) {
282         info(format, arg);
283     }
284 
285     @Override
286     public void info(Marker marker, String format, Object arg1, Object arg2) {
287         info(format, arg1, arg2);
288     }
289 
290     @Override
291     public void info(Marker marker, String format, Object... arguments) {
292         info(format, arguments);
293     }
294 
295     @Override
296     public void info(Marker marker, String msg, Throwable throwable) {
297         info(msg, throwable);
298     }
299 
300     // --- WARN ---
301 
302     @Override
303     public boolean isWarnEnabled() {
304         return true;
305     }
306 
307     @Override
308     public void warn(String msg) {
309         final Task t = task();
310         if (t != null) {
311             t.log(msg, Project.MSG_WARN);
312         }
313     }
314 
315     @Override
316     public void warn(String format, Object arg) {
317         final Task t = task();
318         if (t != null) {
319             final FormattingTuple tp = MessageFormatter.format(format, arg);
320             t.log(tp.getMessage(), Project.MSG_WARN);
321         }
322     }
323 
324     @Override
325     public void warn(String format, Object... arguments) {
326         final Task t = task();
327         if (t != null) {
328             final FormattingTuple tp = MessageFormatter.arrayFormat(format, arguments);
329             t.log(tp.getMessage(), Project.MSG_WARN);
330         }
331     }
332 
333     @Override
334     public void warn(String format, Object arg1, Object arg2) {
335         final Task t = task();
336         if (t != null) {
337             final FormattingTuple tp = MessageFormatter.format(format, arg1, arg2);
338             t.log(tp.getMessage(), Project.MSG_WARN);
339         }
340     }
341 
342     @Override
343     public void warn(String msg, Throwable throwable) {
344         final Task t = task();
345         if (t != null) {
346             t.log(msg, throwable, Project.MSG_WARN);
347         }
348     }
349 
350     @Override
351     public boolean isWarnEnabled(Marker marker) {
352         return isWarnEnabled();
353     }
354 
355     @Override
356     public void warn(Marker marker, String msg) {
357         warn(msg);
358     }
359 
360     @Override
361     public void warn(Marker marker, String format, Object arg) {
362         warn(format, arg);
363     }
364 
365     @Override
366     public void warn(Marker marker, String format, Object arg1, Object arg2) {
367         warn(format, arg1, arg2);
368     }
369 
370     @Override
371     public void warn(Marker marker, String format, Object... arguments) {
372         warn(format, arguments);
373     }
374 
375     @Override
376     public void warn(Marker marker, String msg, Throwable throwable) {
377         warn(msg, throwable);
378     }
379 
380     // --- ERROR ---
381 
382     @Override
383     public boolean isErrorEnabled() {
384         return true;
385     }
386 
387     @Override
388     public void error(String msg) {
389         final Task t = task();
390         if (t != null) {
391             t.log(msg, Project.MSG_ERR);
392         }
393     }
394 
395     @Override
396     public void error(String format, Object arg) {
397         final Task t = task();
398         if (t != null) {
399             final FormattingTuple tp = MessageFormatter.format(format, arg);
400             t.log(tp.getMessage(), Project.MSG_ERR);
401         }
402     }
403 
404     @Override
405     public void error(String format, Object arg1, Object arg2) {
406         final Task t = task();
407         if (t != null) {
408             final FormattingTuple tp = MessageFormatter.format(format, arg1, arg2);
409             t.log(tp.getMessage(), Project.MSG_ERR);
410         }
411     }
412 
413     @Override
414     public void error(String format, Object... arguments) {
415         final Task t = task();
416         if (t != null) {
417             final FormattingTuple tp = MessageFormatter.arrayFormat(format, arguments);
418             t.log(tp.getMessage(), Project.MSG_ERR);
419         }
420     }
421 
422     @Override
423     public void error(String msg, Throwable throwable) {
424         final Task t = task();
425         if (t != null) {
426             t.log(msg, throwable, Project.MSG_ERR);
427         }
428     }
429 
430     @Override
431     public boolean isErrorEnabled(Marker marker) {
432         return isErrorEnabled();
433     }
434 
435     @Override
436     public void error(Marker marker, String msg) {
437         error(msg);
438     }
439 
440     @Override
441     public void error(Marker marker, String format, Object arg) {
442         error(format, arg);
443     }
444 
445     @Override
446     public void error(Marker marker, String format, Object arg1, Object arg2) {
447         error(format, arg1, arg2);
448     }
449 
450     @Override
451     public void error(Marker marker, String format, Object... arguments) {
452         error(format, arguments);
453     }
454 
455     @Override
456     public void error(Marker marker, String msg, Throwable throwable) {
457         error(msg, throwable);
458     }
459 }