Annotation Interface UriPath

@Retention(RUNTIME) @Documented @Target(FIELD) public @interface UriPath
Represents an injection point of a Camel Uri path value (the remaining part of a Camel URI without any query arguments)

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    The default value of the path.
    String
    defaultValueNote
    A special note about the default value of the path.
    String
    description
    Returns a description of this uri path This is used for documentation and tooling only.
    String
    displayName
    A human display name of the path.
    String
    enums
    Allows to define enums this path option accepts.
    String
    insecureValue
    The value that makes this path option insecure.
    String
    javaType
    To re-associate the preferred Java type of this parameter.
    String
    label
    To associate this path value with label(s).
    String
    name
    Returns the name of the uri path.
    boolean
    secret
    Deprecated.
    use security = "secret" instead.
    String
    security
    Security category for this path option.

  • Element Details

    • name

      String name
      Returns the name of the uri path. This can be used to name the uri path something meaningful, such as a directory, queueName etc. If this is not specified then the name of the field or property which has this annotation is used.
      Default:
      ""

    • displayName

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

    • defaultValue

      String defaultValue
      The default value of the path. Note that this attribute is only for documentation purpose. The default value in use at runtime is the value the Java field was assigned.
      Default:
      ""

    • defaultValueNote

      String defaultValueNote
      A special note about the default value of the path. This can be used to document special cases about the default value of the path.
      Default:
      ""

    • description

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

    • 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:
      ""

    • enums

      String enums
      Allows to define enums this path option 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:
      ""

    • label

      String label
      To associate this path value with label(s). Multiple labels can be defined as a comma separated value. The labels is intended for grouping the path options, such as consumer, producer, common, security, etc.
      Default:
      ""

    • secret

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

    • security

      String security
      Security category for this path option.
      See Also:
      Default:
      ""

    • insecureValue

      String insecureValue
      The value that makes this path option insecure.
      See Also:
      Default:
      ""