| // kafka-connector options: START |
| [[camel-rest-kafka-connector-source]] |
| = camel-rest-kafka-connector source configuration |
| |
| When using camel-rest-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-rest-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-rest source connector supports 18 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.method* | HTTP method to use. One of: [get] [post] [put] [delete] [patch] [head] [trace] [connect] [options] | null | ConfigDef.Importance.HIGH |
| | *camel.source.path.path* | The base path | null | ConfigDef.Importance.HIGH |
| | *camel.source.path.uriTemplate* | The uri template | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumes* | Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.inType* | To declare the incoming POJO binding type as a FQN class name | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.outType* | To declare the outgoing POJO binding type as a FQN class name | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.produces* | Media type such as: 'text/xml', or 'application/json' this REST service returns. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.routeId* | Name of the route this REST services creates | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumer ComponentName* | The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.description* | Human description to document this REST service | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rest.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rest.consumer ComponentName* | The Camel Rest component to use for (consumer) the REST transport, such as jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rest.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
