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.config.yaml;
18  
19  import org.apache.logging.log4j.core.LoggerContext;
20  import org.apache.logging.log4j.core.config.Configuration;
21  import org.apache.logging.log4j.core.config.ConfigurationFactory;
22  import org.apache.logging.log4j.core.config.ConfigurationSource;
23  import org.apache.logging.log4j.core.config.Order;
24  import org.apache.logging.log4j.core.config.plugins.Plugin;
25  import org.apache.logging.log4j.core.util.Loader;
26  
27  @Plugin(name = "YamlConfigurationFactory", category = ConfigurationFactory.CATEGORY)
28  @Order(7)
29  public class YamlConfigurationFactory extends ConfigurationFactory {
30  
31      /**
32       * The file extensions supported by this factory.
33       */
34      private static final String[] SUFFIXES = new String[] {".yml", ".yaml"};
35  
36      private static final String[] dependencies = new String[] {
37              "com.fasterxml.jackson.databind.ObjectMapper",
38              "com.fasterxml.jackson.databind.JsonNode",
39              "com.fasterxml.jackson.core.JsonParser",
40              "com.fasterxml.jackson.dataformat.yaml.YAMLFactory"
41      };
42  
43      private final boolean isActive;
44  
45      public YamlConfigurationFactory() {
46          for (final String dependency : dependencies) {
47              if (!Loader.isClassAvailable(dependency)) {
48                  LOGGER.debug("Missing dependencies for Yaml support, ConfigurationFactory {} is inactive", getClass().getName());
49                  isActive = false;
50                  return;
51              }
52          }
53          isActive = true;
54      }
55  
56      @Override
57      protected boolean isActive() {
58          return isActive;
59      }
60  
61      @Override
62      public Configuration getConfiguration(final LoggerContext loggerContext, final ConfigurationSource source) {
63          if (!isActive) {
64              return null;
65          }
66          return new YamlConfiguration(loggerContext, source);
67      }
68  
69      @Override
70      public String[] getSupportedTypes() {
71          return SUFFIXES;
72      }
73  
74  }