Index (Camel :: SPI Annotations 4.11.0 API)

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

AI - Enum constant in enum class org.apache.camel.Category
aliases() - Element in annotation interface org.apache.camel.spi.ApiParams: Returns the method alias(s) of this api method.
alternativeSyntax() - Element in annotation interface org.apache.camel.spi.UriEndpoint: 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
annotations() - Element in annotation interface org.apache.camel.spi.Metadata: Annotations data for Camel concepts such as components, EIP, etc.
API - Enum constant in enum class org.apache.camel.Category
ApiMethod - Annotation Interface in org.apache.camel.spi: Represents an API method as part of a parent API.
apiMethods() - Element in annotation interface org.apache.camel.spi.ApiParam: The API methods that the API provides of this configuration class.
apiMethods() - Element in annotation interface org.apache.camel.spi.ApiParams: The API methods that the API provides of this configuration class.
apiName() - Element in annotation interface org.apache.camel.spi.ApiParams: The API name (grouping) of this configuration class.
ApiParam - Annotation Interface in org.apache.camel.spi: Used for annotating a UriParam parameter that its for use by API based endpoints.
ApiParams - Annotation Interface in org.apache.camel.spi: Used to annotate a nested configuration parameter type (such as a nested Configuration object) which can then be used on a API based component, endpoint.
apiSyntax() - Element in annotation interface org.apache.camel.spi.UriEndpoint: The name of the properties that is used in the endpoint URI to select which API name (method) to use.
applicableFor() - Element in annotation interface org.apache.camel.spi.Metadata: Indicates the list of schemes for which this metadata is applicable.
AsEndpointUri - Annotation Interface in org.apache.camel.spi: Indicates that the Camel string/expression should be used as an endpoint uri.
AsPredicate - Annotation Interface in org.apache.camel.spi: Indicates that the Camel language/expression should be used as predicate.
autowired() - Element in annotation interface org.apache.camel.spi.Metadata: Whether to parameter can be configured as autowired This is used for automatic autowiring the option via its Java type, by looking up in the registry to find if there is a single instance of matching type, which then gets configured.

B

BIGDATA - Enum constant in enum class org.apache.camel.Category
BLOCKCHAIN - Enum constant in enum class org.apache.camel.Category

C

CACHE - Enum constant in enum class org.apache.camel.Category
category() - Element in annotation interface org.apache.camel.spi.UriEndpoint: To associate this endpoint with category(ies).
Category - Enum Class in org.apache.camel: This enum set various categories options into the UriEndpoint.
CHAT - Enum constant in enum class org.apache.camel.Category
CLOUD - Enum constant in enum class org.apache.camel.Category
CloudServiceFactory - Annotation Interface in org.apache.camel.spi.annotations: Deprecated.
CLUSTERING - Enum constant in enum class org.apache.camel.Category
CMS - Enum constant in enum class org.apache.camel.Category
Component - Annotation Interface in org.apache.camel.spi.annotations
ConstantProvider - Annotation Interface in org.apache.camel.spi.annotations: Internal annotation to mark a class as having constant fields for the source code generator.
consumerOnly() - Element in annotation interface org.apache.camel.spi.ApiParams: Whether this API can only be used as a consumer.
consumerOnly() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Whether this endpoint can only be used as a consumer.
consumerPrefix() - Element in annotation interface org.apache.camel.spi.UriEndpoint: The configuration parameter name prefix used on parameter names to separate the endpoint properties from the consumer properties
CONTAINER - Enum constant in enum class org.apache.camel.Category
CORE - Enum constant in enum class org.apache.camel.Category

D

