| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.config.status;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.File;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.FileNotFoundException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.FileOutputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.PrintStream;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.net.URI;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.net.URISyntaxException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.LinkedList;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.Level;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.FileUtils;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.NetUtils;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.status.StatusConsoleListener;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.status.StatusListener;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Configuration for setting up {@link StatusConsoleListener} instances.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public class StatusConfiguration {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> @SuppressWarnings("UseOfSystemOutOrSystemErr")<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private static final PrintStream DEFAULT_STREAM = System.out;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private static final Level DEFAULT_STATUS = Level.ERROR;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private static final Verbosity DEFAULT_VERBOSITY = Verbosity.QUIET;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private final Collection<String> errorMessages = Collections.synchronizedCollection(new LinkedList<String>());<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private final StatusLogger logger = StatusLogger.getLogger();<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private volatile boolean initialized = false;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private PrintStream destination = DEFAULT_STREAM;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private Level status = DEFAULT_STATUS;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private Verbosity verbosity = DEFAULT_VERBOSITY;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private String[] verboseClasses;<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> * Specifies how verbose the StatusLogger should be.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public enum Verbosity {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> QUIET, VERBOSE;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Parses the verbosity property into an enum.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param value property value to parse.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @return enum corresponding to value, or QUIET by default.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public static Verbosity toVerbosity(final String value) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return Boolean.parseBoolean(value) ? VERBOSE : QUIET;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<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> * Logs an error message to the StatusLogger. If the StatusLogger hasn't been set up yet, queues the message to be<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * logged after initialization.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param message error message to log.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public void error(final String message) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if (!this.initialized) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> this.errorMessages.add(message);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> } else {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> this.logger.error(message);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Specifies the destination for StatusLogger events. This can be {@code out} (default) for using<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * {@link System#out standard out}, {@code err} for using {@link System#err standard error}, or a file URI to<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * which log events will be written. If the provided URI is invalid, then the default destination of standard<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * out will be used.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> *<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param destination where status log messages should be output.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return {@code this}<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public StatusConfiguration withDestination(final String destination) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> try {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> this.destination = parseStreamName(destination);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> } catch (final URISyntaxException e) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> this.error("Could not parse URI [" + destination + "]. Falling back to default of stdout.");<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> this.destination = DEFAULT_STREAM;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> } catch (final FileNotFoundException e) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.error("File could not be found at [" + destination + "]. Falling back to default of stdout.");<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> this.destination = DEFAULT_STREAM;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return this;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> private PrintStream parseStreamName(final String name) throws URISyntaxException, FileNotFoundException {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (name == null || name.equalsIgnoreCase("out")) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return DEFAULT_STREAM;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (name.equalsIgnoreCase("err")) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return System.err;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> final URI destUri = NetUtils.toURI(name);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> final File output = FileUtils.fileFromUri(destUri);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if (output == null) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> // don't want any NPEs, no sir<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return DEFAULT_STREAM;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> final FileOutputStream fos = new FileOutputStream(output);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return new PrintStream(fos, true);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Specifies the logging level by name to use for filtering StatusLogger messages.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param status name of logger level to filter below.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @return {@code this}<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @see Level<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> */<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> public StatusConfiguration withStatus(final String status) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> this.status = Level.toLevel(status, null);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (this.status == null) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> this.error("Invalid status level specified: " + status + ". Defaulting to ERROR.");<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> this.status = Level.ERROR;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return this;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Specifies the logging level to use for filtering StatusLogger messages.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> *<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @param status logger level to filter below.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @return {@code this}<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> */<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> public StatusConfiguration withStatus(final Level status) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> this.status = status;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return this;<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Specifies the verbosity level to log at. This only applies to classes configured by<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * {@link #withVerboseClasses(String...) verboseClasses}.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> *<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param verbosity basic filter for status logger messages.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return {@code this}<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public StatusConfiguration withVerbosity(final String verbosity) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> this.verbosity = Verbosity.toVerbosity(verbosity);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return this;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Specifies which class names to filter if the configured verbosity level is QUIET.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @param verboseClasses names of classes to filter if not using VERBOSE.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return {@code this}<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public StatusConfiguration withVerboseClasses(final String... verboseClasses) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> this.verboseClasses = verboseClasses;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return this;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> /**<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * Configures and initializes the StatusLogger using the configured options in this instance.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public void initialize() {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> if (!this.initialized) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> if (this.status == Level.OFF) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> this.initialized = true;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> } else {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> final boolean configured = configureExistingStatusConsoleListener();<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> if (!configured) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> registerNewStatusConsoleListener();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> migrateSavedLogMessages();<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> private boolean configureExistingStatusConsoleListener() {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> boolean configured = false;<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> for (final StatusListener statusListener : this.logger.getListeners()) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (statusListener instanceof StatusConsoleListener) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> final StatusConsoleListener listener = (StatusConsoleListener) statusListener;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> listener.setLevel(this.status);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> this.logger.updateListenerLevel(this.status);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (this.verbosity == Verbosity.QUIET) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> listener.setFilters(this.verboseClasses);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> configured = true;<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return configured;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> private void registerNewStatusConsoleListener() {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> final StatusConsoleListener listener = new StatusConsoleListener(this.status, this.destination);<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (this.verbosity == Verbosity.QUIET) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> listener.setFilters(this.verboseClasses);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> this.logger.registerListener(listener);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> private void migrateSavedLogMessages() {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> for (final String message : this.errorMessages) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> this.logger.error(message);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> this.initialized = true;<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> this.errorMessages.clear();<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span>}<a name="line.226"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
