1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.appender;
18
19 import org.apache.logging.log4j.LoggingException;
20
21 /**
22 * Thrown from an appender when a log event could not be written. Appenders should not thrown an exception if an error
23 * occurs that does <em>not</em> stop the event from being successfully written. Those types of errors should be logged
24 * using the {@link org.apache.logging.log4j.status.StatusLogger}. Appenders should only throw exceptions when an error
25 * prevents an event from being written. Appenders <em>must</em> throw an exception in this case so that error-handling
26 * features like the {@link FailoverAppender} work properly.
27 *
28 * Also note that appenders <em>must</em> provide a way to suppress exceptions when the user desires and abide by
29 * that instruction. See {@link org.apache.logging.log4j.core.Appender#ignoreExceptions()}, which is the standard
30 * way to do this.
31 */
32 public class AppenderLoggingException extends LoggingException {
33
34 private static final long serialVersionUID = 6545990597472958303L;
35
36 /**
37 * Construct an exception with a message.
38 *
39 * @param message The reason for the exception
40 */
41 public AppenderLoggingException(final String message) {
42 super(message);
43 }
44
45 /**
46 * Construct an exception with a message and underlying cause.
47 *
48 * @param message The reason for the exception
49 * @param cause The underlying cause of the exception
50 */
51 public AppenderLoggingException(final String message, final Throwable cause) {
52 super(message, cause);
53 }
54
55 /**
56 * Construct an exception with an underlying cause.
57 *
58 * @param cause The underlying cause of the exception
59 */
60 public AppenderLoggingException(final Throwable cause) {
61 super(cause);
62 }
63 }