You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@chemistry.apache.org by "Tim Raff (JIRA)" <ji...@apache.org> on 2011/06/10 15:58:59 UTC

[jira] [Created] (CMIS-388) OpenCMIS Client API Developer's Guide

OpenCMIS Client API Developer's Guide
-------------------------------------

                 Key: CMIS-388
                 URL: https://issues.apache.org/jira/browse/CMIS-388
             Project: Chemistry
          Issue Type: Improvement
          Components: opencmis-client
    Affects Versions: OpenCMIS 0.3.0, OpenCMIS 0.4.0
         Environment: All
            Reporter: Tim Raff
             Fix For: OpenCMIS 0.4.0


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.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Resolved] (CMIS-388) OpenCMIS Client API Developer's Guide

Posted by "Florian Müller (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CMIS-388?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Florian Müller resolved CMIS-388.
---------------------------------

    Resolution: Fixed
      Assignee: Florian Müller

The guide is here: http://chemistry.apache.org/java/developing/guide.html

> OpenCMIS Client API Developer's Guide
> -------------------------------------
>
>                 Key: CMIS-388
>                 URL: https://issues.apache.org/jira/browse/CMIS-388
>             Project: Chemistry
>          Issue Type: Improvement
>          Components: opencmis-client
>    Affects Versions: OpenCMIS 0.3.0, OpenCMIS 0.4.0
>         Environment: All
>            Reporter: Tim Raff
>            Assignee: Florian Müller
>              Labels: documentation
>             Fix For: OpenCMIS 0.4.0
>
>         Attachments: chemistry-adg.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Updated] (CMIS-388) OpenCMIS Client API Developer's Guide

Posted by "Tim Raff (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CMIS-388?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tim Raff updated CMIS-388:
--------------------------

    Attachment: chemistry-adg.zip

Proposed developer's guide and samples

> OpenCMIS Client API Developer's Guide
> -------------------------------------
>
>                 Key: CMIS-388
>                 URL: https://issues.apache.org/jira/browse/CMIS-388
>             Project: Chemistry
>          Issue Type: Improvement
>          Components: opencmis-client
>    Affects Versions: OpenCMIS 0.3.0, OpenCMIS 0.4.0
>         Environment: All
>            Reporter: Tim Raff
>              Labels: documentation
>             Fix For: OpenCMIS 0.4.0
>
>         Attachments: chemistry-adg.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (CMIS-388) OpenCMIS Client API Developer's Guide

Posted by "Tim Raff (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CMIS-388?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13057125#comment-13057125 ] 

Tim Raff commented on CMIS-388:
-------------------------------

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

> OpenCMIS Client API Developer's Guide
> -------------------------------------
>
>                 Key: CMIS-388
>                 URL: https://issues.apache.org/jira/browse/CMIS-388
>             Project: Chemistry
>          Issue Type: Improvement
>          Components: opencmis-client
>    Affects Versions: OpenCMIS 0.3.0, OpenCMIS 0.4.0
>         Environment: All
>            Reporter: Tim Raff
>            Assignee: Florian Müller
>              Labels: documentation
>             Fix For: OpenCMIS 0.4.0
>
>         Attachments: chemistry-adg.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Commented] (CMIS-388) OpenCMIS Client API Developer's Guide

Posted by "jay brown (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CMIS-388?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13055787#comment-13055787 ] 

jay brown commented on CMIS-388:
--------------------------------

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. 

> OpenCMIS Client API Developer's Guide
> -------------------------------------
>
>                 Key: CMIS-388
>                 URL: https://issues.apache.org/jira/browse/CMIS-388
>             Project: Chemistry
>          Issue Type: Improvement
>          Components: opencmis-client
>    Affects Versions: OpenCMIS 0.3.0, OpenCMIS 0.4.0
>         Environment: All
>            Reporter: Tim Raff
>            Assignee: Florian Müller
>              Labels: documentation
>             Fix For: OpenCMIS 0.4.0
>
>         Attachments: chemistry-adg.zip
>
>
> 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.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira