[CMIS-388] OpenCMIS Client API Developer's Guide

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: OpenCMIS 0.3.0, OpenCMIS 0.4.0
• Fix Version/s: OpenCMIS 0.4.0
• Component/s: opencmis-client
• Labels: documentation

Environment

All

• Assignee: Florian Müller
• Reporter: Tim Raff
• Created: 10/Jun/11 13:58
• Updated: 29/Jun/11 09:34
• Resolved: 22/Jun/11 10:58

Description

We've written a proposed guide for software engineers who want to use the Apache Chemistry OpenCMIS client to access CMIS-complaint content repositories from java code. It includes working example applications that should run against any repository.

I've attached an initial draft of the proposed guide and the examples to this JIRA. The guide is written in markdown so it can be integrated into the chemistry website.

The guide currently has 4 parts :-

1. The Basics - A brief introduction to CMIS and a practical "hello world" sample. Developers would read this section to find out how to build, install and run a sample OpenCMIS application using Apache Chemistry.

2.Getting Started with OpenCMIS - quick, practical examples of the the most commonly needed CMIS function.

3. OpenCMIS Programming patterns - information and practical examples of exceptions, operation context, etc.

4.Advanced CMIS features - the rest of the CMIS API

To take a look at the guide and samples unzip the attached file and take a look at guide.html. This describes how to build the two maven projects chemistry-opencmis-hello, and chemistry-opencmis-getting-started which are the examples, which should build, run and produce eclipse projects successfully when the guide instructions are followed.