DATABASE - Enum constant in enum class org.apache.camel.Category
Dataformat - Annotation Interface in org.apache.camel.spi.annotations
defaultValue() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
defaultValue() - Element in annotation interface org.apache.camel.spi.Metadata: To define a default value.
defaultValue() - Element in annotation interface org.apache.camel.spi.UriParam: The default value of the parameter.
defaultValue() - Element in annotation interface org.apache.camel.spi.UriPath: The default value of the parameter.
defaultValueNote() - Element in annotation interface org.apache.camel.spi.UriParam: A special note about the default value.
defaultValueNote() - Element in annotation interface org.apache.camel.spi.UriPath: A special note about the default value.
deprecated() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
deprecated() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
deprecationNote() - Element in annotation interface org.apache.camel.spi.Metadata: Additional description that can explain the user about the deprecation and give reference to what to use instead.
description() - Element in annotation interface org.apache.camel.spi.annotations.DevConsole: Description of the console
description() - Element in annotation interface org.apache.camel.spi.annotations.InfraService: Returns a description of this Service.
description() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
description() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
description() - Element in annotation interface org.apache.camel.spi.ApiMethod: Returns a description of this api method or api parameter.
description() - Element in annotation interface org.apache.camel.spi.ApiParam: Returns a description of this parameter.
description() - Element in annotation interface org.apache.camel.spi.ApiParams: Returns a description of the API.
description() - Element in annotation interface org.apache.camel.spi.Metadata: Returns a description of this entity.
description() - Element in annotation interface org.apache.camel.spi.UriParam: Returns a description of this parameter.
description() - Element in annotation interface org.apache.camel.spi.UriPath: Returns a description of this uri path This is used for documentation and tooling only.
DevConsole - Annotation Interface in org.apache.camel.spi.annotations: Marks a class as a custom developer console.
displayName() - Element in annotation interface org.apache.camel.spi.annotations.DevConsole: Display name (title)
displayName() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
displayName() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
displayName() - Element in annotation interface org.apache.camel.spi.Metadata: A human display name of the parameter.
displayName() - Element in annotation interface org.apache.camel.spi.UriParam: A human display name of the parameter.
displayName() - Element in annotation interface org.apache.camel.spi.UriPath: A human display name of the parameter.
DOCUMENT - Enum constant in enum class org.apache.camel.Category
documentElement() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: In JAXB, when an element is annotated with @XmlAnyElement, the actual objects used are of Element class.
documentElement2() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: In JAXB, when an element is annotated with @XmlAnyElement, the actual objects used are of Element class.
DslProperty - Annotation Interface in org.apache.camel.spi.annotations: Internal annotation used to include fields otherwise excluded because annotate with XmlTransient.

E

enums() - Element in annotation interface org.apache.camel.spi.Metadata: Allows to define enums this options accepts.
enums() - Element in annotation interface org.apache.camel.spi.UriParam: Allows to define enums this options accepts.
enums() - Element in annotation interface org.apache.camel.spi.UriPath: Allows to define enums this options accepts.
excludeProperties() - Element in annotation interface org.apache.camel.spi.Metadata: To exclude one or more properties.
extendsScheme() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Used when an endpoint is extending another endpoint Multiple scheme names can be defined as a comma separated value.
ExternalSchemaElement - Annotation Interface in org.apache.camel.spi.annotations: Annotation to be used for JAXB property (field or method) annotated with @XmlAnyElement to highlight which actual elements do we expect (not to be enforced by JAXB, but by Camel itself).

F

FILE - Enum constant in enum class org.apache.camel.Category
firstVersion() - Element in annotation interface org.apache.camel.spi.Metadata: The first version this functionality was added to Apache Camel.
firstVersion() - Element in annotation interface org.apache.camel.spi.UriEndpoint: The first version this endpoint was added to Apache Camel.
format() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
functionsClass() - Element in annotation interface org.apache.camel.spi.annotations.Language: The class that contains all the name of functions that are supported by the language.

G

generateConfigurer() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Generates source code for fast configuring of the endpoint properties which uses direct method invocation of getter/setters.
getValue() - Method in enum class org.apache.camel.Category: Returns the string representation of this value
group() - Element in annotation interface org.apache.camel.spi.annotations.DevConsole: The group of the dev console

H

headersClass() - Element in annotation interface org.apache.camel.spi.UriEndpoint: The class that contains all the name of headers that are supported by the consumer and/or producer.
headersNameProvider() - Element in annotation interface org.apache.camel.spi.UriEndpoint: The name of the field to get or the name of the method without parameters to invoke to get the name of the headers defined in an enum.
HEALTH - Enum constant in enum class org.apache.camel.Category
HealthCheck - Annotation Interface in org.apache.camel.spi.annotations: Marks a class as a custom health-check or health-check repository.
HTTP - Enum constant in enum class org.apache.camel.Category

I

includeProperties() - Element in annotation interface org.apache.camel.spi.Metadata: To include one or more properties.
InfraService - Annotation Interface in org.apache.camel.spi.annotations: Marks a class as a Service that can be used by Camel JBang infra The marked class is analyzed by the mojo CamelTestInfraGenerateMetadataMojo
inline() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
inputLanguage() - Element in annotation interface org.apache.camel.spi.Metadata: If the option is some specific language such as SQL, XSLT, XML, JavaScript or something else.
IOT - Enum constant in enum class org.apache.camel.Category

J

javaType() - Element in annotation interface org.apache.camel.spi.Metadata: To re-associate the preferred Java type of this parameter.
javaType() - Element in annotation interface org.apache.camel.spi.UriParam: To re-associate the preferred Java type of this parameter.
javaType() - Element in annotation interface org.apache.camel.spi.UriPath: To re-associate the preferred Java type of this parameter.
JDK_SERVICE - Static variable in annotation interface org.apache.camel.spi.annotations.ServiceFactory
JdkService - Annotation Interface in org.apache.camel.spi.annotations

L

label() - Element in annotation interface org.apache.camel.spi.Metadata: To define one or more labels.
label() - Element in annotation interface org.apache.camel.spi.UriParam: To associate this parameter with label(s).
label() - Element in annotation interface org.apache.camel.spi.UriPath: To associate this path value with label(s).
Language - Annotation Interface in org.apache.camel.spi.annotations
largeInput() - Element in annotation interface org.apache.camel.spi.Metadata: Whether the option can be large input such as a SQL query, XSLT template, or scripting code.
lenientProperties() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Should all properties be known or does the endpoint allow unknown options?

M

MAIL - Enum constant in enum class org.apache.camel.Category
MANAGEMENT - Enum constant in enum class org.apache.camel.Category
MESSAGING - Enum constant in enum class org.apache.camel.Category
Metadata - Annotation Interface in org.apache.camel.spi: Meta data for EIPs, components, data formats and other Camel concepts For example to associate labels to Camel components
methodName() - Element in annotation interface org.apache.camel.spi.ApiMethod: The name of the api method.
MOBILE - Enum constant in enum class org.apache.camel.Category
MONITORING - Enum constant in enum class org.apache.camel.Category
multiValue() - Element in annotation interface org.apache.camel.spi.UriParam: If the parameter can be configured multiple times, such as configuring options to a Map type.

N

name() - Element in annotation interface org.apache.camel.spi.annotations.DevConsole: The ID of the dev console.
name() - Element in annotation interface org.apache.camel.spi.annotations.DslProperty
name() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
name() - Element in annotation interface org.apache.camel.spi.UriParam: Returns the name of the parameter.
name() - Element in annotation interface org.apache.camel.spi.UriPath: Returns the name of the uri path.
names() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: Names of external XML element we expect
names2() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: Names of external XML element we expect
namespace() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: XSD namespace of XML elements expected
namespace2() - Element in annotation interface org.apache.camel.spi.annotations.ExternalSchemaElement: XSD namespace of XML elements expected
NETWORKING - Enum constant in enum class org.apache.camel.Category
nodes() - Element in annotation interface org.apache.camel.spi.annotations.YamlType

O

oneOf() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
optional() - Element in annotation interface org.apache.camel.spi.ApiParam: Whether the parameter is optional (in some rare circumstances the parameter may be required)
optionalPrefix() - Element in annotation interface org.apache.camel.spi.UriParam: If the parameter can be configured with an optional prefix.
order() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
org.apache.camel - package org.apache.camel
org.apache.camel.spi - package org.apache.camel.spi
org.apache.camel.spi.annotations - package org.apache.camel.spi.annotations: SPI annotations for plugins

P

PeriodicTask - Annotation Interface in org.apache.camel.spi.annotations
PollDynamic - Annotation Interface in org.apache.camel.spi.annotations
prefix() - Element in annotation interface org.apache.camel.spi.UriParam: If the parameter must be configured with a prefix.
prefix() - Element in annotation interface org.apache.camel.spi.UriParams: Returns the prefix used to access nested properties of this configuration object
producerOnly() - Element in annotation interface org.apache.camel.spi.ApiParams: Whether this API can only be used as a producer.
producerOnly() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Whether this endpoint can only be used as a producer.
properties() - Element in annotation interface org.apache.camel.spi.annotations.YamlType
PropertiesFunction - Annotation Interface in org.apache.camel.spi.annotations

R

remote() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Whether the component does remote communication such as connecting to an external system over the network.
required() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
required() - Element in annotation interface org.apache.camel.spi.Metadata: To define that this entity is required.
ResourceResolver - Annotation Interface in org.apache.camel.spi.annotations
REST - Enum constant in enum class org.apache.camel.Category
RoutesLoader - Annotation Interface in org.apache.camel.spi.annotations
RPC - Enum constant in enum class org.apache.camel.Category

S

