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;
19
20 import java.lang.annotation.Documented;
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 import org.apache.logging.log4j.core.config.plugins.visitors.PluginBuilderAttributeVisitor;
27 import org.apache.logging.log4j.util.Strings;
28
29 /**
30 * Marks a field as a Plugin Attribute.
31 */
32 @Documented
33 @Retention(RetentionPolicy.RUNTIME)
34 @Target({ElementType.PARAMETER, ElementType.FIELD})
35 @PluginVisitorStrategy(PluginBuilderAttributeVisitor.class)
36 public @interface PluginBuilderAttribute {
37
38 /**
39 * Specifies the attribute name this corresponds to. If no attribute is set (i.e., a blank string), then the name
40 * of the field (or member) this annotation is attached to will be used.
41 */
42 String value() default Strings.EMPTY;
43
44 /**
45 * Indicates that this attribute is a sensitive one that shouldn't be logged directly. Such attributes will instead
46 * be output as a hashed value.
47 */
48 boolean sensitive() default false;
49 }