org.mule.modules

mule-module-cmis

config

Namespace	http://www.mulesoft.org/schema/mule/cmis
Schema Location	http://www.mulesoft.org/schema/mule/cmis/current/mule-cmis.xsd (View Schema)
Schema Version	1.1
Minimum Mule Version	3.4

Module Overview

CMIS (Content Management Interoperability Services) is a standard for improving interoperability between ECM systems.

Summary

Configuration
<cmis:config> Configure an instance of this module

Message Processors
<cmis:apply-acl> Set the permissions associated with an object.
<cmis:apply-aspect> Apply and aspect to an object and set some properties of that aspect.
<cmis:apply-policy> Applies policies to this object.
<cmis:cancel-check-out> If applied to a PWC (private working copy) of the document, the check out will be reversed.
<cmis:changelog> Gets repository changes.
<cmis:check-in> If applied to a PWC (private working copy) it performs a check in.
<cmis:check-out> Checks out the document and returns the object id of the PWC (private working copy).
<cmis:create-document-by-id> Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by an object ID.
<cmis:create-document-by-id-from-content> Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by an object ID.
<cmis:create-document-by-path> Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by a repository path.
<cmis:create-document-by-path-from-content> Creates a new document in the repository where the content is specified as the value of the "content" parameter and the target folder node is specified by a repository path.
<cmis:create-folder> Creates a folder.
<cmis:create-relationship> Creates a parent/child relationships between two nodes in the repository of the specified relationship object type.
<cmis:delete> Remove an object
<cmis:delete-tree> Deletes a folder and all subfolders.
<cmis:folder> Navigates the folder structure.
<cmis:get-acl> Returns the ACL if it has been fetched for an object.
<cmis:get-all-versions> Retrieve an object's version history
<cmis:get-applied-policies> Get the policies that are applied to an object.
<cmis:get-checkout-docs> Retrieve list of checked out documents.
<cmis:get-content-stream> Retrieves the content stream of a Document.
<cmis:get-object-by-id> Returns a CMIS object from the repository and puts it into the cache.
<cmis:get-object-by-path> Returns a CMIS object from the repository and puts it into the cache.
<cmis:get-object-relationships> Returns the relationships if they have been fetched for an object.
<cmis:get-or-create-folder-by-path> Creates a new folder in the repository if it doesn't already exist.
<cmis:get-parent-folders> Retrieves the parent folders of a fileable cmis object
<cmis:get-type-definition> Returns the type definition of the given type id.
<cmis:move-object> Moves a fileable cmis object from one location to another.
<cmis:query> Sends a query to the repository
<cmis:repositories> Returns all repositories that are available at the endpoint.
<cmis:repository-info> Returns information about the CMIS repository, the optional capabilities it supports and its Access Control information if applicable.
<cmis:update-object-properties> Update an object's properties

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:cmis="http://www.mulesoft.org/schema/mule/cmis"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/cmis
               http://www.mulesoft.org/schema/mule/cmis/current/mule-cmis.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <cmis:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		CMIS username	String	/	UTF-8
password		CMIS password	String	/	UTF-8
baseUrl		URL base for the SOAP connector	String	/	UTF-8
repositoryId		The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <cmis:config>
         <reconnect count="5" frequency="1000"/>
    </cmis:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<cmis:apply-acl>

Set the permissions associated with an object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object whose Acl is intended to change.	CmisObject	/
objectId		Optional. The id of the object	String	/	UTF-8
aclPropagation		Wheter to propagate changes or not. can be REPOSITORYDETERMINED \| OBJECTONLY \| PROPAGATE	AclPropagation	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:add-aces>		Added access control entities	List<Ace>
<cmis:remove-aces>		Removed access control entities	List<Ace>

Returns

Return Type	Description
Acl	the new access control list

<cmis:apply-aspect>

Apply and aspect to an object and set some properties of that aspect.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
objectId		The object's id.	String	/	UTF-8
aspectName		The name of the aspect to be applied to the object.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>	#[payload]	Optional. The properties to set.	Map<String, String>

Returns

Return Type	Description
void	The updated object (a repository might have created a new object)

<cmis:apply-policy>

Applies policies to this object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The document from which to get the stream. Can be null if "objectId" is set.	CmisObject	/
objectId		Optional. Id of the document from which to get the stream. Can be null if "object" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:policy-ids>		Policy ID's to apply	List<ObjectId>