SAAS - Enum constant in enum class org.apache.camel.Category
SCHEDULING - Enum constant in enum class org.apache.camel.Category
scheme() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Represents the URI scheme name of this endpoint.
SCRIPT - Enum constant in enum class org.apache.camel.Category
SEARCH - Enum constant in enum class org.apache.camel.Category
secret() - Element in annotation interface org.apache.camel.spi.Metadata: Whether the option is secret/sensitive information such as a password.
secret() - Element in annotation interface org.apache.camel.spi.UriParam: Whether the option is secret/sensitive information such as a password.
secret() - Element in annotation interface org.apache.camel.spi.UriPath: Whether the option is secret/sensitive information such as a password.
SECURITY - Enum constant in enum class org.apache.camel.Category
SendDynamic - Annotation Interface in org.apache.camel.spi.annotations
SERVERLESS - Enum constant in enum class org.apache.camel.Category
service() - Element in annotation interface org.apache.camel.spi.annotations.InfraService: Interface that extends InfrastructureService the interface is used by Camel JBang infra run to retrieve testing information like port, endpoint, username...
serviceAlias() - Element in annotation interface org.apache.camel.spi.annotations.InfraService: List of names that can be used to run the service
ServiceFactory - Annotation Interface in org.apache.camel.spi.annotations
serviceImplementationAlias() - Element in annotation interface org.apache.camel.spi.annotations.InfraService: Additional and optional Service name, in case of multiple Service implementations For example kafka has 3 implementations kafka - uses apache/kafka image as implementation kafka redpanda - uses redpandadata/redpanda image as implementation kafka strimzi - uses strimzi/kafka as image implementation
signatures() - Element in annotation interface org.apache.camel.spi.ApiMethod: Returns the method signature(s) of this api method.
skip() - Element in annotation interface org.apache.camel.spi.Metadata: Whether to skip this option
SOCIAL - Enum constant in enum class org.apache.camel.Category
supportFileReference() - Element in annotation interface org.apache.camel.spi.Metadata: Whether the option can refer to a file by using file: or classpath: as prefix and specify the location of the file.
syntax() - Element in annotation interface org.apache.camel.spi.UriEndpoint: Represent the URI syntax the endpoint must use.

T

TESTING - Enum constant in enum class org.apache.camel.Category
title() - Element in annotation interface org.apache.camel.spi.Metadata: An optional human readable title of this entity, to be used instead of a computed title.
title() - Element in annotation interface org.apache.camel.spi.UriEndpoint: A human-readable title of this entity, such as the component name of the this endpoint.
Tokenizer - Annotation Interface in org.apache.camel.spi.annotations
TRANSFORMATION - Enum constant in enum class org.apache.camel.Category
type() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty
types() - Element in annotation interface org.apache.camel.spi.annotations.YamlType

U

UriEndpoint - Annotation Interface in org.apache.camel.spi: 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
UriParam - Annotation Interface in org.apache.camel.spi: 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
UriParams - Annotation Interface in org.apache.camel.spi: Used to annotate a nested configuration parameter type (such as a nested Configuration object) which can then be used on a Component, Endpoint and/or Consumer and then be configured via Camel URI query arguments.
UriPath - Annotation Interface in org.apache.camel.spi: Represents an injection point of a Camel Uri path value (the remaining part of a Camel URI without any query arguments)

V

VALIDATION - Enum constant in enum class org.apache.camel.Category
value() - Element in annotation interface org.apache.camel.spi.annotations.CloudServiceFactory: Deprecated.
value() - Element in annotation interface org.apache.camel.spi.annotations.Component
value() - Element in annotation interface org.apache.camel.spi.annotations.ConstantProvider
value() - Element in annotation interface org.apache.camel.spi.annotations.Dataformat
value() - Element in annotation interface org.apache.camel.spi.annotations.HealthCheck: The ID of the health check.
value() - Element in annotation interface org.apache.camel.spi.annotations.JdkService
value() - Element in annotation interface org.apache.camel.spi.annotations.Language
value() - Element in annotation interface org.apache.camel.spi.annotations.PeriodicTask
value() - Element in annotation interface org.apache.camel.spi.annotations.PollDynamic
value() - Element in annotation interface org.apache.camel.spi.annotations.PropertiesFunction
value() - Element in annotation interface org.apache.camel.spi.annotations.ResourceResolver
value() - Element in annotation interface org.apache.camel.spi.annotations.RoutesLoader
value() - Element in annotation interface org.apache.camel.spi.annotations.SendDynamic
value() - Element in annotation interface org.apache.camel.spi.annotations.ServiceFactory
value() - Element in annotation interface org.apache.camel.spi.annotations.Tokenizer
valueOf(String) - Static method in enum class org.apache.camel.Category: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.camel.Category: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty

W

WEBSERVICE - Enum constant in enum class org.apache.camel.Category
WORKFLOW - Enum constant in enum class org.apache.camel.Category
wrapItem() - Element in annotation interface org.apache.camel.spi.annotations.YamlProperty

Y

YamlIn - Annotation Interface in org.apache.camel.spi.annotations
YamlOut - Annotation Interface in org.apache.camel.spi.annotations
YamlProperty - Annotation Interface in org.apache.camel.spi.annotations
YamlType - Annotation Interface in org.apache.camel.spi.annotations

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values