Update wiki Home page for jcr

gitea_admin 2026-03-11 14:39:44 +00:00
parent 26c0edc65b
commit ca0cb4474d

50
Home.md

@ -1,21 +1,43 @@
# Deploy the Project on CamelX Platform
# JCR
Deploy on CamelX Platform in three steps
Read and write nodes to/from a JCR compliant content repository.
## 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 | `jcr` |
| Support Level | Stable |
| Labels | database,cms |
| 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-jcr</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 |
|------|------|----------|---------|-------------|
| `host` | string | ✓ | | Name of the javax.jcr.Repository to lookup from the Camel registry to be used. |
| `base` | string | | | Get the base node when accessing the repository |
| `deep` | boolean | | `false` | When isDeep is true, events whose associated parent node is at absPath or within its subgraph are received. |
| `eventTypes` | integer | | | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED, javax.jcr.observation.Event.NODE_REMOVED, etc.). |
| `nodeTypeNames` | string | | | When a comma separated nodeTypeName list string is set, only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. |
| `noLocal` | boolean | | `false` | If noLocal is true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored. |
| `password` | string | | | Password for login |
| `sessionLiveCheckInterval` | duration | | `60000` | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. |
| `sessionLiveCheckIntervalOnStart` | duration | | `3000` | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. |
| `username` | string | | | Username for login |
| `uuids` | string | | | When a comma separated uuid list string is set, only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received. |
| `workspaceName` | string | | | The workspace to access. If it's not specified then the default one will be used |
| `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. |
| `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. |