org.apache.logging.log4j.core.jmx.AppenderAdminMBean Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-curves4 Show documentation
Show all versions of virtdata-lib-curves4 Show documentation
Statistical sampling library for use in virtdata libraries, based
on apache commons math 4
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache license, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the license for the specific language governing permissions and
* limitations under the license.
*/
package org.apache.logging.log4j.core.jmx;
/**
* The MBean interface for monitoring and managing an {@code Appender}.
*/
public interface AppenderAdminMBean {
/**
* ObjectName pattern ({@value}) for AppenderAdmin MBeans.
* This pattern contains two variables, where the first is the
* name of the context, the second is the name of the instrumented appender.
*
* You can find all registered AppenderAdmin MBeans like this:
*
*
* MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
* String pattern = String.format(AppenderAdminMBean.PATTERN, "*", "*");
* Set<ObjectName> appenderNames = mbs.queryNames(new ObjectName(pattern), null);
*
*
* Some characters are not allowed in ObjectNames. The logger context name
* and appender name may be quoted. When AppenderAdmin MBeans are
* registered, their ObjectNames are created using this pattern as follows:
*
*
* String ctxName = Server.escape(loggerContext.getName());
* String appenderName = Server.escape(appender.getName());
* String name = String.format(PATTERN, ctxName, appenderName);
* ObjectName objectName = new ObjectName(name);
*
* @see Server#escape(String)
*/
String PATTERN = Server.DOMAIN + ":type=%s,component=Appenders,name=%s";
/**
* Returns the name of the instrumented {@code Appender}.
*
* @return the name of the Appender
*/
String getName();
/**
* Returns the result of calling {@code toString} on the {@code Layout}
* object of the instrumented {@code Appender}.
*
* @return the {@code Layout} of the instrumented {@code Appender} as a
* string
*/
String getLayout();
/**
* Returns how exceptions thrown on the instrumented {@code Appender} are
* handled.
*
* @return {@code true} if any exceptions thrown by the Appender will be
* logged or {@code false} if such exceptions are re-thrown.
*/
boolean isIgnoreExceptions();
/**
* Returns the result of calling {@code toString} on the error handler of
* this appender, or {@code "null"} if no error handler was set.
*
* @return result of calling {@code toString} on the error handler of this
* appender, or {@code "null"}
*/
String getErrorHandler();
/**
* Returns a string description of all filters configured for the
* instrumented {@code Appender}.
*
* @return a string description of all configured filters for this
* appender
*/
String getFilter();
}