<cmis:cancel-check-out>

If applied to a PWC (private working copy) of the document, the check out will be reversed. Otherwise, an exception will be thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
document		Optional. The checked out document. Can be null if "documentId" is set.	CmisObject	/
documentId		Optional. Id of the checked out document. Can be null if "document" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

<cmis:changelog>

Gets repository changes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
changeLogToken		Optional. The change log token to start from or `null`	String	/	UTF-8
includeProperties		Indicates if changed properties should be included in the result	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ChangeEvents	a ChangeEvents instance

<cmis:check-in>

If applied to a PWC (private working copy) it performs a check in. Otherwise, an exception will be thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
document		Optional. The document to check-in. Can be null if "documentId" is set.	CmisObject	/
documentId		Optional. Id of the document to check-in. Can be null if "document" is set.	String	/	UTF-8
content	#[payload]	Optional. File content (no byte array or input stream for now)	Object	/
filename		Name of the file	String	/	UTF-8
mimeType		Stream content-type	String	/	UTF-8
major		Whether it is major	boolean	/
checkinComment		Check-in comment	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		Optional. Custom properties	Map<String, String>

Returns

Return Type	Description
ObjectId	the ObjectId of the checkedin document

<cmis:check-out>

Checks out the document and returns the object id of the PWC (private working copy).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
document		Optional. The document to be checked out. Can be null if "documentId" is set.	CmisObject	/
documentId		Optional. Id of the document to be checked out. Can be null if "document" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ObjectId	PWC ObjectId

<cmis:create-document-by-id>

Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by an object ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderId		Folder Object Id	String	/	UTF-8
filename		Name of the file	String	/	UTF-8
content	#[payload]	Optional. File content as specified in the payload	Object	/
mimeType		Stream content-type	String	/	UTF-8
versioningState		An enumeration specifying what the versioning state of the newly-created object MUST be. If the repository does not support versioning, the repository MUST ignore the versioningState parameter. Valid values are: o none: The document MUST be created as a non-versionable document. o checkedout: The document MUST be created in the checked-out state. o major (default): The document MUST be created as a major version o minor: The document MUST be created as a minor version.	VersioningState	/
objectType		The type of the object	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		Optional. The properties optional document properties to set	Map<String, String>

Returns

Return Type	Description
ObjectId	the object id ObjectId of the created

<cmis:create-document-by-id-from-content>

Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by an object ID. *

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderId		Folder Object Id	String	/	UTF-8
filename		Name of the file	String	/	UTF-8
content	#[payload]	Optional. File content	Object	/
mimeType		Stream content-type	String	/	UTF-8
versioningState		An enumeration specifying what the versioning state of the newly-created object MUST be. If the repository does not support versioning, the repository MUST ignore the versioningState parameter. Valid values are: o none: The document MUST be created as a non-versionable document. o checkedout: The document MUST be created in the checked-out state. o major (default): The document MUST be created as a major version o minor: The document MUST be created as a minor version.	VersioningState	/
objectType		The type of the object	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		Optional. The properties optional document properties to set	Map<String, String>

Returns

Return Type	Description
ObjectId	the object id ObjectId of the created

<cmis:create-document-by-path>

Creates a new document in the repository where the content comes directly from the payload and the target folder node is specified by a repository path. *

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderPath		Folder in the repository that will hold the document	String	/	UTF-8
filename		Name of the file	String	/	UTF-8
content	#[payload]	Optional. File content as specified in the payload	Object	/
mimeType		Stream content-type	String	/	UTF-8
versioningState		An enumeration specifying what the versioning state of the newly-created object MUST be. If the repository does not support versioning, the repository MUST ignore the versioningState parameter. Valid values are: o none: The document MUST be created as a non-versionable document. o checked-out: The document MUST be created in the checked-out state. o major (default): The document MUST be created as a major version o minor: The document MUST be created as a minor version.	VersioningState	/
objectType		The type of the object	String	/	UTF-8
force	false	Optional. If should folder structure must be created when there are missing intermediate folders	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		Optional. The properties optional document properties to set	Map<String, String>

Returns

Return Type	Description
ObjectId	the object id ObjectId of the created

<cmis:create-document-by-path-from-content>

