| <!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.core.appender;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.OutputStream;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Serializable;<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.core.Appender;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Core;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Filter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Layout;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Property;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.CloseShieldOutputStream;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.NullOutputStream;<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> * Appends log events to a given output stream using a layout.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Character encoding is handled within the Layout.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * </p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@Plugin(name = "OutputStream", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public final class OutputStreamAppender extends AbstractOutputStreamAppender<OutputStreamManager> {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Builds OutputStreamAppender instances.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param <B><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * The type to build.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public static class Builder<B extends Builder<B>> extends AbstractOutputStreamAppender.Builder<B><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> implements org.apache.logging.log4j.core.util.Builder<OutputStreamAppender> {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private boolean follow = false;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private final boolean ignoreExceptions = true;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private OutputStream target;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> @Override<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public OutputStreamAppender build() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> final Layout<? extends Serializable> layout = getLayout();<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> final Layout<? extends Serializable> actualLayout = layout == null ? PatternLayout.createDefaultLayout()<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> : layout;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> return new OutputStreamAppender(getName(), actualLayout, getFilter(), getManager(target, follow, actualLayout),<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> ignoreExceptions, getPropertyArray());<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public B setFollow(final boolean shouldFollow) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> this.follow = shouldFollow;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return asBuilder();<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public B setTarget(final OutputStream aTarget) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this.target = aTarget;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return asBuilder();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Holds data to pass to factory method.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private static class FactoryData {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private final Layout<? extends Serializable> layout;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private final String name;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private final OutputStream os;<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> * Builds instances.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param os<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * The OutputStream.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param type<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * The name of the target.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param layout<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * A Serializable layout<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public FactoryData(final OutputStream os, final String type, final Layout<? extends Serializable> layout) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> this.os = os;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> this.name = type;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> this.layout = layout;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<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> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Creates the manager.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> private static class OutputStreamManagerFactory implements ManagerFactory<OutputStreamManager, FactoryData> {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Creates an OutputStreamManager.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> *<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param name<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * The name of the entity to manage.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param data<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * The data required to create the entity.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @return The OutputStreamManager<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> @Override<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public OutputStreamManager createManager(final String name, final FactoryData data) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return new OutputStreamManager(data.os, data.name, data.layout, true);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> private static OutputStreamManagerFactory factory = new OutputStreamManagerFactory();<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Creates an OutputStream Appender.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> *<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param layout<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * The layout to use or null to get the default layout.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param filter<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * The Filter or null.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param target<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * an output stream.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param follow<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * If true will follow changes to the underlying output stream.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Use false as the default.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param name<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * The name of the Appender (required).<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param ignore<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * If {@code "true"} (default) exceptions encountered when<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * appending events are logged; otherwise they are propagated to<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * the caller. Use true as the default.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @return The ConsoleAppender.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> @PluginFactory<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public static OutputStreamAppender createAppender(Layout<? extends Serializable> layout, final Filter filter,<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final OutputStream target, final String name, final boolean follow, final boolean ignore) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (name == null) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> LOGGER.error("No name provided for OutputStreamAppender");<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return null;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (layout == null) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> layout = PatternLayout.createDefaultLayout();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return new OutputStreamAppender(name, layout, filter, getManager(target, follow, layout), ignore, null);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> private static OutputStreamManager getManager(final OutputStream target, final boolean follow,<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final Layout<? extends Serializable> layout) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> final OutputStream os = target == null ? NullOutputStream.getInstance() : new CloseShieldOutputStream(target);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> final OutputStream targetRef = target == null ? os : target;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> final String managerName = targetRef.getClass().getName() + "@" + Integer.toHexString(targetRef.hashCode())<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> + '.' + follow;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return OutputStreamManager.getManager(managerName, new FactoryData(os, managerName, layout), factory);<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> @PluginBuilderFactory<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return new Builder<B>().asBuilder();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> private OutputStreamAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> final OutputStreamManager manager, final boolean ignoreExceptions, final Property[] properties) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> super(name, layout, filter, ignoreExceptions, true, properties, manager);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
