Chapter 64. CMIS Component
Available as of Camel version 2.11
The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories.
64.1. URI Format
cmis://cmisServerUrl[?options]
You can append query options to the URI in the following format, ?options=value&option2=value&…
64.2. CMIS Options
The CMIS component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| sessionFacadeFactory (common) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | CMISSessionFacade Factory | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The CMIS endpoint is configured using URI syntax:
cmis:cmsUrl
with the following path and query parameters:
64.2.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| cmsUrl | Required URL to the cmis repository | String |
64.2.2. Query Parameters (13 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| pageSize (common) | Number of nodes to retrieve per page | 100 | int |
| readContent (common) | If set to true, the content of document node will be retrieved in addition to the properties | false | boolean |
| readCount (common) | Max number of nodes to read | int | |
| repositoryId (common) | The Id of the repository to use. If not specified the first available repository is used | String | |
| bridgeErrorHandler (consumer) | 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 or ERROR level and ignored. | false | boolean |
| query (consumer) | The cmis query to execute against the repository. If not specified, the consumer will retrieve every node from the content repository by iterating the content tree recursively | String | |
| exceptionHandler (consumer) | 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. | ExceptionHandler | |
| exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
| queryMode (producer) | If true, will execute the cmis query from the message body and return result, otherwise will create a node in the cmis repository | false | boolean |
| sessionFacadeFactory (advanced) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | CMISSessionFacade Factory | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
| password (security) | Password for the cmis repository | String | |
| username (security) | Username for the cmis repository | String |
64.3. Spring Boot Auto-Configuration
The component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.cmis.enabled | Enable cmis component | true | Boolean |
| camel.component.cmis.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
| camel.component.cmis.session-facade-factory | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances. The option is a org.apache.camel.component.cmis.CMISSessionFacadeFactory type. | String |
64.4. Usage
64.4.1. Message headers evaluated by the producer
| Header | Default Value | Description |
|---|---|---|
|
|
| The current folder to use during the execution. If not specified will use the root folder |
|
|
|
In |
|
|
| Max number of nodes to read. |
|
|
|
If |
|
|
|
If |
|
|
| The type of the node |
|
|
| The mimetype to set for a document |
64.4.2. Message headers set during querying Producer operation
| Header | Type | Description |
|---|---|---|
|
|
| Number of nodes returned from the query. |
The message body will contain a list of maps, where each entry in the map is cmis property and its value. If CamelCMISRetrieveContent header is set to true, one additional entry in the map with key CamelCMISContent will contain InputStream of the document type of nodes.
64.5. Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-cmis</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version} must be replaced by the actual version of Camel (2.11 or higher).
64.6. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
