camel-weather-kafka-connector sink configuration

When using camel-weather-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-weather-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.weather.CamelWeatherSinkConnector

The camel-weather sink connector supports 26 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.name

The name value is not used.

null

true

HIGH

camel.sink.endpoint.appid

APPID ID used to authenticate the user connected to the API Server

null

true

HIGH

camel.sink.endpoint.headerName

To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is.

null

false

MEDIUM

camel.sink.endpoint.language

Language of the response. One of: [en] [ru] [it] [es] [sp] [uk] [ua] [de] [pt] [ro] [pl] [fi] [nl] [fr] [bg] [sv] [se] [zh_tw] [zh] [zh_cn] [tr] [hr] [ca]

"en"

false

MEDIUM

camel.sink.endpoint.mode

The output format of the weather data. One of: [HTML] [JSON] [XML]

"JSON"

false

MEDIUM

camel.sink.endpoint.period

If null, the current weather will be returned, else use values of 5, 7, 14 days. Only the numeric value for the forecast period is actually parsed, so spelling, capitalisation of the time period is up to you (its ignored)

null

false

MEDIUM

camel.sink.endpoint.units

The units for temperature measurement. One of: [IMPERIAL] [METRIC]

null

false

MEDIUM

camel.sink.endpoint.weatherApi

The API to use (current, forecast/3 hour, forecast daily, station) One of: [Current] [Station] [Hourly] [Daily]

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

false

MEDIUM

camel.sink.endpoint.geoLocationProvider

A custum geolocation provider to determine the longitude and latitude to use when no location information is set. The default implementaion uses the ipstack API and requires geolocationAccessKey and geolocationRequestHostIP

null

false

MEDIUM

camel.sink.endpoint.httpClient

To use an existing configured http client (for example with http proxy)

null

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

false

MEDIUM

camel.sink.endpoint.cnt

Number of results to be found

null

false

MEDIUM

camel.sink.endpoint.ids

List of id’s of city/stations. You can separate multiple ids by comma.

null

false

MEDIUM

camel.sink.endpoint.lat

Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude.

null

false

MEDIUM

camel.sink.endpoint.location

If null Camel will try and determine your current location using the geolocation of your ip address, else specify the city,country. For well known city names, Open Weather Map will determine the best fit, but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location.

null

false

MEDIUM

camel.sink.endpoint.lon

Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude.

null

false

MEDIUM

camel.sink.endpoint.rightLon

For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom.

null

false

MEDIUM

camel.sink.endpoint.topLat

For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom.

null

false

MEDIUM

camel.sink.endpoint.zip

Zip-code, e.g. 94040,us

null

false

MEDIUM

camel.sink.endpoint.zoom

For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat.

null

false

MEDIUM

camel.sink.endpoint.geolocationAccessKey

The geolocation service now needs an accessKey to be used

null

true

HIGH

camel.sink.endpoint.geolocationRequestHostIP

The geolocation service now needs to specify the IP associated to the accessKey you’re using

null

true

HIGH

camel.component.weather.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

false

MEDIUM

camel.component.weather.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

false

LOW

The camel-weather sink connector has no converters out of the box.

The camel-weather sink connector has no transforms out of the box.

The camel-weather sink connector has no aggregation strategies out of the box.