View Javadoc

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;
18  
19  import java.io.Serializable;
20  
21  /**
22   * Appends log events.
23   */
24  public interface Appender extends LifeCycle {
25  
26      /**
27       * Log in <code>Appender</code> specific way. When appropriate,
28       * Loggers will call the <code>doAppend</code> method of appender
29       * implementations in order to log.
30       *
31       * @param event The LogEvent.
32       */
33      void append(LogEvent event);
34  
35  
36      /**
37       * Get the name of this appender.
38       *
39       * @return name, may be null.
40       */
41      String getName();
42  
43      /**
44       * Returns this appender's layout.
45       *
46       * @return the Layout for the Appender or null if none is configured.
47       */
48      Layout<? extends Serializable> getLayout();
49  
50      /**
51       * Some appenders need to propagate exceptions back to the application. When {@code ignoreExceptions} is
52       * {@code false} the AppenderControl will allow the exception to percolate.
53       *
54       * @return {@code true} if exceptions will be logged but now thrown, {@code false} otherwise.
55       */
56      boolean ignoreExceptions();
57  
58      ErrorHandler getHandler();
59  
60      void setHandler(ErrorHandler handler);
61  }