001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements. See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache license, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License. You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the license for the specific language governing permissions and
015     * limitations under the license.
016     */
017    package org.apache.logging.log4j.core;
018    
019    import java.io.Serializable;
020    
021    /**
022     * Appends log events.
023     */
024    public interface Appender extends LifeCycle {
025    
026        /**
027         * Log in <code>Appender</code> specific way. When appropriate,
028         * Loggers will call the <code>doAppend</code> method of appender
029         * implementations in order to log.
030         *
031         * @param event The LogEvent.
032         */
033        void append(LogEvent event);
034    
035    
036        /**
037         * Get the name of this appender.
038         *
039         * @return name, may be null.
040         */
041        String getName();
042    
043        /**
044         * Returns this appender's layout.
045         *
046         * @return the Layout for the Appender or null if none is configured.
047         */
048        Layout<? extends Serializable> getLayout();
049    
050        /**
051         * Some appenders need to propagate exceptions back to the application. When {@code ignoreExceptions} is
052         * {@code false} the AppenderControl will allow the exception to percolate.
053         *
054         * @return {@code true} if exceptions will be logged but now thrown, {@code false} otherwise.
055         */
056        boolean ignoreExceptions();
057    
058        ErrorHandler getHandler();
059    
060        void setHandler(ErrorHandler handler);
061    }