CMIS

Since Camel 2.11

Both producer and consumer are supported

The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories.

URI Format

cmis://cmisServerUrl[?options]

You can append query options to the URI in the following format, ?options=value&option2=value&…​

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The CMIS component supports 4 options, which are listed below.

Name Description Default Type

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

lazyStartProducer (producer)

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.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

sessionFacadeFactory (advanced)

To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances.

CMISSessionFacadeFactory

Endpoint Options

The CMIS endpoint is configured using URI syntax:

cmis:cmsUrl

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

cmsUrl (common)

Required URL to the cmis repository.

String

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 (advanced))

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 (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

lazyStartProducer (producer)

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.

false

boolean

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.

CMISSessionFacadeFactory

password (security)

Password for the cmis repository.

String

username (security)

Username for the cmis repository.

String

Usage

Message Headers

The CMIS component supports 15 message header(s), which is/are listed below:

Name Description Default Type

cmis:action (producer)

Constant: CMIS_ACTION

The action to perform.

Enum values:

  • CREATE

  • DELETE_DOCUMENT

  • DELETE_FOLDER

  • MOVE_DOCUMENT

  • MOVE_FOLDER

  • COPY_DOCUMENT

  • COPY_FOLDER

  • RENAME

  • CHECK_IN

  • CHECK_OUT

  • CANCEL_CHECK_OUT

  • GET_FOLDER

  • LIST_FOLDER

  • FIND_OBJECT_BY_ID

  • FIND_OBJECT_BY_PATH

  • CREATE_FOLDER_BY_PATH

  • DOWNLOAD_DOCUMENT

CamelCMISActions

cmis:path (producer)

Constant: PATH

If CamelCMISFolderPath is not set, will try to find out the path of the node from this cmis property and it is name.

String

cmis:name (producer)

Constant: NAME

If CamelCMISFolderPath is not set, will try to find out the path of the node from this cmis property and it is path.

String

cmis:objectTypeId (producer)

Constant: OBJECT_TYPE_ID

The type of the node.

String

cmis:checkinComment (producer)

Constant: CHECKIN_COMMENT

The check-in comment for the document version.

String

cmis:contentStreamMimeType (producer)

Constant: CONTENT_STREAM_MIME_TYPE

The mimetype to set for a document.

String

CamelCMISFolderPath (producer)

Constant: CMIS_FOLDER_PATH

The current folder to use during the execution. If not specified will use the root folder.

/

String

CamelCMISObjectId (producer)

Constant: CMIS_OBJECT_ID

The id of the object.

String

CamelCMISDestinationFolderId (producer)

Constant: CMIS_DESTIONATION_FOLDER_ID

The id of the destination folder.

String

CamelCMISSourceFolderId (producer)

Constant: CMIS_SOURCE_FOLDER_ID

The id of the source folder.

String

CamelCMISResultCount (producer)

Constant: CAMEL_CMIS_RESULT_COUNT

Number of nodes returned from the query.

Integer

CamelCMISRetrieveContent (producer)

Constant: CAMEL_CMIS_RETRIEVE_CONTENT

In queryMode this header will force the producer to retrieve the content of document nodes.

Boolean

CamelCMISReadSize (producer)

Constant: CAMEL_CMIS_READ_SIZE

Max number of nodes to read.

Integer

CamelCMISAllVersions (producer)

Constant: ALL_VERSIONS

Apply only to this version (false) or all versions (true).

Boolean

cmis:versioningState (producer)

Constant: VERSIONING_STATE

The versioning state.

String

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.

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.

Spring Boot Auto-Configuration

When using cmis with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-cmis-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 5 options, which are listed below.

Name Description Default Type

camel.component.cmis.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.cmis.bridge-error-handler

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

camel.component.cmis.enabled

Whether to enable auto configuration of the cmis component. This is enabled by default.

Boolean

camel.component.cmis.lazy-start-producer

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.

false

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.

CMISSessionFacadeFactory
Back to top