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