Package org.apache.camel.spi
Annotation Type UriEndpoint
-
@Retention(RUNTIME) @Documented @Target(TYPE) public @interface UriEndpoint
Represents an annotated Camel Endpoint which can have its properties (and the properties on its consumer) injected from the Camel URI path and its query parameters
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description String
scheme
Represents the URI scheme name of this endpoint.String
syntax
Represent the URI syntax the endpoint must use.String
title
A human readable title of this entity, such as the component name of the this endpoint.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
alternativeSyntax
If the endpoint supports specifying username and/or password in the UserInfo part of the URI, then the alternative syntax can represent this such as: ftp:userName:password@host:port/directoryName ssh:username:password@host:portCategory[]
category
To associate this endpoint with category(ies).Class<?>
consumerClass
Deprecated.boolean
consumerOnly
Whether this endpoint can only be used as a consumer.String
consumerPrefix
The configuration parameter name prefix used on parameter names to separate the endpoint properties from the consumer propertiesString
extendsScheme
Used when an endpoint is extending another endpointString
firstVersion
The first version this endpoint was added to Apache Camel.boolean
generateConfigurer
Generates source code for fast configuring of the endpoint properties which uses direct method invocation of getter/setters.String
label
Deprecated.boolean
lenientProperties
Should all properties be known or does the endpoint allow unknown options?boolean
producerOnly
Whether this endpoint can only be used as a producer.
-
-
-
Element Detail
-
scheme
String scheme
Represents the URI scheme name of this endpoint. Multiple scheme names can be defined as a comma separated value. For example to associate http and https to the same endpoint implementation. The order of the scheme names here should be the same order as inextendsScheme()
so their are paired. The schema name must be lowercase, it may contain dashes as well. For example: robot-framework.
-
-
-
syntax
String syntax
Represent the URI syntax the endpoint must use. The syntax follows the patterns such as:- scheme:host:port
- scheme:host:port/path
- scheme:path
- scheme:path/path2
UriPath
option. The query parameters is implied and should not be included in the syntax. Some examples:- file:directoryName
- ftp:host:port/directoryName
- jms:destinationType:destinationName
-
-
-
title
String title
A human readable title of this entity, such as the component name of the this endpoint. For example: JMS, MQTT, Netty HTTP, SAP NetWeaver
-
-
-
firstVersion
String firstVersion
The first version this endpoint was added to Apache Camel.- Default:
- ""
-
-
-
extendsScheme
String extendsScheme
Used when an endpoint is extending another endpoint Multiple scheme names can be defined as a comma separated value. For example to associate ftp and ftps to the same endpoint implementation. The order of the scheme names here should be the same order as inscheme()
so their are paired.- Default:
- ""
-
-
-
alternativeSyntax
String alternativeSyntax
If the endpoint supports specifying username and/or password in the UserInfo part of the URI, then the alternative syntax can represent this such as:- ftp:userName:password@host:port/directoryName
- ssh:username:password@host:port
- Default:
- ""
-
-
-
consumerClass
@Deprecated Class<?> consumerClass
Deprecated.Represents the consumer class which is injected and created by consumers- Default:
- java.lang.Object.class
-
-
-
consumerPrefix
String consumerPrefix
The configuration parameter name prefix used on parameter names to separate the endpoint properties from the consumer properties- Default:
- ""
-
-
-
label
@Deprecated String label
Deprecated.To associate this endpoint with label(s). Multiple labels can be defined as a comma separated value. The labels is intended for grouping the endpoints, such as core, file, messaging, database, etc. Deprecated: Use the category field instead- Default:
- ""
-
-
-
category
Category[] category
To associate this endpoint with category(ies). This category is intended for grouping the endpoints, such as Category.CORE, Category.FILE, Category.DATABASE, etc, but supplied with as array ofCategory
enums. For example: @UriEndpoint(category = {Category.CORE, Category.DATABASE})- Default:
- {}
-
-
-
lenientProperties
boolean lenientProperties
Should all properties be known or does the endpoint allow unknown options? lenient = false means that the endpoint should validate that all given options is known and configured properly. lenient = true means that the endpoint allows additional unknown options to be passed to it but does not throw a ResolveEndpointFailedException when creating the endpoint. This options is used by a few components for instance the HTTP based that can have dynamic URI options appended that is targeted for an external system. Most endpoints is configured to be not lenient.- Default:
- false
-
-