camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Camel > CMIS
Date Sat, 21 Jul 2012 18:41:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/1/_/styles/combined.css?spaceKey=CAMEL&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/CAMEL/CMIS">CMIS</a></h2>
    <h4>Page  <b>added</b> by             <a href="https://cwiki.apache.org/confluence/display/~bibryam">Bilgin
Ibryam</a>
    </h4>
         <br/>
    <div class="notificationGreySide">
         <h2><a name="CMIS-CMISComponent"></a>CMIS Component</h2>
<p><b>Available as of Camel 2.11</b></p>

<p>The cmis component allows you to add/read nodes to/from a CMIS compliant content
repository (for example, Alfresco).</p>

<h3><a name="CMIS-URIFormat"></a>URI Format</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
cmis:<span class="code-comment">//cmisServerUrl[?options]</span>
</pre>
</div></div>
<p>You can append query options to the URI in the following format, ?options=value&amp;option2=value&amp;...</p>

<h3><a name="CMIS-URIOptions"></a>URI Options</h3>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Name </th>
<th class='confluenceTh'> Default Value </th>
<th class='confluenceTh'> Context </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'>queryMode </td>
<td class='confluenceTd'> <tt>false</tt> </td>
<td class='confluenceTd'> Producer </td>
<td class='confluenceTd'> If true, will execute the cmis query from the message body
and return result, otherwise will create a node in the cmis repository </td>
</tr>
<tr>
<td class='confluenceTd'>query </td>
<td class='confluenceTd'> <tt>String</tt> </td>
<td class='confluenceTd'> Consumer </td>
<td class='confluenceTd'> 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 </td>
</tr>
<tr>
<td class='confluenceTd'>username </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> Username for the cmis repository </td>
</tr>
<tr>
<td class='confluenceTd'>password </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> Password for the cmis repository </td>
</tr>
<tr>
<td class='confluenceTd'>repositoryId </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> The Id of the repository to use. If not specified the first
available repository is used </td>
</tr>
<tr>
<td class='confluenceTd'>pageSize </td>
<td class='confluenceTd'> <tt>100</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> Number of nodes to retrieve per page </td>
</tr>
<tr>
<td class='confluenceTd'>readCount </td>
<td class='confluenceTd'> <tt>0</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> Max number of nodes to read </td>
</tr>
<tr>
<td class='confluenceTd'>readContent </td>
<td class='confluenceTd'> <tt>false</tt> </td>
<td class='confluenceTd'> Both </td>
<td class='confluenceTd'> If set to true, the content of document node will be retrieved
in addition to the properties</td>
</tr>
</tbody></table>
</div>


<h3><a name="CMIS-Usage"></a>Usage</h3>
<h4><a name="CMIS-Messageheadersevaluatedbytheproducer"></a>Message headers
evaluated by the producer</h4>
<div class="confluenceTableSmall"><div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Header </th>
<th class='confluenceTh'> Default Value </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> <tt>CamelCMISFolderPath</tt> </td>
<td class='confluenceTd'> <tt>/</tt> </td>
<td class='confluenceTd'> The current folder to use during the execution. If not specified
will use the root folder </td>
</tr>
<tr>
<td class='confluenceTd'> <tt>CamelCMISRetrieveContent</tt> </td>
<td class='confluenceTd'> <tt>false</tt> </td>
<td class='confluenceTd'> In <tt>queryMode</tt> this header will force the
producer to retrieve the content of document nodes. </td>
</tr>
<tr>
<td class='confluenceTd'> <tt>CamelCMISReadSize</tt> </td>
<td class='confluenceTd'> <tt>0</tt> </td>
<td class='confluenceTd'> Max number of nodes to read.</td>
</tr>
<tr>
<td class='confluenceTd'> <tt>cmis:path</tt> </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> If <tt>CamelCMISFolderPath</tt> is not set, will
try to find out the path of the node from this cmis property and it is name</td>
</tr>
<tr>
<td class='confluenceTd'> <tt>cmis:name</tt> </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> If <tt>CamelCMISFolderPath</tt> is not set, will
try to find out the path of the node from this cmis property and it is path</td>
</tr>
<tr>
<td class='confluenceTd'> <tt>cmis:objectTypeId</tt> </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> The type of the node </td>
</tr>
<tr>
<td class='confluenceTd'> <tt>cmis:contentStreamMimeType</tt> </td>
<td class='confluenceTd'> <tt>null</tt> </td>
<td class='confluenceTd'> The mimetype to set for a document </td>
</tr>
</tbody></table>
</div>
</div>

<h4><a name="CMIS-MessageheaderssetduringqueryingProduceroperation"></a>Message
headers set during querying Producer operation</h4>
<div class="confluenceTableSmall"><div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Header </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> <tt>CamelCMISResultCount</tt> </td>
<td class='confluenceTd'> <tt>Integer</tt> </td>
<td class='confluenceTd'> Number of nodes returned from the query. </td>
</tr>
</tbody></table>
</div>
</div>
<p>The message body will contain a list of maps, where each entry in the map is cmis
property and its value. <br/>
If <tt>CamelCMISRetrieveContent</tt> header is set to true, one additional entry
in the map with key <tt>CamelCMISContent</tt> will contain <tt>InputStream</tt>
of the document type of nodes.  </p>
<h3><a name="CMIS-Dependencies"></a>Dependencies</h3>
<p>Maven users will need to add the following dependency to their pom.xml.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader"
style="border-bottom-width: 1px;"><b>pom.xml</b></div><div class="codeContent
panelContent">
<pre class="code-xml">
<span class="code-tag">&lt;dependency&gt;</span>
    <span class="code-tag">&lt;groupId&gt;</span>org.apache.camel<span
class="code-tag">&lt;/groupId&gt;</span>
    <span class="code-tag">&lt;artifactId&gt;</span>camel-cmis<span
class="code-tag">&lt;/artifactId&gt;</span>
    <span class="code-tag">&lt;version&gt;</span>${camel-version}<span
class="code-tag">&lt;/version&gt;</span>
<span class="code-tag">&lt;/dependency&gt;</span>
</pre>
</div></div>

<p>where <tt>${camel-version</tt>} must be replaced by the actual version
of Camel (2.11 or higher).</p>

<h3><a name="CMIS-SeeAlso"></a>See Also</h3>
<ul>
	<li><a href="/confluence/display/CAMEL/Configuring+Camel" title="Configuring Camel">Configuring
Camel</a></li>
	<li><a href="/confluence/display/CAMEL/Component" title="Component">Component</a></li>
	<li><a href="/confluence/display/CAMEL/Endpoint" title="Endpoint">Endpoint</a></li>
	<li><a href="/confluence/display/CAMEL/Getting+Started" title="Getting Started">Getting
Started</a></li>
</ul>

    </div>
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
       </div>
       <a href="https://cwiki.apache.org/confluence/display/CAMEL/CMIS">View Online</a>
              |
       <a href="https://cwiki.apache.org/confluence/display/CAMEL/CMIS?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
           </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message