You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@chemistry.apache.org by fm...@apache.org on 2016/06/24 10:03:34 UTC
svn commit: r1750066 [13/13] - in /chemistry/site/trunk: content/docs/
content/docs/cmis-samples/ content/docs/cmis-samples/about/
content/docs/cmis-samples/css/ content/docs/cmis-samples/fonts/
content/docs/cmis-samples/img/ content/docs/cmis-samples/...
Added: chemistry/site/trunk/content/docs/cmis-samples/samples/retrieve-objects/index.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/samples/retrieve-objects/index.html?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/samples/retrieve-objects/index.html (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/samples/retrieve-objects/index.html Fri Jun 24 10:03:33 2016
@@ -0,0 +1,500 @@
+<!DOCTYPE html>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="author" content="Apache Chemistry">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Retrieving Objects - Apache Chemistry Samples</title>
+
+ <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/cinder.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+
+
+ <link href="../../css/chemistry.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+</head>
+
+<body>
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+
+ <!-- Main title -->
+ <a class="navbar-brand" href="../../index.html">Apache Chemistry Samples</a>
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+
+
+ <li >
+ <a href="../../index.html">Home</a>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Repository <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../create-session/index.html">Creating a Session</a>
+</li>
+
+
+
+<li >
+ <a href="../capabilities/index.html">Getting Repository Capabilities</a>
+</li>
+
+
+
+<li >
+ <a href="../types/index.html">Working with Types</a>
+</li>
+
+
+
+<li >
+ <a href="../exceptions/index.html">CMIS Exceptions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CRUD <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li class="active">
+ <a href="index.html">Retrieving Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../create-objects/index.html">Creating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../update-objects/index.html">Updating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../move-objects/index.html">Moving Object</a>
+</li>
+
+
+
+<li >
+ <a href="../delete-objects/index.html">Deleting Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../content/index.html">Working with Content</a>
+</li>
+
+
+
+<li >
+ <a href="../versions/index.html">Working with Versions</a>
+</li>
+
+
+
+<li >
+ <a href="../properties/index.html">Working with Properties and Secondary Types</a>
+</li>
+
+
+
+<li >
+ <a href="../operation-context/index.html">Understanding the Operation Context</a>
+</li>
+
+
+
+<li >
+ <a href="../lists/index.html">Working with Lists, Paging and Skipping</a>
+</li>
+
+
+
+<li >
+ <a href="../extensions/index.html">Getting Extensions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Query <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../queries/index.html">Executing Queries</a>
+</li>
+
+
+
+<li >
+ <a href="../changelog/index.html">Retrieving the Change Log</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Access Control <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../allowable-actions/index.html">Checking Allowable Actions</a>
+</li>
+
+
+
+<li >
+ <a href="../access-control/index.html">Managing Access Control</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li >
+ <a href="../../about/index.html">About</a>
+ </li>
+
+
+ </ul>
+
+
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+ <i class="fa fa-search" aria-hidden="true"></i> Search
+ </a>
+ </li>
+
+ <li >
+ <a rel="next" href="../exceptions/index.html">
+ <i class="fa fa-arrow-left" aria-hidden="true"></i> Previous
+ </a>
+ </li>
+ <li >
+ <a rel="prev" href="../create-objects/index.html">
+ Next <i class="fa fa-arrow-right" aria-hidden="true"></i>
+ </a>
+ </li>
+
+ <li>
+ <a href="https://www.apache.org" style="padding: 2px;">
+ <img src="../../img/feather.png">
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+
+ <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
+ <ul class="nav bs-sidenav">
+
+ <li class="first-level active"><a href="#retrieving-objects">Retrieving Objects</a></li>
+
+ <li class="second-level"><a href="#getting-the-root-folder">Getting the Root Folder</a></li>
+
+
+ <li class="second-level"><a href="#getting-objects-by-id">Getting Objects by ID</a></li>
+
+
+ <li class="second-level"><a href="#getting-objects-by-path">Getting Objects by Path</a></li>
+
+
+ <li class="second-level"><a href="#getting-folder-children">Getting Folder Children</a></li>
+
+
+ <li class="second-level"><a href="#understanding-the-object-cache">Understanding the Object Cache</a></li>
+
+ <li class="third-level"><a href="#refresh-the-object-data-that-is-returned-from-getobject">Refresh the object data that is returned from getObject()</a></li>
+
+ <li class="third-level"><a href="#turn-off-the-session-cache-completely">Turn off the session cache completely</a></li>
+
+ <li class="third-level"><a href="#turn-off-caching-for-this-getobject-call">Turn off caching for this getObject() call</a></li>
+
+ <li class="third-level"><a href="#clear-the-session-cache">Clear the session cache</a></li>
+
+
+
+ </ul>
+</div></div>
+ <div class="col-md-9" role="main">
+
+<h1 id="retrieving-objects">Retrieving Objects</h1>
+<p><span class="cmis">CMIS 1.0</span>
+<span class="cmis">CMIS 1.1</span></p>
+<h2 id="getting-the-root-folder">Getting the Root Folder</h2>
+<p>All repositories have to provide a root folder. It’s the entry point for <a href="#getting-folder-children">browsing</a> the repository content. The root folder might be completely empty and useless for repositories that only support <abbr title="An object is called "unfiled" if it doesn't reside in a folder. Folders cannot be unfiled.">unfiled</abbr> objects.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Folder rootFolder = session.getRootFolder();
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IFolder rootFolder = Session.GetRootFolder();
+</code></pre>
+
+<h2 id="getting-objects-by-id">Getting Objects by ID</h2>
+<p>All objects in a repository must have a unique object ID and can be retrieved by this ID. If the user has no permissions to see the object, an <a href="../exceptions/index.html">objectNotFound</a> exception is thrown.</p>
+<p>Use an <a href="../operation-context/index.html">Operation Context</a> to define which details of the object should be returned.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">CmisObject cmisObject = session.getObject(id);
+
+if (cmisObject instanceof Document) {
+ Document document = (Document) cmisObject;
+} else if (cmisObject instanceof Folder) {
+ Folder folder = (Folder) cmisDocument;
+} else {
+ ...
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ICmisObject cmisObject = Session.GetObject(id);
+
+if (cmisObject is IDocument) {
+ IDocument document = cmisObject as IDocument;
+} else if (cmisObject is IFolder) {
+ IFolder folder = cmisDocument as IFolder;
+} else {
+ ...
+}
+</code></pre>
+
+<h2 id="getting-objects-by-path">Getting Objects by Path</h2>
+<p>A <abbr title="An object is called "filed" if it resides in one or more folders.">filed</abbr> object has one or more paths and can be retrieved by this path. If the user has no permissions to see the object, an <a href="../exceptions/index.html">objectNotFound</a> exception is thrown.</p>
+<p>Most repositories use the <strong>cmis:name</strong> property of the folders and the object to assemble the path. But it is possible that the path segments don’t match the names.</p>
+<p>Use an <a href="../operation-context/index.html">Operation Context</a> to define which details of the object should be returned.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">String path = "/User Homes/customer1/document.odt";
+CmisObject cmisObject = session.getObjectByPath(path);
+
+// get the object ID
+String id = cmisObject.getId();
+
+// we know it is a filable object, we just retrieved it by path
+FileableCmisObject fileableCmisObject = (FileableCmisObject) cmisObject;
+
+// get all paths, there must be at least one
+List<String> paths = fileableCmisObject.getPaths();
+
+// get all parent folders, there must be at least one
+List<Folder> parents = fileableCmisObject.getParents();
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">string path = "/User Homes/customer1/document.odt";
+ICmisObject cmisObject = Session.GetObjectByPath(path);
+
+// get the object ID
+string id = cmisObject.Id;
+
+// we know it is a filable object, we just retrieved it by path
+IFileableCmisObject fileableCmisObject = cmisObject as IFileableCmisObject;
+
+// get all paths, there must be at least one
+IList<string> paths = fileableCmisObject.Paths;
+
+// get all parent folders, there must be at least one
+IList<IFolder> parents = fileableCmisObject.Parents;
+</code></pre>
+
+<h2 id="getting-folder-children">Getting Folder Children</h2>
+<p>The page about <a href="../lists/index.html">lists</a> explains how paging works.</p>
+<p>Use an <a href="../operation-context/index.html">Operation Context</a> to define which details of the objects should be returned.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Folder folder = ...
+
+for (CmisObject child: folder.getChildren()) {
+ System.out.println(child.getName());
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IFolder folder = ...
+
+foreach (ICmisObject child in folder.GetChildren()) {
+ Console.WriteLine(child.Name);
+}
+</code></pre>
+
+<h2 id="understanding-the-object-cache">Understanding the Object Cache</h2>
+<p>By default, OpenCMIS and PortCMIS cache objects. That is, the object returned by <code>getObject()</code> or <code>getObjectbyPath()</code>
+can be stale. There are multiple ways to deal with that.</p>
+<h3 id="refresh-the-object-data-that-is-returned-from-getobject">Refresh the object data that is returned from <code>getObject()</code></h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">CmisObject cmisObject = session.getObject(id);
+cmisObject.refresh(); // contacts the repository and refreshes the object
+cmisObject.refreshIfOld(60 * 1000); // ... or refreshes the object only if the data is older than a minute
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ICmisObject cmisObject = Session.GetObject(id);
+cmisObject.Refresh(); // contacts the repository and refreshes the object
+cmisObject.RefreshIfOld(60 * 1000); // ... or refreshes the object only if the data is older than a minute
+</code></pre>
+
+<h3 id="turn-off-the-session-cache-completely">Turn off the session cache completely</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">session.getDefaultContext().setCacheEnabled(false);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">Session.DefaultContext.CacheEnabled = false;
+</code></pre>
+
+<h3 id="turn-off-caching-for-this-getobject-call">Turn off caching for this <code>getObject()</code> call</h3>
+<p>See also the page about the <a href="../operation-context/index.html">Operation Context</a>.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">OperationContext oc = session.createOperationContext();
+oc.setCacheEnabled(false);
+
+CmisObject cmisObject = session.getObject(id, oc);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IOperationContext oc = session.CreateOperationContext();
+oc.CacheEnabled = false;
+
+ICmisObject cmisObject = Session.GetObject(id, oc);
+</code></pre>
+
+<h3 id="clear-the-session-cache">Clear the session cache</h3>
+<p>This is not recommended!</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">session.clear();
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">Session.Clear();
+</code></pre></div>
+
+ </div>
+
+ <footer class="col-md-12 text-center">
+ <hr>
+ <p>
+ </footer>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script>hljs.initHighlightingOnLoad();</script>
+ <script>
+ var base_url = '../..';
+ </script>
+ <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
+ <script src="../../js/base.js"></script>
+
+ <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+ <div class="modal-dialog">
+ <div class="modal-content">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal">
+ <span aria-hidden="true">×</span>
+ <span class="sr-only">Close</span>
+ </button>
+ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
+ </div>
+ <div class="modal-body">
+ <p>
+ From here you can search these documents. Enter your search terms below.
+ </p>
+ <form role="form">
+ <div class="form-group">
+ <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
+ </div>
+ </form>
+ <div id="mkdocs-search-results"></div>
+ </div>
+ <div class="modal-footer">
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <script type="text/javascript" src="../../js/retina.min.js"></script>
+ </body>
+
+</html>
+<!-- last update: 2016-06-24 09:47:51.602914 -->
\ No newline at end of file
Added: chemistry/site/trunk/content/docs/cmis-samples/samples/types/index.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/samples/types/index.html?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/samples/types/index.html (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/samples/types/index.html Fri Jun 24 10:03:33 2016
@@ -0,0 +1,448 @@
+<!DOCTYPE html>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="author" content="Apache Chemistry">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Working with Types - Apache Chemistry Samples</title>
+
+ <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/cinder.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+
+
+ <link href="../../css/chemistry.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+</head>
+
+<body>
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+
+ <!-- Main title -->
+ <a class="navbar-brand" href="../../index.html">Apache Chemistry Samples</a>
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+
+
+ <li >
+ <a href="../../index.html">Home</a>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Repository <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../create-session/index.html">Creating a Session</a>
+</li>
+
+
+
+<li >
+ <a href="../capabilities/index.html">Getting Repository Capabilities</a>
+</li>
+
+
+
+<li class="active">
+ <a href="index.html">Working with Types</a>
+</li>
+
+
+
+<li >
+ <a href="../exceptions/index.html">CMIS Exceptions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CRUD <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../retrieve-objects/index.html">Retrieving Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../create-objects/index.html">Creating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../update-objects/index.html">Updating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../move-objects/index.html">Moving Object</a>
+</li>
+
+
+
+<li >
+ <a href="../delete-objects/index.html">Deleting Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../content/index.html">Working with Content</a>
+</li>
+
+
+
+<li >
+ <a href="../versions/index.html">Working with Versions</a>
+</li>
+
+
+
+<li >
+ <a href="../properties/index.html">Working with Properties and Secondary Types</a>
+</li>
+
+
+
+<li >
+ <a href="../operation-context/index.html">Understanding the Operation Context</a>
+</li>
+
+
+
+<li >
+ <a href="../lists/index.html">Working with Lists, Paging and Skipping</a>
+</li>
+
+
+
+<li >
+ <a href="../extensions/index.html">Getting Extensions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Query <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../queries/index.html">Executing Queries</a>
+</li>
+
+
+
+<li >
+ <a href="../changelog/index.html">Retrieving the Change Log</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Access Control <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../allowable-actions/index.html">Checking Allowable Actions</a>
+</li>
+
+
+
+<li >
+ <a href="../access-control/index.html">Managing Access Control</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li >
+ <a href="../../about/index.html">About</a>
+ </li>
+
+
+ </ul>
+
+
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+ <i class="fa fa-search" aria-hidden="true"></i> Search
+ </a>
+ </li>
+
+ <li >
+ <a rel="next" href="../capabilities/index.html">
+ <i class="fa fa-arrow-left" aria-hidden="true"></i> Previous
+ </a>
+ </li>
+ <li >
+ <a rel="prev" href="../exceptions/index.html">
+ Next <i class="fa fa-arrow-right" aria-hidden="true"></i>
+ </a>
+ </li>
+
+ <li>
+ <a href="https://www.apache.org" style="padding: 2px;">
+ <img src="../../img/feather.png">
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+
+ <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
+ <ul class="nav bs-sidenav">
+
+ <li class="first-level active"><a href="#working-with-types">Working with Types</a></li>
+
+ <li class="second-level"><a href="#getting-type-definitions">Getting Type Definitions</a></li>
+
+ <li class="third-level"><a href="#getting-a-specific-type-definition">Getting a Specific Type Definition</a></li>
+
+ <li class="third-level"><a href="#checking-whether-a-specific-type-definition-exists">Checking whether a Specific Type Definition Exists</a></li>
+
+ <li class="third-level"><a href="#browsing-type-definitions">Browsing Type Definitions</a></li>
+
+
+ <li class="second-level"><a href="#creating-updating-and-deleting-types">Creating, Updating, and Deleting Types</a></li>
+
+ <li class="third-level"><a href="#creating-a-type">Creating a Type</a></li>
+
+ <li class="third-level"><a href="#updating-a-type">Updating a Type</a></li>
+
+ <li class="third-level"><a href="#deleting-a-type">Deleting a Type</a></li>
+
+
+
+ </ul>
+</div></div>
+ <div class="col-md-9" role="main">
+
+<h1 id="working-with-types">Working with Types</h1>
+<h2 id="getting-type-definitions">Getting Type Definitions</h2>
+<p><span class="cmis">CMIS 1.0</span>
+<span class="cmis">CMIS 1.1</span>
+<span class="spec">Spec 2.1.3</span></p>
+<h3 id="getting-a-specific-type-definition">Getting a Specific Type Definition</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">ObjectType type = session.getTypeDefinition("cmis:document");
+
+if (type instanceof DocumentType) {
+ DocumentType docType = (DocumentType) type;
+ boolean isVersionable = docType.isVersionable();
+} else if (type instanceof RelationshipType) {
+ RelationshipType relType = (RelationshipType) type;
+} else {
+ ...
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IObjectType type = session.GetTypeDefinition("cmis:document");
+
+if (type is IDocumentType) {
+ IDocumentType docType = type as IDocumentType;
+ bool isVersionable = docType.Versionable;
+} else if (type is IRelationshipType) {
+ IRelationshipType relType = type as IRelationshipType;
+} else {
+ ...
+}
+</code></pre>
+
+<h3 id="checking-whether-a-specific-type-definition-exists">Checking whether a Specific Type Definition Exists</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">boolean typeExists = true;
+
+try {
+ session.getTypeDefinition("my:Type");
+}
+catch (CmisObjectNotFoundException e) {
+ typeExists = false;
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">bool typeExists = true;
+
+try {
+ session.GetTypeDefinition("my:Type");
+}
+catch (CmisObjectNotFoundException) {
+ typeExists = false;
+}
+</code></pre>
+
+<h3 id="browsing-type-definitions">Browsing Type Definitions</h3>
+<h2 id="creating-updating-and-deleting-types">Creating, Updating, and Deleting Types</h2>
+<p><span class="cmis">CMIS 1.1</span>
+<span class="spec">Spec 2.1.10</span></p>
+<div class="admonition note">
+<p class="admonition-title">Reading and Writing Type Definitions</p>
+<p>The class <code>TypeUtils</code> in OpenCMIS provides methods to read and write
+type defintions from XML and JSON. It also offers methods to check whether
+a type defintion is valid and complete.</p>
+</div>
+<h3 id="creating-a-type">Creating a Type</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">TypeDefinition typeDef = ...
+
+ObjectType createdType = session.createType(typeDef);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ITypeDefinition typeDef = ...
+
+IObjectType createdType = session.CreateType(typeDef);
+</code></pre>
+
+<h3 id="updating-a-type">Updating a Type</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">TypeDefinition typeDef = ...
+
+ObjectType updatedType = session.updateType(typeDef);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ITypeDefinition typeDef = ...
+
+IObjectType updatedType = session.UpdateType(typeDef);
+</code></pre>
+
+<h3 id="deleting-a-type">Deleting a Type</h3>
+<p>A type can only be deleted if no object of that type exists in the repository.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">session.deleteType("my:uselessType");
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">session.DeleteType("my:uselessType");
+</code></pre></div>
+
+ </div>
+
+ <footer class="col-md-12 text-center">
+ <hr>
+ <p>
+ </footer>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script>hljs.initHighlightingOnLoad();</script>
+ <script>
+ var base_url = '../..';
+ </script>
+ <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
+ <script src="../../js/base.js"></script>
+
+ <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+ <div class="modal-dialog">
+ <div class="modal-content">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal">
+ <span aria-hidden="true">×</span>
+ <span class="sr-only">Close</span>
+ </button>
+ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
+ </div>
+ <div class="modal-body">
+ <p>
+ From here you can search these documents. Enter your search terms below.
+ </p>
+ <form role="form">
+ <div class="form-group">
+ <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
+ </div>
+ </form>
+ <div id="mkdocs-search-results"></div>
+ </div>
+ <div class="modal-footer">
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <script type="text/javascript" src="../../js/retina.min.js"></script>
+ </body>
+
+</html>
+<!-- last update: 2016-06-24 09:47:51.545530 -->
\ No newline at end of file
Added: chemistry/site/trunk/content/docs/cmis-samples/samples/update-objects/index.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/samples/update-objects/index.html?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/samples/update-objects/index.html (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/samples/update-objects/index.html Fri Jun 24 10:03:33 2016
@@ -0,0 +1,415 @@
+<!DOCTYPE html>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="author" content="Apache Chemistry">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Updating Objects - Apache Chemistry Samples</title>
+
+ <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/cinder.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+
+
+ <link href="../../css/chemistry.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+</head>
+
+<body>
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+
+ <!-- Main title -->
+ <a class="navbar-brand" href="../../index.html">Apache Chemistry Samples</a>
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+
+
+ <li >
+ <a href="../../index.html">Home</a>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Repository <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../create-session/index.html">Creating a Session</a>
+</li>
+
+
+
+<li >
+ <a href="../capabilities/index.html">Getting Repository Capabilities</a>
+</li>
+
+
+
+<li >
+ <a href="../types/index.html">Working with Types</a>
+</li>
+
+
+
+<li >
+ <a href="../exceptions/index.html">CMIS Exceptions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CRUD <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../retrieve-objects/index.html">Retrieving Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../create-objects/index.html">Creating Objects</a>
+</li>
+
+
+
+<li class="active">
+ <a href="index.html">Updating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../move-objects/index.html">Moving Object</a>
+</li>
+
+
+
+<li >
+ <a href="../delete-objects/index.html">Deleting Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../content/index.html">Working with Content</a>
+</li>
+
+
+
+<li >
+ <a href="../versions/index.html">Working with Versions</a>
+</li>
+
+
+
+<li >
+ <a href="../properties/index.html">Working with Properties and Secondary Types</a>
+</li>
+
+
+
+<li >
+ <a href="../operation-context/index.html">Understanding the Operation Context</a>
+</li>
+
+
+
+<li >
+ <a href="../lists/index.html">Working with Lists, Paging and Skipping</a>
+</li>
+
+
+
+<li >
+ <a href="../extensions/index.html">Getting Extensions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Query <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../queries/index.html">Executing Queries</a>
+</li>
+
+
+
+<li >
+ <a href="../changelog/index.html">Retrieving the Change Log</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Access Control <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../allowable-actions/index.html">Checking Allowable Actions</a>
+</li>
+
+
+
+<li >
+ <a href="../access-control/index.html">Managing Access Control</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li >
+ <a href="../../about/index.html">About</a>
+ </li>
+
+
+ </ul>
+
+
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+ <i class="fa fa-search" aria-hidden="true"></i> Search
+ </a>
+ </li>
+
+ <li >
+ <a rel="next" href="../create-objects/index.html">
+ <i class="fa fa-arrow-left" aria-hidden="true"></i> Previous
+ </a>
+ </li>
+ <li >
+ <a rel="prev" href="../move-objects/index.html">
+ Next <i class="fa fa-arrow-right" aria-hidden="true"></i>
+ </a>
+ </li>
+
+ <li>
+ <a href="https://www.apache.org" style="padding: 2px;">
+ <img src="../../img/feather.png">
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+
+ <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
+ <ul class="nav bs-sidenav">
+
+ <li class="first-level active"><a href="#updating-objects">Updating Objects</a></li>
+
+ <li class="second-level"><a href="#updating-properties">Updating Properties</a></li>
+
+ <li class="third-level"><a href="#renaming-an-object">Renaming an Object</a></li>
+
+
+ <li class="second-level"><a href="#bulk-update">Bulk Update</a></li>
+
+
+ <li class="second-level"><a href="#updating-content">Updating Content</a></li>
+
+
+
+ </ul>
+</div></div>
+ <div class="col-md-9" role="main">
+
+<h1 id="updating-objects">Updating Objects</h1>
+<h2 id="updating-properties">Updating Properties</h2>
+<p><span class="cmis">CMIS 1.0</span>
+<span class="cmis">CMIS 1.1</span></p>
+<p>The page about <a href="../properties/index.html">properties</a> explains how Java and C# data types are map to CMIS data types.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="Java">CmisObject cmisObject = ...
+
+Map<String, Object> properties = new HashMap<String, Object>();
+
+properties.put("my:property", "new value"); // single-value property
+properties.put("my:int.property", 42);
+properties.put("my:date.property", new GregorianCalendar());
+properties.put("my:bool.property", true);
+
+List<String> shoppingList = new ArrayList<String>();
+shoppingList.add("milk");
+shoppingList.add("bread");
+shoppingList.add("cheese");
+properties.put("my:shopping.list", shoppingList); // multi-value property
+
+cmisObject.updateProperties(properties);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ICmisObject cmisObject = ...
+
+IDictonary<string, object> properties = new Dictonary<string, object>();
+
+properties.Add("my:property", "new value"); // single-value property
+properties.Add("my:int.property", 42);
+properties.Add("my:date.property", DateTime.Now);
+properties.Add("my:bool.property", true);
+
+IList<string> shoppingList = new List<string>();
+shoppingList.Add("milk");
+shoppingList.Add("bread");
+shoppingList.Add("cheese");
+properties.Add("my:shopping.list", shoppingList); // multi-value property
+
+cmisObject.UpdateProperties(properties);
+</code></pre>
+
+<h3 id="renaming-an-object">Renaming an Object</h3>
+<p>If you just want to change the <strong>cmis:name</strong> property, there is a shortcut.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="Java">CmisObject cmisObject = ....
+cmisObject.rename("new name");
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">ICmisObject cmisObject = ....
+cmisObject.Rename("new name");
+</code></pre>
+
+<h2 id="bulk-update">Bulk Update</h2>
+<p><span class="cmis">CMIS 1.1</span></p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="Java">// collect all objects to be updated
+List<CmisObject> objectList = new ArrayList<CmisObject>();
+objectList.add(doc1);
+objectList.add(doc2);
+objectList.add(doc3);
+
+// prepare properties
+Map<String, Object> properties = new HashMap<String, Object>();
+properties.put("my:project", "123456");
+properties.put("my:priority", 10);
+
+List<BulkUpdateObjectIdAndChangeToken> updatedIds = session.bulkUpdateProperties(objectList, properties, null, null);
+</code></pre>
+
+<h2 id="updating-content">Updating Content</h2>
+<p>See <a href="../content/index.html">Working with Content</a>.</p></div>
+
+ </div>
+
+ <footer class="col-md-12 text-center">
+ <hr>
+ <p>
+ </footer>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script>hljs.initHighlightingOnLoad();</script>
+ <script>
+ var base_url = '../..';
+ </script>
+ <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
+ <script src="../../js/base.js"></script>
+
+ <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+ <div class="modal-dialog">
+ <div class="modal-content">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal">
+ <span aria-hidden="true">×</span>
+ <span class="sr-only">Close</span>
+ </button>
+ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
+ </div>
+ <div class="modal-body">
+ <p>
+ From here you can search these documents. Enter your search terms below.
+ </p>
+ <form role="form">
+ <div class="form-group">
+ <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
+ </div>
+ </form>
+ <div id="mkdocs-search-results"></div>
+ </div>
+ <div class="modal-footer">
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <script type="text/javascript" src="../../js/retina.min.js"></script>
+ </body>
+
+</html>
+<!-- last update: 2016-06-24 09:47:51.666314 -->
\ No newline at end of file
Added: chemistry/site/trunk/content/docs/cmis-samples/samples/versions/index.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/samples/versions/index.html?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/samples/versions/index.html (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/samples/versions/index.html Fri Jun 24 10:03:33 2016
@@ -0,0 +1,481 @@
+<!DOCTYPE html>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="author" content="Apache Chemistry">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
+
+ <title>Working with Versions - Apache Chemistry Samples</title>
+
+ <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
+ <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="../../css/base.css" rel="stylesheet">
+ <link href="../../css/cinder.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/highlight.css">
+
+
+ <link href="../../css/chemistry.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+</head>
+
+<body>
+
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+
+ <!-- Main title -->
+ <a class="navbar-brand" href="../../index.html">Apache Chemistry Samples</a>
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+
+
+ <li >
+ <a href="../../index.html">Home</a>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Repository <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../create-session/index.html">Creating a Session</a>
+</li>
+
+
+
+<li >
+ <a href="../capabilities/index.html">Getting Repository Capabilities</a>
+</li>
+
+
+
+<li >
+ <a href="../types/index.html">Working with Types</a>
+</li>
+
+
+
+<li >
+ <a href="../exceptions/index.html">CMIS Exceptions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">CRUD <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../retrieve-objects/index.html">Retrieving Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../create-objects/index.html">Creating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../update-objects/index.html">Updating Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../move-objects/index.html">Moving Object</a>
+</li>
+
+
+
+<li >
+ <a href="../delete-objects/index.html">Deleting Objects</a>
+</li>
+
+
+
+<li >
+ <a href="../content/index.html">Working with Content</a>
+</li>
+
+
+
+<li class="active">
+ <a href="index.html">Working with Versions</a>
+</li>
+
+
+
+<li >
+ <a href="../properties/index.html">Working with Properties and Secondary Types</a>
+</li>
+
+
+
+<li >
+ <a href="../operation-context/index.html">Understanding the Operation Context</a>
+</li>
+
+
+
+<li >
+ <a href="../lists/index.html">Working with Lists, Paging and Skipping</a>
+</li>
+
+
+
+<li >
+ <a href="../extensions/index.html">Getting Extensions</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Query <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../queries/index.html">Executing Queries</a>
+</li>
+
+
+
+<li >
+ <a href="../changelog/index.html">Retrieving the Change Log</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Access Control <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+<li >
+ <a href="../allowable-actions/index.html">Checking Allowable Actions</a>
+</li>
+
+
+
+<li >
+ <a href="../access-control/index.html">Managing Access Control</a>
+</li>
+
+
+ </ul>
+ </li>
+
+
+
+ <li >
+ <a href="../../about/index.html">About</a>
+ </li>
+
+
+ </ul>
+
+
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+ <i class="fa fa-search" aria-hidden="true"></i> Search
+ </a>
+ </li>
+
+ <li >
+ <a rel="next" href="../content/index.html">
+ <i class="fa fa-arrow-left" aria-hidden="true"></i> Previous
+ </a>
+ </li>
+ <li >
+ <a rel="prev" href="../properties/index.html">
+ Next <i class="fa fa-arrow-right" aria-hidden="true"></i>
+ </a>
+ </li>
+
+ <li>
+ <a href="https://www.apache.org" style="padding: 2px;">
+ <img src="../../img/feather.png">
+ </a>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+
+ <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
+ <ul class="nav bs-sidenav">
+
+ <li class="first-level active"><a href="#working-with-versions">Working with Versions</a></li>
+
+ <li class="second-level"><a href="#retrieving-the-version-history">Retrieving the Version History</a></li>
+
+
+ <li class="second-level"><a href="#getting-the-latest-version">Getting the Latest Version</a></li>
+
+
+ <li class="second-level"><a href="#creating-versions">Creating Versions</a></li>
+
+ <li class="third-level"><a href="#check-out">Check-out</a></li>
+
+ <li class="third-level"><a href="#cancel-check-out">Cancel Check-out</a></li>
+
+ <li class="third-level"><a href="#check-in">Check-in</a></li>
+
+
+
+ </ul>
+</div></div>
+ <div class="col-md-9" role="main">
+
+<h1 id="working-with-versions">Working with Versions</h1>
+<p><span class="cmis">CMIS 1.0</span>
+<span class="cmis">CMIS 1.1</span>
+<span class="spec">Spec 2.1.13</span></p>
+<p>Only documents can be versioned and only if the type of the document is marked as versionable.</p>
+<p>To check whether a document type is verionable or not, use the following code.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">DocumentType documentType = (DocumentType) session.getTypeDefinition("my:documentType");
+boolean isVersionable = Boolean.TRUE.equals(documentType.isVersionable());
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocumentType documentType = session.GetTypeDefinition("my:documentType") as IDocumentType;
+bool isVersionable = documentType.Versionable == true;
+</code></pre>
+
+<h2 id="retrieving-the-version-history">Retrieving the Version History</h2>
+<p>The code snippets below show how to retrieve the version history of a document.
+The returned list is ordered by creation date (<strong>cmis:creationDate</strong>). The newest version is on the top of the list, the first version on the bottom.
+If the version series is checked-out, a <abbr title="Private Working Copy">PWC</abbr> exists and the user is allowed to see the <abbr title="Private Working Copy">PWC</abbr>, then this <abbr title="Private Working Copy">PWC</abbr> is the first entry in the list.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document document = ...
+
+for (Document version: document.getAllVersions())
+{
+ System.out.println(child.getVersionLabel());
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument document = ...
+
+foreach (IDocument version in document.GetAllVersions())
+{
+ Console.WriteLine(child.VersionLabel);
+}
+</code></pre>
+
+<h2 id="getting-the-latest-version">Getting the Latest Version</h2>
+<p>The version that has the most recent last modification date (<strong>cmis:lastModificationDate</strong>) is called the latest version of the version series.</p>
+<p>If you already have a version document object from a version series, you can test if it is the latest version and if not, get the latest version.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The test if the document is the latest verion depends on the property <strong>cmis:isLatestVersion</strong>.
+The property has to loaded with document object to make this check work. See the page about the <a href="../operation-context/index.html">Operation Context</a> to learn how to accomplish that.</p>
+</div>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document document = ...
+Document latest;
+
+if (Boolean.TRUE.equals(document.isLatestVersion())) {
+ latest = document;
+} else {
+ latest = document.getObjectOfLatestVersion(false); // major = false
+}
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument document = ...
+IDocument latest;
+
+if (document.LatestVersion == true) {
+ latest = document;
+} else {
+ latest = document.GetObjectOfLatestVersion(false); // major = false
+}
+</code></pre>
+
+<p>If you only have a document ID, you can use the following code to get latest version.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document latest = session.getLatestDocumentVersion(docId);
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument latest = Session.GetLatestDocumentVersion(docId);
+</code></pre>
+
+<h2 id="creating-versions">Creating Versions</h2>
+<p>To create a new version, the version series has to be checked out, updated and checked in.
+Many repositories allow a check out only on the latest version.</p>
+<p>The check-out creates a <abbr title="Private Working Copy">PWC</abbr> (Private Working Copy). The <abbr title="Private Working Copy">PWC</abbr> can (usually) only be seen and updated by the user who checked out the version series. There can be only one <abbr title="Private Working Copy">PWC</abbr> per version series, which means that version series is locked while it is checked out.</p>
+<p>To check if a version series is already checked out, use this snippet.</p>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document document = ...
+
+boolean isCheckedOut = Boolean.TRUE.equals(document.isVersionSeriesCheckedOut());
+String checkedOutBy = document.getVersionSeriesCheckedOutBy(); // not all repositories provide this
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument document = ...
+
+bool isCheckedOut = document.IsVersionSeriesCheckedOut == true;
+string checkedOutBy = document.VersionSeriesCheckedOutBy; // not all repositories provide this
+</code></pre>
+
+<h3 id="check-out">Check-out</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document document = ...
+
+ObjectId pwcId = document.checkOut();
+Document pwc = session.getObject(pwcId); // get PWC document
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument document = ...
+
+IObjectId pwcId = document.CheckOut();
+IDocument pwc = session.GetObject(pwcId); // get PWC document
+</code></pre>
+
+<h3 id="cancel-check-out">Cancel Check-out</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document pwc = ...
+
+pwc.cancelCheckOut();
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument pwc = ...
+
+pwc.CancelCheckOut();
+</code></pre>
+
+<h3 id="check-in">Check-in</h3>
+<p class="opencmis">OpenCMIS (Java)</p>
+<pre><code class="java">Document pwc = ...
+
+ObjectId newVersionId = pwc.checkIn(true, null, null, "new version");
+</code></pre>
+
+<p class="portcmis">PortCMIS (C#)</p>
+<pre><code class="csharp">IDocument pwc = ...
+
+IObjectId newVersionId = pwc.CheckIn(true, null, null, "new version");
+</code></pre></div>
+
+ </div>
+
+ <footer class="col-md-12 text-center">
+ <hr>
+ <p>
+ </footer>
+
+ <script src="../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../js/highlight.pack.js"></script>
+ <script>hljs.initHighlightingOnLoad();</script>
+ <script>
+ var base_url = '../..';
+ </script>
+ <script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
+ <script src="../../js/base.js"></script>
+
+ <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+ <div class="modal-dialog">
+ <div class="modal-content">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal">
+ <span aria-hidden="true">×</span>
+ <span class="sr-only">Close</span>
+ </button>
+ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
+ </div>
+ <div class="modal-body">
+ <p>
+ From here you can search these documents. Enter your search terms below.
+ </p>
+ <form role="form">
+ <div class="form-group">
+ <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
+ </div>
+ </form>
+ <div id="mkdocs-search-results"></div>
+ </div>
+ <div class="modal-footer">
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <script type="text/javascript" src="../../js/retina.min.js"></script>
+ </body>
+
+</html>
+<!-- last update: 2016-06-24 09:47:51.776472 -->
\ No newline at end of file
Added: chemistry/site/trunk/content/docs/cmis-samples/sitemap.xml
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/sitemap.xml?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/sitemap.xml (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/sitemap.xml Fri Jun 24 10:03:33 2016
@@ -0,0 +1,150 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+
+
+ <url>
+ <loc>None/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+ <url>
+ <loc>None/samples/create-session/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/capabilities/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/types/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/exceptions/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+
+ <url>
+ <loc>None/samples/retrieve-objects/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/create-objects/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/update-objects/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/move-objects/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/delete-objects/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/content/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/versions/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/properties/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/operation-context/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/lists/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/extensions/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+
+ <url>
+ <loc>None/samples/queries/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/changelog/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+
+ <url>
+ <loc>None/samples/allowable-actions/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+ <url>
+ <loc>None/samples/access-control/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+
+
+ <url>
+ <loc>None/about/index.html</loc>
+ <lastmod>2016-06-24</lastmod>
+ <changefreq>daily</changefreq>
+ </url>
+
+
+</urlset>
\ No newline at end of file
Added: chemistry/site/trunk/content/docs/cmis-samples/toc.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/docs/cmis-samples/toc.html?rev=1750066&view=auto
==============================================================================
--- chemistry/site/trunk/content/docs/cmis-samples/toc.html (added)
+++ chemistry/site/trunk/content/docs/cmis-samples/toc.html Fri Jun 24 10:03:33 2016
@@ -0,0 +1,13 @@
+<div class="bs-sidebar hidden-print affix well" role="complementary">
+ <ul class="nav bs-sidenav">
+ {% for toc_item in toc %}
+ <li class="first-level {% if toc_item.active %}active{% endif %}"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+ {% for toc_item in toc_item.children %}
+ <li class="second-level"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+ {% for toc_item in toc_item.children %}
+ <li class="third-level"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+ {% endfor %}
+ {% endfor %}
+ {% endfor %}
+ </ul>
+</div>
Modified: chemistry/site/trunk/content/dotnet/dotcmis.mdtext
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/dotnet/dotcmis.mdtext?rev=1750066&r1=1750065&r2=1750066&view=diff
==============================================================================
--- chemistry/site/trunk/content/dotnet/dotcmis.mdtext (original)
+++ chemistry/site/trunk/content/dotnet/dotcmis.mdtext Fri Jun 24 10:03:33 2016
@@ -34,12 +34,9 @@ While downloading the packages, make you
<a name="DotCMIS-Documentation"></a>
## Documentation
-There are starter code snippets on the [Getting started with DotCMIS](getting-started-with-dotcmis.html) page and the [PowerShell Example](powershell-example.html) page.
+There are starter code snippets on the [Getting started with DotCMIS](getting-started-with-dotcmis.html) page, the [Apache Chemistry Code Samples page](/docs/cmis-samples), and the [PowerShell Example](powershell-example.html) page.
The API documentation is available as a CHM Help file in the binary release package. A session parameter overview is available on the [Session Parameters](session-parameters.html) page.
-The interfaces are very similar to the [OpenCMIS](/java/opencmis.html) client API. Please see the
-OpenCMIS documentation for more insights.
-
<a name="DotCMIS-Sourcecodeanddependencies"></a>
## Source code, dependencies and development binaries
Modified: chemistry/site/trunk/content/dotnet/portcmis.mdtext
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/content/dotnet/portcmis.mdtext?rev=1750066&r1=1750065&r2=1750066&view=diff
==============================================================================
--- chemistry/site/trunk/content/dotnet/portcmis.mdtext (original)
+++ chemistry/site/trunk/content/dotnet/portcmis.mdtext Fri Jun 24 10:03:33 2016
@@ -49,9 +49,7 @@ While downloading the packages, make you
<a name="DotCMIS-Documentation"></a>
## Documentation
-tbd.
-
-Please refer to the [DotCMIS documentation](/dotnet/dotcmis.html) for now. The APIs are very similar.
+See the [Apache Chemistry Code Samples page](/docs/cmis-samples).
<a name="PortCMIS-Sourcecodeanddependencies"></a>
Modified: chemistry/site/trunk/templates/navigation_bar.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/templates/navigation_bar.html?rev=1750066&r1=1750065&r2=1750066&view=diff
==============================================================================
--- chemistry/site/trunk/templates/navigation_bar.html (original)
+++ chemistry/site/trunk/templates/navigation_bar.html Fri Jun 24 10:03:33 2016
@@ -29,9 +29,7 @@
<UL class="alternate" type="square">
<LI><A href="/java/opencmis.html" title="OpenCMIS Overview and Index">Overview</A></LI>
<LI><A href="/java/download.html" title="Downloads">Downloads</A></LI>
- <LI><A href="/java/developing/index.html" title="Developing">Developing with OpenCMIS</A></LI>
- <LI><A href="/java/examples/index.html" title="Example Code">Example Code</A></LI>
- <LI><A href="/java/how-to/index.html" title="OpenCMIS HowTos">OpenCMIS HowTos</A></LI>
+ <LI><A href="/docs/cmis-samples/" title="Downloads">Code Samples</A></LI>
<LI><A href="/java/0.14.0/maven/apidocs/" rel="nofollow">JavaDoc</A></LI>
<LI><A href="https://svn.apache.org/repos/asf/chemistry/opencmis/trunk/" class="external-link" rel="nofollow">Source Code</A></LI>
</UL>
@@ -61,6 +59,7 @@
<LI><A href="https://svn.apache.org/repos/asf/chemistry/dotcmis/trunk/" class="external-link" rel="nofollow">DotCMIS Source Code</A></LI>
<LI><A href="/dotnet/portcmis.html" title="PortCMIS">PortCMIS</A></LI>
<LI><A href="https://svn.apache.org/repos/asf/chemistry/portcmis/trunk/" class="external-link" rel="nofollow">PortCMIS Source Code</A></LI>
+ <LI><A href="/docs/cmis-samples/" title="Downloads">Code Samples</A></LI>
</UL>
Modified: chemistry/site/trunk/templates/standard.html
URL: http://svn.apache.org/viewvc/chemistry/site/trunk/templates/standard.html?rev=1750066&r1=1750065&r2=1750066&view=diff
==============================================================================
--- chemistry/site/trunk/templates/standard.html (original)
+++ chemistry/site/trunk/templates/standard.html Fri Jun 24 10:03:33 2016
@@ -38,25 +38,15 @@
<tr width="100%">
<td id="cell-1-0"> </td>
<td id="cell-1-1">
- <div style="padding: 0px;">
- <div id="banner">
+ <div id="banner" style="padding: 0px;">
<!-- Banner -->
-<TABLE border="0" cellpadding="0" cellspacing="0" width="100%">
-<TR>
-<TD align="left" class="topbardiv" nowrap="">
- <A href="https://chemistry.apache.org/" title="Apache Chemistry">
- <IMG border="0" src="/images/chemistry_tm_logo.png"/>
- </A>
-</TD>
-<TD align="right" nowrap="">
- <A href="https://www.apache.org/" title="The Apache Software Foundation">
- <IMG border="0" src="/images/asf-logo.png"/>
- </A>
-</TD>
-</TR>
-</TABLE>
+ <A href="https://chemistry.apache.org/" title="Apache Chemistry">
+ <IMG src="/images/chemistry_tm_logo.png" style="float:left; border:0px;"/>
+ </A>
+ <A href="https://www.apache.org/" title="The Apache Software Foundation">
+ <IMG src="/images/asf-logo.png" style="float:right; border:0px;/>
+ </A>
<!-- Banner -->
- </div>
</div>
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">