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  import javax.management.ObjectName;
    20
    21  import org.apache.logging.log4j.core.selector.ContextSelector;
    22  import org.apache.logging.log4j.core.util.Assert;
    23
    24  /**
    25   * Implementation of the {@code ContextSelectorAdminMBean} interface.
    26   */
    27  public class ContextSelectorAdmin implements ContextSelectorAdminMBean {
    28
    29      private final ObjectName objectName;
    30      private final ContextSelector selector;
    31
    32      /**
    33       * Constructs a new {@code ContextSelectorAdmin}.
    34       *
    35       * @param contextName name of the LoggerContext under which to register this
    36       *            ContextSelectorAdmin. Note that the ContextSelector may be
    37       *            registered multiple times, once for each LoggerContext. In web
    38       *            containers, each web application has its own LoggerContext and
    39       *            by associating the ContextSelector with the LoggerContext, all
    40       *            associated MBeans can be unloaded when the web application is
    41       *            undeployed.
    42       * @param selector the instrumented object
    43       */
    44      public ContextSelectorAdmin(final String contextName, final ContextSelector selector) {
    45          super();
    46          this.selector = Assert.requireNonNull(selector, "ContextSelector");
    47          try {
    48              final String mbeanName = String.format(PATTERN, Server.escape(contextName));
    49              objectName = new ObjectName(mbeanName);
    50          } catch (final Exception e) {
    51              throw new IllegalStateException(e);
    52          }
    53      }
    54
    55      /**
    56       * Returns the {@code ObjectName} of this mbean.
    57       *
    58       * @return the {@code ObjectName}
    59       * @see ContextSelectorAdminMBean#PATTERN
    60       */
    61      public ObjectName getObjectName() {
    62          return objectName;
    63      }
    64
    65      @Override
    66      public String getImplementationClassName() {
    67          return selector.getClass().getName();
    68      }
    69  }