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.Appender;
22  import org.apache.logging.log4j.core.filter.AbstractFilterable;
23  import org.apache.logging.log4j.core.util.Assert;
24  
25  /**
26   * Implementation of the {@code AppenderAdminMBean} interface.
27   */
28  public class AppenderAdmin implements AppenderAdminMBean {
29  
30      private final String contextName;
31      private final Appender appender;
32      private final ObjectName objectName;
33  
34      /**
35       * Constructs a new {@code AppenderAdmin} with the specified contextName
36       * and appender.
37       *
38       * @param contextName used in the {@code ObjectName} for this mbean
39       * @param appender the instrumented object
40       */
41      public AppenderAdmin(final String contextName, final Appender appender) {
42          // super(executor); // no notifications for now
43          this.contextName = Assert.requireNonNull(contextName, "contextName");
44          this.appender = Assert.requireNonNull(appender, "appender");
45          try {
46              final String ctxName = Server.escape(this.contextName);
47              final String configName = Server.escape(appender.getName());
48              final String name = String.format(PATTERN, ctxName, configName);
49              objectName = new ObjectName(name);
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 AppenderAdminMBean#PATTERN
60       */
61      public ObjectName getObjectName() {
62          return objectName;
63      }
64  
65      @Override
66      public String getName() {
67          return appender.getName();
68      }
69  
70      @Override
71      public String getLayout() {
72          return String.valueOf(appender.getLayout());
73      }
74  
75      @Override
76      public boolean isIgnoreExceptions() {
77          return appender.ignoreExceptions();
78      }
79  
80      @Override
81      public String getErrorHandler() {
82          return String.valueOf(appender.getHandler());
83      }
84  
85      @Override
86      public String getFilter() {
87          if (appender instanceof AbstractFilterable) {
88              return String.valueOf(((AbstractFilterable) appender).getFilter());
89          }
90          return null;
91      }
92  }