Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-api / apidocs / src-html / org / apache / logging / log4j / status / StatusConsoleListener.html
blob: 062258455eb515b3cb7105ba57302c03c2d04796 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.status;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.PrintStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.Level;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * StatusListener that writes to the Console.<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>@SuppressWarnings("UseOfSystemOutOrSystemErr")<a name="line.27"></a>
<span class="sourceLineNo">028</span>public class StatusConsoleListener implements StatusListener {<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> private Level level = Level.FATAL;<a name="line.30"></a>
<span class="sourceLineNo">031</span> private String[] filters;<a name="line.31"></a>
<span class="sourceLineNo">032</span> private final PrintStream stream;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Creates the StatusConsoleListener using the supplied Level.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @param level The Level of status messages that should appear on the console.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public StatusConsoleListener(final Level level) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> this(level, System.out);<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Creates the StatusConsoleListener using the supplied Level. Make sure not to use a logger stream of some sort<a name="line.43"></a>
<span class="sourceLineNo">044</span> * to avoid creating an infinite loop of indirection!<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param level The Level of status messages that should appear on the console.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param stream The PrintStream to write to.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @throws IllegalArgumentException if the PrintStream argument is {@code null}.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> public StatusConsoleListener(final Level level, final PrintStream stream) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> if (stream == null) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> throw new IllegalArgumentException("You must provide a stream to use for this listener.");<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.level = level;<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.stream = stream;<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Sets the level to a new value.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param level The new Level.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public void setLevel(final Level level) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.level = level;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Return the Log Level for which the Listener should receive events.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @return the Log Level.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public Level getStatusLevel() {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return this.level;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Writes status messages to the console.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param data The StatusData.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span> public void log(final StatusData data) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (!filtered(data)) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> stream.println(data.getFormattedStatus());<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
<span class="sourceLineNo">086</span> * Adds package name filters to exclude.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @param filters An array of package names to exclude.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> public void setFilters(final String... filters) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> this.filters = filters;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> private boolean filtered(final StatusData data) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (filters == null) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return false;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> final String caller = data.getStackTraceElement().getClassName();<a name="line.97"></a>
<span class="sourceLineNo">098</span> for (final String filter : filters) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (caller.startsWith(filter)) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return true;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> return false;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public void close() throws IOException {<a name="line.107"></a>
<span class="sourceLineNo">108</span> // only want to close non-system streams<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (this.stream != System.out &amp;&amp; this.stream != System.err) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.stream.close();<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span>}<a name="line.113"></a>
</pre>
</div>
</body>
</html>