@Retention(value=RUNTIME) @Documented @Target(value=TYPE) public @interface UriEndpoint
Modifier and Type | Required Element and 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.
|
Modifier and Type | Optional Element and 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:port
|
Category[] |
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 properties
|
String |
extendsScheme
Used when an endpoint is extending another endpoint
Multiple scheme names can be defined as a comma separated value.
|
String |
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?
lenient = false means that the endpoint should validate that all
given options is known and configured properly.
|
boolean |
producerOnly
Whether this endpoint can only be used as a producer.
|
public abstract String scheme
extendsScheme()
so their are paired.
The schema name must be lowercase, it may contain dashes as well. For example: robot-framework.public abstract String syntax
UriPath
option.
The query parameters is implied and should not be included in the syntax.
Some examples:
public abstract String title
public abstract String firstVersion
public abstract String extendsScheme
scheme()
so their are paired.public abstract String alternativeSyntax
@Deprecated public abstract Class<?> consumerClass
public abstract String consumerPrefix
@Deprecated public abstract String label
public abstract Category[] category
Category
enums.
For example: @UriEndpoint(category = {Category.CORE, Category.DATABASE})public abstract boolean producerOnly
public abstract boolean consumerOnly
public abstract boolean lenientProperties
public abstract boolean generateConfigurer
Apache Camel