Package org.apache.camel.spi
Annotation 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
Modifier and TypeOptional ElementDescriptionThe default value of the parameter.A special note about the default value.Returns a description of this uri pathA human display name of the parameter.Allows to define enums this options accepts.To re-associate the preferred Java type of this parameter.To associate this path value with label(s).Returns the name of the uri path.boolean
Whether the option is secret/sensitive information such as a password.
-
Element Details
-
name
String nameReturns 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 displayNameA human display name of the parameter. This is used for documentation and tooling only.- Default:
""
-
defaultValue
String defaultValueThe 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 defaultValueNoteA special note about the default value. This can be used to document special cases about the default value.- Default:
""
-
description
String descriptionReturns a description of this uri path This is used for documentation and tooling only.- Default:
""
-
enums
String enumsAllows 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 labelTo associate this path value 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 secretWhether the option is secret/sensitive information such as a password.- Default:
false
-
javaType
String javaTypeTo 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:
""
-