Creates a new document in the repository where the content is specified as the value of the "content" parameter and the target folder node is specified by a repository path.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderPath		Folder in the repository that will hold the document	String	/	UTF-8
filename		Name of the file	String	/	UTF-8
content	#[payload]	Optional. File content	Object	/
mimeType		Stream content-type	String	/	UTF-8
versioningState		An enumeration specifying what the versioning state of the newly-created object MUST be. If the repository does not support versioning, the repository MUST ignore the versioningState parameter.	VersioningState	/
objectType		The type of the object.	String	/	UTF-8
force	false	Optional. If should folder structure must be created when there are missing intermediate folders	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		Optional. The properties optional document properties to set	Map<String, String>

Returns

Return Type	Description
ObjectId	the ObjectId of the created

<cmis:create-folder>

Creates a folder. Note that this is not recusive creation. You just create one folder

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderName		Folder name (eg: "my documents")	String	/	UTF-8
parentObjectId		Parent folder for the folder being created (eg: repository.rootFolder)	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ObjectId	the ObjectId of the created

<cmis:create-relationship>

Creates a parent/child relationships between two nodes in the repository of the specified relationship object type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
parentObjectId		The ID of the parent (or source) object in the relationship.	String	/	UTF-8
childObjectId		The ID of the child (or target) object in the relationship.	String	/	UTF-8
relationshipType		The name of the relationship type that should be associated with the objects.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ObjectId	The ObjectId that is the result of the relationship

<cmis:delete>

Remove an object

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object to be deleted. Can be null if "objectId" is set.	CmisObject	/
objectId		Optional. The object's id. Can be null if "cmisObject" is set.	String	/	UTF-8
allVersions	false	Optional. If true, deletes all version history of the object. Defaults to "false".	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

<cmis:delete-tree>

Deletes a folder and all subfolders.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folder		Optional. Folder Object. Can be null if "folderId" is set.	CmisObject	/
folderId		Optional. Folder Object id. Can be null if "folder" is set.	String	/	UTF-8
allversions		If true, then delete all versions of the document. If false, delete only the document object specified.	boolean	/
unfile		Optional. Specifies how the repository must process file-able child- or descendant-objects.	UnfileObject	/
continueOnFailure		Specified whether to continue attempting to perform this operation even if deletion of a child- or descendant-object in the specified folder cannot be deleted or not.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<String>	a list of object ids which failed to be deleted.

<cmis:folder>

Navigates the folder structure.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folder		Optional. Folder Object. Can be null if "folderId" is set.	Folder	/
folderId		Optional. Folder Object id. Can be null if "folder" is set.	String	/	UTF-8
get		NavigationOptions that specifies whether to get the parent folder, the list of immediate children or the whole descendants tree	NavigationOptions	/
depth		Optional. If "get" value is DESCENDANTS, represents the depth of the descendants tree	Integer	/
filter		Optional. Comma-separated list of properties to filter (only for CHILDREN or DESCENDANTS navigation)	String	/	UTF-8
orderBy		Optional. Comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name (only for CHILDREN or DESCENDANTS navigation)	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
Object	the following, depending on the value of "get" parameter: PARENT: returns the parent Folder CHILDREN: returns a CmisObject ItemIterable with objects contained in the current folder DESCENDANTS: List> representing the whole descentants tree of the current folder TREE: List> representing the directory structure under the current folder.

<cmis:get-acl>

Returns the ACL if it has been fetched for an object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object whose Acl is needed	CmisObject	/
objectId		Optional. The id of the object	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
Acl	the object's Acl

<cmis:get-all-versions>

Retrieve an object's version history

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
document		Optional. The document whose versions are to be retrieved	CmisObject	/
documentId		Optional. Id of the document whose versions are to be retrieved	String	/	UTF-8
filter		Optional. Comma-separated list of properties to filter (only for CHILDREN or DESCENDANTS navigation)	String	/	UTF-8
orderBy		Optional. Comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name (only for CHILDREN or DESCENDANTS navigation)	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<Document>	versions of the document.

<cmis:get-applied-policies>

Get the policies that are applied to an object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject	#[payload]	Optional. The document from which to get the stream. Can be null if "objectId" is set.	CmisObject	/
objectId		Optional. Id of the document from which to get the stream. Can be null if "object" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<Policy>	List of applied policies

