001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.config.yaml; 018 019import org.apache.logging.log4j.core.LoggerContext; 020import org.apache.logging.log4j.core.config.Configuration; 021import org.apache.logging.log4j.core.config.ConfigurationFactory; 022import org.apache.logging.log4j.core.config.ConfigurationSource; 023import org.apache.logging.log4j.core.config.Order; 024import org.apache.logging.log4j.core.config.plugins.Plugin; 025import org.apache.logging.log4j.core.util.Loader; 026 027@Plugin(name = "YamlConfigurationFactory", category = ConfigurationFactory.CATEGORY) 028@Order(7) 029public class YamlConfigurationFactory extends ConfigurationFactory { 030 031 /** 032 * The file extensions supported by this factory. 033 */ 034 private static final String[] SUFFIXES = new String[] {".yml", ".yaml"}; 035 036 private static final String[] dependencies = new String[] { 037 "com.fasterxml.jackson.databind.ObjectMapper", 038 "com.fasterxml.jackson.databind.JsonNode", 039 "com.fasterxml.jackson.core.JsonParser", 040 "com.fasterxml.jackson.dataformat.yaml.YAMLFactory" 041 }; 042 043 private final boolean isActive; 044 045 public YamlConfigurationFactory() { 046 for (final String dependency : dependencies) { 047 if (!Loader.isClassAvailable(dependency)) { 048 LOGGER.debug("Missing dependencies for Yaml support, ConfigurationFactory {} is inactive", getClass().getName()); 049 isActive = false; 050 return; 051 } 052 } 053 isActive = true; 054 } 055 056 @Override 057 protected boolean isActive() { 058 return isActive; 059 } 060 061 @Override 062 public Configuration getConfiguration(final LoggerContext loggerContext, final ConfigurationSource source) { 063 if (!isActive) { 064 return null; 065 } 066 return new YamlConfiguration(loggerContext, source); 067 } 068 069 @Override 070 public String[] getSupportedTypes() { 071 return SUFFIXES; 072 } 073 074}