blob: 32878f7adaf3d5444baa776e0ba8c3a669e01ffc [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.core.appender;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.logging.log4j.LoggingException;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Thrown from an appender when a log event could not be written. Appenders should not thrown an exception if an error<a name="line.22"></a>
<span class="sourceLineNo">023</span> * occurs that does &lt;em&gt;not&lt;/em&gt; stop the event from being successfully written. Those types of errors should be logged<a name="line.23"></a>
<span class="sourceLineNo">024</span> * using the {@link org.apache.logging.log4j.status.StatusLogger}. Appenders should only throw exceptions when an error<a name="line.24"></a>
<span class="sourceLineNo">025</span> * prevents an event from being written. Appenders &lt;em&gt;must&lt;/em&gt; throw an exception in this case so that error-handling<a name="line.25"></a>
<span class="sourceLineNo">026</span> * features like the {@link FailoverAppender} work properly.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Also note that appenders &lt;em&gt;must&lt;/em&gt; provide a way to suppress exceptions when the user desires and abide by<a name="line.28"></a>
<span class="sourceLineNo">029</span> * that instruction. See {@link org.apache.logging.log4j.core.Appender#ignoreExceptions()}, which is the standard<a name="line.29"></a>
<span class="sourceLineNo">030</span> * way to do this.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;/p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class AppenderLoggingException extends LoggingException {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final long serialVersionUID = 6545990597472958303L;<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> * Constructs an exception with a message.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @param message The reason for the exception<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> public AppenderLoggingException(final String message) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> super(message);<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Constructs an exception with a message.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param format The reason format for the exception, see {@link String#format(String, Object...)}.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param args The reason arguments for the exception, see {@link String#format(String, Object...)}.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @since 2.12.1<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public AppenderLoggingException(final String format, Object... args) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> super(String.format(format, args));<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> * Constructs an exception with a message and underlying cause.<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @param message The reason for the exception<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param cause The underlying cause of the exception<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public AppenderLoggingException(final String message, final Throwable cause) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> super(message, cause);<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> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Constructs an exception with an underlying cause.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param cause The underlying cause of the exception<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public AppenderLoggingException(final Throwable cause) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> super(cause);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<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> * Constructs an exception with a message.<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param cause The underlying cause of the exception<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @param format The reason format for the exception, see {@link String#format(String, Object...)}.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @param args The reason arguments for the exception, see {@link String#format(String, Object...)}.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @since 2.12.1<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> public AppenderLoggingException(final Throwable cause, final String format, Object... args) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> super(String.format(format, args), cause);<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>
</pre>
</div>
</body>
</html>