Chemistry
  1. Chemistry
  2. CMIS-388

OpenCMIS Client API Developer's Guide

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major 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:
    • Environment:

      All

      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.

        Activity

        Tim Raff created issue -
        Hide
        Tim Raff added a comment -

        Proposed developer's guide and samples

        Show
        Tim Raff added a comment - Proposed developer's guide and samples
        Tim Raff made changes -
        Field Original Value New Value
        Attachment chemistry-adg.zip [ 12482061 ]
        Hide
        Florian Müller added a comment -
        Show
        Florian Müller added a comment - The guide is here: http://chemistry.apache.org/java/developing/guide.html
        Florian Müller made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Assignee Florian Müller [ fmui ]
        Resolution Fixed [ 1 ]
        Hide
        jay brown added a comment -

        This is a great document!
        One comment on the section 'Updating a document' about a 1/3 of the way through. This section should mention that this sample code might not work for repositories that require a checkout before setting the content stream. Then refer to the appropriate section in 'Advanced CMIS features' where this subject is discussed in detail for more info.

        Show
        jay brown added a comment - This is a great document! One comment on the section 'Updating a document' about a 1/3 of the way through. This section should mention that this sample code might not work for repositories that require a checkout before setting the content stream. Then refer to the appropriate section in 'Advanced CMIS features' where this subject is discussed in detail for more info.
        Hide
        Tim Raff added a comment -

        Thanks Jay - useful suggestion - I'll update the guide.

        Show
        Tim Raff added a comment - Thanks Jay - useful suggestion - I'll update the guide.

          People

          • Assignee:
            Florian Müller
            Reporter:
            Tim Raff
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development