<cmis:get-checkout-docs>

Retrieve list of checked out documents.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
filter		Optional. Comma-separated list of properties to filter	String	/	UTF-8
orderBy		Optional. Comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ItemIterable<Document>	list of Document.

<cmis:get-content-stream>

Retrieves the content stream of a Document.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The document from which to get the stream. Can be null if "objectId" is set.	CmisObject	/
objectId		Optional. Id of the document from which to get the stream. Can be null if "object" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ContentStream	The content stream of the document.

<cmis:get-object-by-id>

Returns a CMIS object from the repository and puts it into the cache.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
objectId		The object id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
CmisObject	a CmisObject instance

<cmis:get-object-by-path>

Returns a CMIS object from the repository and puts it into the cache.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
path		Path of the object to retrieve	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
CmisObject	a CmisObject instance

<cmis:get-object-relationships>

Returns the relationships if they have been fetched for an object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object whose relationships are needed	CmisObject	/
objectId		Optional. The id of the object	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<Relationship>	list of the object's relationships

<cmis:get-or-create-folder-by-path>

Creates a new folder in the repository if it doesn't already exist.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
folderPath		Path to the folder	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
CmisObject	the ObjectId of the created

<cmis:get-parent-folders>

Retrieves the parent folders of a fileable cmis object

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object whose parent folders are needed. can be null if "objectId" is set.	CmisObject	/
objectId		Optional. Id of the object whose parent folders are needed. can be null if "object" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<Folder>	a list of the object's parent folders.

<cmis:get-type-definition>

Returns the type definition of the given type id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
typeId		Object type Id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ObjectType	type of object ObjectType

<cmis:move-object>

Moves a fileable cmis object from one location to another. Take into account that a fileable object may be filled in several locations. Thats why you must specify a source folder.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. The object to move. Can be null if "objectId" is set.	FileableCmisObject	/
objectId		Optional. The object's id. Can be null if "cmisObject" is set.	String	/	UTF-8
sourceFolderId		Id of the source folder	String	/	UTF-8
targetFolderId		Id of the target folder	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
FileableCmisObject	The object moved (FileableCmisObject)

<cmis:query>

Sends a query to the repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
statement		The query statement (CMIS query language)	String	/	UTF-8
searchAllVersions		Specifies if the latest and non-latest versions of document objects should be included	Boolean	/
filter		Optional. Comma-separated list of properties to filter	String	/	UTF-8
orderBy		Optional. Comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
ItemIterable<QueryResult>	an iterable of QueryResult

<cmis:repositories>

Returns all repositories that are available at the endpoint.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
List<Repository>	a list of Repository.

<cmis:repository-info>

Returns information about the CMIS repository, the optional capabilities it supports and its Access Control information if applicable.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Returns

Return Type	Description
RepositoryInfo	a RepositoryInfo instance

<cmis:update-object-properties>

Update an object's properties

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cmisObject		Optional. Object to be updated. Can be null if "objectId" is set.	CmisObject	/
objectId		Optional. The object's id. Can be null if "cmisObject" is set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. CMIS username	String	/	UTF-8
password		Optional. CMIS password	String	/	UTF-8
baseUrl		Optional. URL base for the SOAP connector	String	/	UTF-8
repositoryId		Optional. The identifier for the Repository that this connector instance works with	String	/	UTF-8
endpoint	ATOM	Optional. The type of endpoint. Values: SOAP or ATOMPUB	String	/	UTF-8
connectionTimeout	10000	Optional. The connection time-out specification	String	/	UTF-8
useAlfrescoExtension	false	Optional. Specifies whether the Alfresco Object Factory implementation should be utilized, the Alfresco CMIS extension JAR must be included in your Mule application in order for this configuration to work.	String	/	UTF-8
cxfPortProvider	org.apache.chemistry.opencmis.client.bindings.spi.webservices.CXFPortProvider	Optional. Specifies CXF port provider, the CMIS connector includes a default implementation but allows to set a custom implementation by extending org.apache.chemistry.opencmis.client.bindings.spi.webservices.AbstractPortProvider	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cmis:properties>		The properties to update	Map<String, String>

Returns

Return Type	Description
CmisObject	The updated object (a repository might have created a new object)