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  
18  package org.apache.logging.log4j.core.config.plugins.visitors;
19  
20  import org.apache.logging.log4j.core.LogEvent;
21  import org.apache.logging.log4j.core.config.Configuration;
22  import org.apache.logging.log4j.core.config.Node;
23  import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
24  
25  /**
26   * PluginVisitor implementation for {@link PluginConfiguration}.
27   */
28  public class PluginConfigurationVisitor extends AbstractPluginVisitor<PluginConfiguration> {
29      public PluginConfigurationVisitor() {
30          super(PluginConfiguration.class);
31      }
32  
33      @Override
34      public Object visit(final Configuration configuration, final Node node, final LogEvent event,
35                          final StringBuilder log) {
36          if (this.conversionType.isInstance(configuration)) {
37              log.append("Configuration");
38              if (configuration.getName() != null) {
39                  log.append('(').append(configuration.getName()).append(')');
40              }
41              return configuration;
42          }
43          LOGGER.warn("Variable annotated with @PluginConfiguration is not compatible with type {}.",
44              configuration.getClass());
45          return null;
46      }
47  }