Update wiki Home page for infinispan

gitea_admin 2026-03-11 14:39:32 +00:00
parent e15197e14e
commit b8b37ce59f

61
Home.md

@ -1,21 +1,54 @@
# Deploy the Project on CamelX Platform
# Infinispan
Deploy on CamelX Platform in three steps
Read and write from/to Infinispan distributed key/value store and data grid.
## 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 | `infinispan` |
| 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-infinispan</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 to use. Use current to use the existing cache name from the currently configured cached manager. Or use default for the default cache manager name. |
| `hosts` | string | | | Specifies the host of the cache on Infinispan instance. Multiple hosts can be separated by semicolon. |
| `queryBuilder` | object | | | Specifies the query builder. |
| `customListener` | object | | | Returns the custom listener in use, if provided |
| `eventTypes` | string | | | Specifies the set of event types to register by the consumer.Multiple event can be separated by comma. The possible event types are: CLIENT_CACHE_ENTRY_CREATED, CLIENT_CACHE_ENTRY_MODIFIED, CLIENT_CACHE_ENTRY_REMOVED, CLIENT_CACHE_ENTRY_EXPIRED, CLIENT_CACHE_FAILOVER |
| `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. |
| `defaultValue` | object | | | Set a specific default value for some producer operations |
| `key` | object | | | Set a specific key for producer operations |
| `oldValue` | object | | | Set a specific old value for some producer operations |
| `operation` | object | | `PUT` | The operation to perform |
| `value` | object | | | Set a specific value for producer operations |
| `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. |
| `cacheContainer` | object | | | Specifies the cache Container to connect |
| `cacheContainerConfiguration` | object | | | The CacheContainer configuration. Used if the cacheContainer is not defined. |
| `configurationProperties` | object | | | Implementation specific properties for the CacheManager |
| `configurationUri` | string | | | An implementation specific URI for the CacheManager |
| `flags` | string | | | A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation. |
| `remappingFunction` | object | | | Set a specific remappingFunction to use in a compute operation. |
| `resultHeader` | string | | | Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader |
| `password` | string | | | Define the password to access the infinispan instance |
| `saslMechanism` | string | | | Define the SASL Mechanism to access the infinispan instance |
| `secure` | boolean | | `false` | Define if we are connecting to a secured Infinispan instance |
| `securityRealm` | string | | | Define the security realm to access the infinispan instance |
| `securityServerName` | string | | | Define the security server name to access the infinispan instance |
| `username` | string | | | Define the username to access the infinispan instance |