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 java.util.Map;
    21
    22  import org.apache.logging.log4j.core.LogEvent;
    23  import org.apache.logging.log4j.core.config.Configuration;
    24  import org.apache.logging.log4j.core.config.Node;
    25  import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
    26  import org.apache.logging.log4j.core.util.NameUtil;
    27  import org.apache.logging.log4j.util.StringBuilders;
    28
    29  /**
    30   * PluginVisitor for PluginBuilderAttribute. If {@code null} is returned for the
    31   * {@link #visit(org.apache.logging.log4j.core.config.Configuration, org.apache.logging.log4j.core.config.Node, org.apache.logging.log4j.core.LogEvent, StringBuilder)}
    32   * method, then the default value of the field should remain untouched.
    33   *
    34   * @see org.apache.logging.log4j.core.config.plugins.util.PluginBuilder
    35   */
    36  public class PluginBuilderAttributeVisitor extends AbstractPluginVisitor<PluginBuilderAttribute> {
    37
    38      public PluginBuilderAttributeVisitor() {
    39          super(PluginBuilderAttribute.class);
    40      }
    41
    42      @Override
    43      public Object visit(final Configuration configuration, final Node node, final LogEvent event,
    44                          final StringBuilder log) {
    45          final String overridden = this.annotation.value();
    46          final String name = overridden.isEmpty() ? this.member.getName() : overridden;
    47          final Map<String, String> attributes = node.getAttributes();
    48          final String rawValue = removeAttributeValue(attributes, name, this.aliases);
    49          final String replacedValue = this.substitutor.replace(event, rawValue);
    50          final Object value = convert(replacedValue, null);
    51          final Object debugValue = this.annotation.sensitive() ? NameUtil.md5(value + this.getClass().getName()) : value;
    52          StringBuilders.appendKeyDqValue(log, "name", debugValue);
    53          return value;
    54      }
    55  }