Package org.apache.logging.log4j.plugins

Annotation Interface PluginBuilderAttribute

@Documented @Retention(RUNTIME) @Target({PARAMETER,FIELD,TYPE,TYPE_USE}) @NameProvider(PluginBuilderAttributeNameProvider.class) @QualifierType public @interface PluginBuilderAttribute
Qualifier for a plugin attribute for configuration options of a plugin. This works similarly to PluginAttribute but without a default value being specified in the annotation; instead, default values should be handled programmatically such as through a default field value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    sensitive
    Indicates that this attribute is a sensitive one that shouldn't be logged directly.
    String
    value
    Specifies the attribute name this corresponds to.

  • Element Details

    • value

      String value
      Specifies the attribute name this corresponds to. If no attribute is set (i.e., a blank string), then the name of the field (or member) this annotation is attached to will be used.
      Returns:
      the name of the attribute.
      Default:
      ""

    • sensitive

      boolean sensitive
      Indicates that this attribute is a sensitive one that shouldn't be logged directly. Such attributes will instead be output as a hashed value.
      Returns:
      true if this attribute should be considered sensitive.
      Default:
      false