camel.apache.org/jcache
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 jcache

gitea_admin 2026-03-11 14:39:42 +00:00
parent d48b6a3620
commit 8714664b9e
1 changed files with 44 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Home.md

@ -1,21 +1,51 @@
# Deploy the Project on CamelX Platform
# JCache
Deploy on CamelX Platform in three steps
Perform caching operations against JSR107/JCache.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `jcache` |
| Support Level | Stable |
| Labels | cache,clustering |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-jcache</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `cacheName` | string | ✓ | | The name of the cache |
| `cacheConfigurationProperties` | object | | | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager |
| `cachingProvider` | string | | | The fully qualified class name of the javax.cache.spi.CachingProvider |
| `configurationUri` | string | | | An implementation specific URI for the CacheManager |
| `managementEnabled` | boolean | | `false` | Whether management gathering is enabled |
| `readThrough` | boolean | | `false` | If read-through caching should be used |
| `statisticsEnabled` | boolean | | `false` | Whether statistics gathering is enabled |
| `storeByValue` | boolean | | `true` | If cache should use store-by-value or store-by-reference semantics |
| `writeThrough` | boolean | | `false` | If write-through caching should be used |
| `filteredEvents` | string | | | Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored |
| `oldValueRequired` | boolean | | `false` | if the old value is required for events |
| `synchronous` | boolean | | `false` | if the event listener should block the thread causing the event |
| `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. |
| `eventFilters` | array | | | The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be 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. |
| `action` | string | | | To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence. |
| `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. |
| `cacheConfiguration` | object | | | A Configuration for the Cache |
| `cacheLoaderFactory` | object | | | The CacheLoader factory |
| `cacheWriterFactory` | object | | | The CacheWriter factory |
| `createCacheIfNotExists` | boolean | | `true` | Configure if a cache need to be created if it does exist or can't be pre-configured. |
| `expiryPolicyFactory` | object | | | The ExpiryPolicy factory |
| `lookupProviders` | boolean | | `false` | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. |