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.jmx;
018    
019    /**
020     * The MBean interface for monitoring and managing an {@code Appender}.
021     */
022    public interface AppenderAdminMBean {
023        /** ObjectName pattern for AppenderAdmin MBeans. */
024        String PATTERN = "org.apache.logging.log4j2:type=LoggerContext,ctx=%s,sub=Appender,name=%s";
025    
026        /**
027         * Returns the name of the instrumented {@code Appender}.
028         * 
029         * @return the name of the Appender
030         */
031        String getName();
032    
033        /**
034         * Returns the result of calling {@code toString} on the {@code Layout}
035         * object of the instrumented {@code Appender}.
036         * 
037         * @return the {@code Layout} of the instrumented {@code Appender} as a
038         *         string
039         */
040        String getLayout();
041    
042        /**
043         * Returns how exceptions thrown on the instrumented {@code Appender} are
044         * handled.
045         * 
046         * @return {@code true} if any exceptions thrown by the Appender will be
047         *         logged or {@code false} if such exceptions are re-thrown.
048         */
049        boolean isExceptionSuppressed();
050    
051        /**
052         * Returns the result of calling {@code toString} on the error handler of
053         * this appender, or {@code "null"} if no error handler was set.
054         * 
055         * @return result of calling {@code toString} on the error handler of this
056         *         appender, or {@code "null"}
057         */
058        String getErrorHandler();
059    }