Polls the weather information from Open Weather Map.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| name | path | common | true | java.lang.String | The name value is not used. | ||
| appid | parameter | common | true | java.lang.String | APPID ID used to authenticate the user connected to the API Server | ||
| headerName | parameter | common | java.lang.String | 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. | |||
| language | parameter | common | en | org.apache.camel.component.weather.WeatherLanguage | 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 |
Language of the response. | |
| mode | parameter | common | JSON | org.apache.camel.component.weather.WeatherMode | HTML JSON XML |
The output format of the weather data. | |
| period | parameter | common | java.lang.String | 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) | |||
| units | parameter | common | org.apache.camel.component.weather.WeatherUnits | IMPERIAL METRIC |
The units for temperature measurement. | ||
| weatherApi | parameter | common | org.apache.camel.component.weather.WeatherApi | Current Station Hourly Daily |
The API to be use (current, forecast/3 hour, forecast daily, station) | ||
| bridgeErrorHandler | parameter | consumer | boolean | 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/ERROR level and ignored. | |||
| sendEmptyMessageWhenIdle | parameter | consumer | boolean | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| pollStrategy | parameter | consumer (advanced) | org.apache.camel.spi.PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | |||
| httpConnectionManager | parameter | advanced | org.apache.commons.httpclient.HttpConnectionManager | To use a custom HttpConnectionManager to manage connections | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| backoffErrorThreshold | parameter | scheduler | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
| backoffIdleThreshold | parameter | scheduler | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
| backoffMultiplier | parameter | scheduler | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |||
| delay | parameter | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | ||
| greedy | parameter | scheduler | boolean | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
| initialDelay | parameter | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | ||
| runLoggingLevel | parameter | scheduler | TRACE | org.apache.camel.LoggingLevel | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
| scheduledExecutorService | parameter | scheduler | java.util.concurrent.ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
| scheduler | parameter | scheduler | none | org.apache.camel.spi.ScheduledPollConsumerScheduler | none spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | |
| schedulerProperties | parameter | scheduler | java.util.Map |
To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
| startScheduler | parameter | scheduler | true | boolean | Whether the scheduler should be auto started. | ||
| timeUnit | parameter | scheduler | MILLISECONDS | java.util.concurrent.TimeUnit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
| useFixedDelay | parameter | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | ||
| cnt | parameter | filter | java.lang.Integer | Number of results to be found | |||
| ids | parameter | filter | java.lang.String | List of id's of city/stations. You can separate multiple ids by comma. | |||
| lat | parameter | filter | java.lang.String | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. | |||
| location | parameter | filter | java.lang.String | 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. | |||
| lon | parameter | filter | java.lang.String | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. | |||
| rightLon | parameter | filter | java.lang.String | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. | |||
| topLat | parameter | filter | java.lang.String | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. | |||
| zip | parameter | filter | java.lang.String | Zip-code, e.g. 94040,us | |||
| zoom | parameter | filter | java.lang.Integer | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. | |||
| proxyAuthDomain | parameter | proxy | java.lang.String | Domain for proxy NTLM authentication | |||
| proxyAuthHost | parameter | proxy | java.lang.String | Optional host for proxy NTLM authentication | |||
| proxyAuthMethod | parameter | proxy | java.lang.String | Authentication method for proxy, either as Basic, Digest or NTLM. | |||
| proxyAuthPassword | parameter | proxy | java.lang.String | Password for proxy authentication | |||
| proxyAuthUsername | parameter | proxy | java.lang.String | Username for proxy authentication | |||
| proxyHost | parameter | proxy | java.lang.String | The proxy host name | |||
| proxyPort | parameter | proxy | java.lang.Integer | The proxy port number |