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.jmx;
    18
    19  /**
    20   * The MBean interface for monitoring and managing the {@code ContextSelector}.
    21   */
    22  public interface ContextSelectorAdminMBean {
    23      /**
    24       * ObjectName pattern ({@value}) for ContextSelectorAdmin MBeans.
    25       * This pattern contains a variable, which is the name of the logger context.
    26       * <p>
    27       * You can find all registered ContextSelectorAdmin MBeans like this:
    28       * </p>
    29       * <pre>
    30       * MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
    31       * String pattern = String.format(ContextSelectorAdminMBean.PATTERN, &quot;*&quot;);
    32       * Set&lt;ObjectName&gt; contextSelectorNames = mbs.queryNames(new ObjectName(pattern), null);
    33       * </pre>
    34       * <p>
    35       * Some characters are not allowed in ObjectNames. The logger context name
    36       * may be quoted. When ContextSelectorAdmin MBeans are
    37       * registered, their ObjectNames are created using this pattern as follows:
    38       * </p>
    39       * <pre>
    40       * String ctxName = Server.escape(loggerContext.getName());
    41       * String name = String.format(PATTERN, ctxName);
    42       * ObjectName objectName = new ObjectName(name);
    43       * </pre>
    44       * @see Server#escape(String)
    45       */
    46      String PATTERN = Server.DOMAIN + ":type=%s,component=ContextSelector";
    47
    48      /**
    49       * Returns the name of the class implementing the {@code ContextSelector}
    50       * interface.
    51       *
    52       * @return the name of the {@code ContextSelector} implementation class.
    53       */
    54      String getImplementationClassName();
    55  }