camel.apache.org/weather
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for weather

gitea_admin 2026-03-11 14:43:01 +00:00
parent 53c2f991d2
commit 5c23f41226
1 changed files with 61 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
Home.md

@ -1,21 +1,68 @@
# Deploy the Project on CamelX Platform # Weather
Deploy on CamelX Platform in three steps Poll the weather information from Open Weather Map.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `weather` |
| Support Level | Stable |
| Labels | api |
| Version | 4.10.2 |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-weather</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `name` | string | ✓ | | The name value is not used. |
| `appid` | string | ✓ | | APPID ID used to authenticate the user connected to the API Server |
| `headerName` | 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` | object | | `en` | Language of the response. |
| `mode` | object | | `JSON` | The output format of the weather data. |
| `period` | 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` | object | | | The units for temperature measurement. |
| `weatherApi` | object | | | The API to use (current, forecast/3 hour, forecast daily, station) |
| `sendEmptyMessageWhenIdle` | boolean | | `false` | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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. |
| `exceptionHandler` | object | | | 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. |
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
| `pollStrategy` | object | | | 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. |
| `lazyStartProducer` | boolean | | `false` | 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. |
| `geoLocationProvider` | object | | | 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 |
| `httpClient` | object | | | To use an existing configured http client (for example with http proxy) |
| `cnt` | integer | | | Number of results to be found |
| `ids` | string | | | List of id's of city/stations. You can separate multiple ids by comma. |
| `lat` | string | | | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. |
| `location` | 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` | string | | | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. |
| `rightLon` | string | | | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. |
| `topLat` | string | | | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. |
| `zip` | string | | | Zip-code, e.g. 94040,us |
| `zoom` | integer | | | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. |
| `backoffErrorThreshold` | integer | | | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
| `backoffIdleThreshold` | integer | | | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
| `backoffMultiplier` | integer | | | 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` | integer | | `500` | Milliseconds before the next poll. |
| `greedy` | boolean | | `false` | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
| `initialDelay` | integer | | `1000` | Milliseconds before the first poll starts. |
| `repeatCount` | integer | | `0` | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
| `runLoggingLevel` | object | | `TRACE` | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
| `scheduledExecutorService` | object | | | 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` | object | | `none` | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler |
| `schedulerProperties` | object | | | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |
| `startScheduler` | boolean | | `true` | Whether the scheduler should be auto started. |
| `timeUnit` | object | | `MILLISECONDS` | Time unit for initialDelay and delay options. |
| `useFixedDelay` | boolean | | `true` | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
| `geolocationAccessKey` | string | ✓ | | The geolocation service now needs an accessKey to be used |
| `geolocationRequestHostIP` | string | ✓ | | The geolocation service now needs to specify the IP associated to the accessKey you're using |