<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.logging.log4j.core.appender;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.logging.log4j.core.Appender;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.logging.log4j.core.ErrorHandler;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.logging.log4j.core.Filter;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.logging.log4j.core.Lifecycle;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.logging.log4j.core.LogEvent;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.logging.log4j.core.Layout;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.logging.log4j.core.filter.Filterable;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.logging.log4j.status.StatusLogger;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.logging.log4j.Logger;<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>    /**<a name="line.29"></a>
<FONT color="green">030</FONT>     * Base class for Appenders. Although Appenders do not have to extend this class, doing so<a name="line.30"></a>
<FONT color="green">031</FONT>     * will simplify their implementation.<a name="line.31"></a>
<FONT color="green">032</FONT>     */<a name="line.32"></a>
<FONT color="green">033</FONT>    public abstract class AppenderBase extends Filterable implements Appender, Lifecycle {<a name="line.33"></a>
<FONT color="green">034</FONT>        /**<a name="line.34"></a>
<FONT color="green">035</FONT>         * Allow subclasses access to the status logger without creating another instance.<a name="line.35"></a>
<FONT color="green">036</FONT>         */<a name="line.36"></a>
<FONT color="green">037</FONT>        protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>        /**<a name="line.39"></a>
<FONT color="green">040</FONT>         * Appenders set this by calling super.start().<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        private boolean started = false;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        private Layout layout = null;<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        private final String name;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        private final boolean handleException;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        private ErrorHandler handler = new DefaultErrorHandler(this);<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Constructor that defaults to suppressing exceptions.<a name="line.53"></a>
<FONT color="green">054</FONT>         * @param name The Appender name.<a name="line.54"></a>
<FONT color="green">055</FONT>         * @param filter The Filter to associate with the Appender.<a name="line.55"></a>
<FONT color="green">056</FONT>         * @param layout The layout to use to format the event.<a name="line.56"></a>
<FONT color="green">057</FONT>         */<a name="line.57"></a>
<FONT color="green">058</FONT>        protected AppenderBase(String name, Filter filter, Layout layout) {<a name="line.58"></a>
<FONT color="green">059</FONT>            this(name, filter, layout, true);<a name="line.59"></a>
<FONT color="green">060</FONT>        }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>        /**<a name="line.62"></a>
<FONT color="green">063</FONT>         * Constructor.<a name="line.63"></a>
<FONT color="green">064</FONT>         * @param name The Appender name.<a name="line.64"></a>
<FONT color="green">065</FONT>         * @param filter The Filter to associate with the Appender.<a name="line.65"></a>
<FONT color="green">066</FONT>         * @param layout The layout to use to format the event.<a name="line.66"></a>
<FONT color="green">067</FONT>         * @param handleException If true, exceptions will be logged and suppressed. If false errors will be<a name="line.67"></a>
<FONT color="green">068</FONT>         * logged and then passed to the application.<a name="line.68"></a>
<FONT color="green">069</FONT>         */<a name="line.69"></a>
<FONT color="green">070</FONT>        protected AppenderBase(String name, Filter filter, Layout layout, boolean handleException) {<a name="line.70"></a>
<FONT color="green">071</FONT>            super(filter);<a name="line.71"></a>
<FONT color="green">072</FONT>            this.name = name;<a name="line.72"></a>
<FONT color="green">073</FONT>            this.layout = layout;<a name="line.73"></a>
<FONT color="green">074</FONT>            this.handleException = handleException;<a name="line.74"></a>
<FONT color="green">075</FONT>        }<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>        /**<a name="line.77"></a>
<FONT color="green">078</FONT>         * Return the ErrorHandler, if any.<a name="line.78"></a>
<FONT color="green">079</FONT>         * @return The ErrorHandler.<a name="line.79"></a>
<FONT color="green">080</FONT>         */<a name="line.80"></a>
<FONT color="green">081</FONT>        public ErrorHandler getHandler() {<a name="line.81"></a>
<FONT color="green">082</FONT>            return handler;<a name="line.82"></a>
<FONT color="green">083</FONT>        }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /**<a name="line.85"></a>
<FONT color="green">086</FONT>         * The handler must be set before the appender is started.<a name="line.86"></a>
<FONT color="green">087</FONT>         * @param handler The ErrorHandler to use.<a name="line.87"></a>
<FONT color="green">088</FONT>         */<a name="line.88"></a>
<FONT color="green">089</FONT>        public void setHandler(ErrorHandler handler) {<a name="line.89"></a>
<FONT color="green">090</FONT>            if (handler == null) {<a name="line.90"></a>
<FONT color="green">091</FONT>                LOGGER.error("The handler cannot be set to null");<a name="line.91"></a>
<FONT color="green">092</FONT>            }<a name="line.92"></a>
<FONT color="green">093</FONT>            if (isStarted()) {<a name="line.93"></a>
<FONT color="green">094</FONT>                LOGGER.error("The handler cannot be changed once the appender is started");<a name="line.94"></a>
<FONT color="green">095</FONT>                return;<a name="line.95"></a>
<FONT color="green">096</FONT>            }<a name="line.96"></a>
<FONT color="green">097</FONT>            this.handler = handler;<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Close the stream associated with the Appender.<a name="line.101"></a>
<FONT color="green">102</FONT>         */<a name="line.102"></a>
<FONT color="green">103</FONT>        public void close() {<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>        }<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>        /**<a name="line.107"></a>
<FONT color="green">108</FONT>         * Returns the name of the Appender.<a name="line.108"></a>
<FONT color="green">109</FONT>         * @return The name of the Appender.<a name="line.109"></a>
<FONT color="green">110</FONT>         */<a name="line.110"></a>
<FONT color="green">111</FONT>        public String getName() {<a name="line.111"></a>
<FONT color="green">112</FONT>            return name;<a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Returns the Layout for the appender.<a name="line.116"></a>
<FONT color="green">117</FONT>         * @return The Layout used to format the event.<a name="line.117"></a>
<FONT color="green">118</FONT>         */<a name="line.118"></a>
<FONT color="green">119</FONT>        public Layout getLayout() {<a name="line.119"></a>
<FONT color="green">120</FONT>            return layout;<a name="line.120"></a>
<FONT color="green">121</FONT>        }<a name="line.121"></a>
<FONT color="green">122</FONT>    <a name="line.122"></a>
<FONT color="green">123</FONT>        /**<a name="line.123"></a>
<FONT color="green">124</FONT>         * Some appenders need to propogate exceptions back to the application. When suppressException is false the<a name="line.124"></a>
<FONT color="green">125</FONT>         * AppenderControl will allow the exception to percolate.<a name="line.125"></a>
<FONT color="green">126</FONT>         * @return true if exceptions will be supressed, false otherwise.<a name="line.126"></a>
<FONT color="green">127</FONT>         */<a name="line.127"></a>
<FONT color="green">128</FONT>        public boolean isExceptionSuppressed() {<a name="line.128"></a>
<FONT color="green">129</FONT>            return handleException;<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>        /**<a name="line.132"></a>
<FONT color="green">133</FONT>         * Start the Appender.<a name="line.133"></a>
<FONT color="green">134</FONT>         */<a name="line.134"></a>
<FONT color="green">135</FONT>        public void start() {<a name="line.135"></a>
<FONT color="green">136</FONT>            startFilter();<a name="line.136"></a>
<FONT color="green">137</FONT>            this.started = true;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /**<a name="line.140"></a>
<FONT color="green">141</FONT>         * Stop the Appender.<a name="line.141"></a>
<FONT color="green">142</FONT>         */<a name="line.142"></a>
<FONT color="green">143</FONT>        public void stop() {<a name="line.143"></a>
<FONT color="green">144</FONT>            this.started = false;<a name="line.144"></a>
<FONT color="green">145</FONT>            stopFilter();<a name="line.145"></a>
<FONT color="green">146</FONT>        }<a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>        /**<a name="line.148"></a>
<FONT color="green">149</FONT>         * Returns true if the Appender is started, false otherwise.<a name="line.149"></a>
<FONT color="green">150</FONT>         * @return true if the Appender is started, false otherwise.<a name="line.150"></a>
<FONT color="green">151</FONT>         */<a name="line.151"></a>
<FONT color="green">152</FONT>        public boolean isStarted() {<a name="line.152"></a>
<FONT color="green">153</FONT>            return started;<a name="line.153"></a>
<FONT color="green">154</FONT>        }<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>        @Override<a name="line.156"></a>
<FONT color="green">157</FONT>        public String toString() {<a name="line.157"></a>
<FONT color="green">158</FONT>            return name;<a name="line.158"></a>
<FONT color="green">159</FONT>        }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>        /**<a name="line.161"></a>
<FONT color="green">162</FONT>         * Handle an error with a message.<a name="line.162"></a>
<FONT color="green">163</FONT>         * @param msg The message.<a name="line.163"></a>
<FONT color="green">164</FONT>         */<a name="line.164"></a>
<FONT color="green">165</FONT>        public void error(String msg) {<a name="line.165"></a>
<FONT color="green">166</FONT>            handler.error(msg);<a name="line.166"></a>
<FONT color="green">167</FONT>        }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /**<a name="line.169"></a>
<FONT color="green">170</FONT>         * Handle an error with a message and an exception.<a name="line.170"></a>
<FONT color="green">171</FONT>         * @param msg The message.<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param t The Throwable.<a name="line.172"></a>
<FONT color="green">173</FONT>         */<a name="line.173"></a>
<FONT color="green">174</FONT>        public void error(String msg, Throwable t) {<a name="line.174"></a>
<FONT color="green">175</FONT>            handler.error(msg, t);<a name="line.175"></a>
<FONT color="green">176</FONT>        }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>        /**<a name="line.178"></a>
<FONT color="green">179</FONT>         * Handle an error with a message, and exception and a logging event.<a name="line.179"></a>
<FONT color="green">180</FONT>         * @param msg The message.<a name="line.180"></a>
<FONT color="green">181</FONT>         * @param event The LogEvent.<a name="line.181"></a>
<FONT color="green">182</FONT>         * @param t The Throwable.<a name="line.182"></a>
<FONT color="green">183</FONT>         */<a name="line.183"></a>
<FONT color="green">184</FONT>        public void error(String msg, LogEvent event, Throwable t) {<a name="line.184"></a>
<FONT color="green">185</FONT>            handler.error(msg, event, t);<a name="line.185"></a>
<FONT color="green">186</FONT>        }<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>    }<a name="line.188"></a>


</PRE>
</BODY>
</HTML>