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     */
017    
018    package org.apache.logging.log4j.core.config.plugins.visitors;
019    
020    import org.apache.logging.log4j.core.LogEvent;
021    import org.apache.logging.log4j.core.config.Configuration;
022    import org.apache.logging.log4j.core.config.Node;
023    import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
024    
025    /**
026     * PluginVisitor implementation for {@link PluginConfiguration}.
027     */
028    public class PluginConfigurationVisitor extends AbstractPluginVisitor<PluginConfiguration> {
029        public PluginConfigurationVisitor() {
030            super(PluginConfiguration.class);
031        }
032    
033        @Override
034        public Object visit(final Configuration configuration, final Node node, final LogEvent event,
035                            final StringBuilder log) {
036            if (this.conversionType.isInstance(configuration)) {
037                log.append("Configuration");
038                if (configuration.getName() != null) {
039                    log.append('(').append(configuration.getName()).append(')');
040                }
041                return configuration;
042            }
043            LOGGER.warn("Variable annotated with @PluginConfiguration is not compatible with type {}.",
044                configuration.getClass());
045            return null;
046        }
047    }