Package org.apache.camel.spi

Annotation Type UriParam

  • @Retention(RUNTIME)
@Documented
@Target(FIELD)
public @interface UriParam
    Represents an injection point of a Camel Uri parameter value on an Endpoint or Consumer, usually configured via a URI style query parameter in a URI

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultValue
      The default value of the parameter.
      String defaultValueNote
      A special note about the default value.
      String description
      Returns a description of this parameter.
      String displayName
      A human display name of the parameter.
      String enums
      Allows to define enums this options accepts.
      String javaType
      To re-associate the preferred Java type of this parameter.
      String label
      To associate this parameter with label(s).
      boolean multiValue
      If the parameter can be configured multiple times, such as configuring options to a Map type.
      String name
      Returns the name of the parameter.
      String optionalPrefix
      If the parameter can be configured with an optional prefix.
      String prefix
      If the parameter must be configured with a prefix.
      boolean secret
      Whether the option is secret/sensitive information such as a password.

    • Element Detail

      • name

        String name
        Returns the name of the parameter.

        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 parameter.

        This is used for documentation and tooling only.

        Default:
        ""

      • defaultValue

        String defaultValue
        The default value of the parameter.

        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.

        This can be used to document special cases about the default value.

        Default:
        ""

      • description

        String description
        Returns a description of this parameter.

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

      • label

        String label
        To associate this parameter with label(s).

        Multiple labels can be defined as a comma separated value.

        The labels is intended for grouping the parameters, such as consumer, producer, common, security, etc.

        Default:
        ""

      • secret

        boolean secret
        Whether the option is secret/sensitive information such as a password.
        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:
        ""

      • multiValue

        boolean multiValue
        If the parameter can be configured multiple times, such as configuring options to a Map type.
        Default:
        false

      • prefix

        String prefix
        If the parameter must be configured with a prefix.

        For example to configure scheduler options, the parameters is prefixed with scheduler.foo=bar

        Default:
        ""

      • optionalPrefix

        String optionalPrefix
        If the parameter can be configured with an optional prefix.

        For example to configure consumer options, the parameters can be prefixed with consumer., eg consumer.delay=5000

        Default:
        ""