Annotation Interface Metadata

@Retention(RUNTIME) @Documented @Target({TYPE,METHOD,FIELD}) public @interface Metadata
Meta data for EIPs, components, data formats and other Camel concepts For example to associate labels to Camel components

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    aliases
    Alternative names or common aliases for this entity.
    String[]
    annotations
    Annotations data for Camel concepts such as components, EIP, etc.
    String[]
    applicableFor
    Indicates the list of schemes for which this metadata is applicable.
    boolean
    autowired
    Whether to parameter can be configured as autowired This is used for automatic autowiring the option via its Java type, by looking up in the registry to find if there is a single instance of matching type, which then gets configured.
    String
    defaultValue
    To define a default value.
    String
    deprecationNote
    Additional description that can explain the user about the deprecation and give reference to what to use instead.
    String
    description
    Returns a description of this entity.
    String
    displayName
    A human display name of the parameter.
    String
    enums
    Allows to define enums this options accepts.
    String[]
    examples
    Usage examples for documentation and AI tooling.
    String
    excludeProperties
    To exclude one or more properties.
    String
    firstVersion
    The first version this functionality was added to Apache Camel.
    boolean
    important
    Whether this option is important
    String
    includeProperties
    To include one or more properties.
    String
    inputLanguage
    If the option is some specific language such as SQL, XSLT, XML, JavaScript or something else.
    String
    insecureValue
    The value that makes this option insecure.
    String
    javaType
    To re-associate the preferred Java type of this parameter.
    String
    label
    To define one or more labels.
    boolean
    largeInput
    Whether the option can be large input such as a SQL query, XSLT template, or scripting code.
    boolean
    required
    To define that this entity is required.
    boolean
    secret
    Deprecated.
    use security = "secret" instead.
    String
    security
    Security category for this option.
    boolean
    skip
    Whether to skip this option
    boolean
    supportFileReference
    Whether the option can refer to a file by using file: or classpath: as prefix and specify the location of the file.
    String
    title
    An optional human readable title of this entity, to be used instead of a computed title.

  • Element Details

    • displayName

      String displayName
      A human display name of the parameter. This is used for documentation and tooling only.
      Default:
      ""

    • label

      String label
      To define one or more labels. Multiple labels can be defined as a comma separated value.
      Default:
      ""

    • defaultValue

      String defaultValue
      To define a default value.
      Default:
      ""

    • required

      boolean required
      To define that this entity is required.
      Default:
      false

    • title

      String title
      An optional human readable title of this entity, to be used instead of a computed title.
      Default:
      ""

    • description

      String description
      Returns a description of this entity. This is used for documentation and tooling only.
      Default:
      ""

    • enums

      String enums
      Allows to define enums this options accepts. If the type is already an enum, then this option should not be used; instead you can use this option when the type is a String that only accept certain values. Multiple values is separated by comma.
      Default:
      ""

    • secret

      @Deprecated(since="4.19.0") boolean secret
      Deprecated.
      use security = "secret" instead.
      Whether the option is secret/sensitive information such as a password.
      Default:
      false

    • security

      String security
      Security category for this option.

      Supported categories:

      • secret — the value is sensitive (password, token, etc.) and should not be stored in plain text
      • insecure:ssl — disables SSL/TLS certificate validation or hostname verification
      • insecure:serialization — enables dangerous deserialization of untrusted data
      • insecure:dev — development-only feature not safe for production use

      When set, the Camel security policy (camel.security.*) can warn or prevent startup depending on the configured policy for that category.

      Default:
      ""

    • insecureValue

      String insecureValue
      The value that makes this option insecure. Only used when security() is set to an insecure:* category.

      For boolean options, this defaults to "true" (i.e., enabling the option is insecure). Set to "false" for options where disabling the feature is insecure (e.g., validateCertificates=false).

      Default:
      ""

    • autowired

      boolean autowired
      Whether to parameter can be configured as autowired This is used for automatic autowiring the option via its Java type, by looking up in the registry to find if there is a single instance of matching type, which then gets configured. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. This is only supported on components, data formats, languages, etc; not on endpoints.
      Default:
      false

    • javaType

      String javaType
      To re-associate the preferred Java type of this parameter. This is used for parameters which are of a specialized type but can be configured by another Java type, such as from a String.
      Default:
      ""

    • firstVersion

      String firstVersion
      The first version this functionality was added to Apache Camel.
      Default:
      ""

    • deprecationNote

      String deprecationNote
      Additional description that can explain the user about the deprecation and give reference to what to use instead.
      Default:
      ""

    • skip

      boolean skip
      Whether to skip this option
      Default:
      false

    • excludeProperties

      String excludeProperties
      To exclude one or more properties. This is for example used when a Camel component extend another component, and then may need to not use some of the properties from the parent component. Multiple properties can be separated by comma.
      Default:
      ""

    • includeProperties

      String includeProperties
      To include one or more properties. Some dataformats share same base but individually they have some specific options, then this can be used to specify which options each implementation only supports.
      Default:
      ""

    • applicableFor

      String[] applicableFor
      Indicates the list of schemes for which this metadata is applicable. This is used to filter out message headers that are shared with several endpoints but only applicable for some of them. In the next example, the header SOME_HEADER is only applicable for endpoints whose scheme is "foo" or "bar". 
      

@Metadata(description = "some description", javaType = "String", applicableFor = {"foo", "bar"})
public static final String SOME_HEADER = "someHeaderName";
      Default:
      {}

    • supportFileReference

      boolean supportFileReference
      Whether the option can refer to a file by using file: or classpath: as prefix and specify the location of the file.
      Default:
      false

    • largeInput

      boolean largeInput
      Whether the option can be large input such as a SQL query, XSLT template, or scripting code. This can be used to help tooling to provide an input form instead of a single input field to give better user experience.
      Default:
      false

    • inputLanguage

      String inputLanguage
      If the option is some specific language such as SQL, XSLT, XML, JavaScript or something else. This can be used to help tooling to provide a better user experience.
      Default:
      ""

    • annotations

      String[] annotations
      Annotations data for Camel concepts such as components, EIP, etc.
      Default:
      {}

    • important

      boolean important
      Whether this option is important
      Default:
      false

    • examples

      String[] examples
      Usage examples for documentation and AI tooling. Each entry is a compact expression and result pair such as "${abs(-5)} -> 5".
      Default:
      {}

    • aliases

      String[] aliases
      Alternative names or common aliases for this entity. Used for AI and search tooling to discover EIPs by common terminology (e.g., "fan-out" for Multicast, "retry" for Error Handler). Aliases are descriptive names only — they cannot be used in the DSL.
      Default:
      {}