Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 27CCE200CE1 for ; Thu, 31 Aug 2017 16:30:46 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 264D216B31D; Thu, 31 Aug 2017 14:30:46 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id CCCD116B314 for ; Thu, 31 Aug 2017 16:30:44 +0200 (CEST) Received: (qmail 3538 invoked by uid 500); 31 Aug 2017 14:30:44 -0000 Mailing-List: contact commits-help@chemistry.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@chemistry.apache.org Delivered-To: mailing list commits@chemistry.apache.org Received: (qmail 3507 invoked by uid 99); 31 Aug 2017 14:30:43 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 31 Aug 2017 14:30:43 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id DC24B3A03A6 for ; Thu, 31 Aug 2017 14:30:41 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1017523 [5/10] - in /websites/staging/chemistry/trunk/content: ./ python/ python/docs/ python/docs/_sources/ python/docs/_static/ Date: Thu, 31 Aug 2017 14:30:40 -0000 To: commits@chemistry.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20170831143041.DC24B3A03A6@svn01-us-west.apache.org> archived-at: Thu, 31 Aug 2017 14:30:46 -0000 Modified: websites/staging/chemistry/trunk/content/python/docs/about.html ============================================================================== --- websites/staging/chemistry/trunk/content/python/docs/about.html (original) +++ websites/staging/chemistry/trunk/content/python/docs/about.html Thu Aug 31 14:30:39 2017 @@ -1,5 +1,3 @@ - - @@ -8,30 +6,32 @@ - About Apache Chemistry cmislib — Apache Chemistry cmislib 0.5.1 documentation + About Apache Chemistry cmislib — Apache Chemistry cmislib 0.6.0 documentation - + - + + - -
+ +
-
+

About Apache Chemistry cmislib¶

@@ -62,8 +62,8 @@
The library is being developed with the following guidelines:
  • Developers using this API should be able to work with CMIS domain objects without having to worry about the underlying implementation details.
    • -
  • The library will use the Resftul AtomPub Binding.
    • -
  • The library will conform to the CMIS spec as closely as possible. Several public CMIS repositories are being used to test the API.
    • +
  • The library will use the Resftul AtomPub Binding and the Browser Binding (added with CMIS 1.1).
    • +
  • The library will conform to the CMIS spec as closely as possible. Several public CMIS repositories are being used to test the API.
  • The library should have no hard-coded URL’s. It should be able to get everything it needs regarding how to work with the CMIS service from the CMIS service URL response and subsequent calls.
  • There shouldn’t have to be a vendor-specific version of this library. The goal is for it to be interoperable with CMIS-compliant providers.
@@ -73,11 +73,11 @@

Quick Example¶

This should give you an idea of how easy and natural it is to work with the API:
-
>>> cmisClient = cmislib.CmisClient('http://localhost:8080/alfresco/cmisatom', 'admin', 'admin')
+
>>> cmisClient = cmislib.CmisClient('http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom', 'admin', 'admin')
 >>> repo = cmisClient.defaultRepository
 >>> rootFolder = repo.rootFolder
 >>> children = rootFolder.getChildren()
->>> newFolder = rootFolder.createFolder('testDeleteFolder folder')
+>>> newFolder = rootFolder.createFolder('testDeleteFolder folder')
 >>> props = newFolder.properties
 >>> newFolder.delete()
 

@@ -85,50 +85,18 @@
-
-

To-Do’s¶

-
-
Miscellaneous
-
    -
  • createDocumentFromSource
    • -
  • getProperties filter
    • -
  • getContentStream stream id
    • -
-
-
Unfiling/multifiling support
-
    -
  • createDocument without a parent folder (unfiled)
    • -
-
-
    -
  • The spec does not yet support this. Although the spec does say that a folder ID is optional, it does not specify which URL to post the unfiled document to.
    • -
-
-
-
Policies
-
    -
  • Policy object
    • -
  • createPolicy
    • -
  • applyPolicy
    • -
  • removePolicy
    • -
  • getAppliedPolicies
    • -
-
-
-
-
+ -
+ -
- © Copyright 2013, Apache Software Foundation. - Created using Sphinx 1.1.3. + \ No newline at end of file Added: websites/staging/chemistry/trunk/content/python/docs/bindings.html ============================================================================== --- websites/staging/chemistry/trunk/content/python/docs/bindings.html (added) +++ websites/staging/chemistry/trunk/content/python/docs/bindings.html Thu Aug 31 14:30:39 2017 @@ -0,0 +1,292 @@ + + + + + + + + Bindings — Apache Chemistry cmislib 0.6.0 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Bindings¶

+

The CMIS specification supports multiple bindings. You can think of a binding as +a communication protocol. The specification provides for three bindings:

+
+
    +
  • Atom Pub
    • +
  • Browser (JSON)
    • +
  • Web Services (SOAP)
    • +
+
+

Although the spec supports three, cmislib supports only two of these bindings: +Atom Pub and Browser.

+

When instantiating a CmisClient, if you do not specify a binding, cmislib +will use the Atom Pub binding, by default.

+

To use a different binding, such as the Browser binding, import it, then pass it +to the CmisClient constructor, like this:

+
>>> from cmislib.browser.binding import BrowserBinding
+>>> client = CmisClient('http://localhost:8080/alfresco/api/-default-/cmis/versions/1.1/browser', 'admin', 'admin', binding=BrowserBinding())
+
+
+

Make sure you specify the appropriate service URL for the binding you’ve chosen, +otherwise cmislib will be unable to parse the response appropriately.

+

Each of the two bindings modules contain implementations of the classes defined +in cmislib.domain. So, for example, if you execute a query that returns +documents and you are using the Atom Pub binding, what you’ll get back are instances +of cmislib.atompub.AtomPubDocument which implements cmislib.domain.Document.

+
+

The cmislib.atompub Module¶

+
+
+class cmislib.atompub.AtomPubBinding(**kwargs)¶
+

The binding responsible for talking to the CMIS server via the AtomPub +Publishing Protocol.

+
+
+delete(url, username, password, **kwargs)¶
+

Does a delete against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, to delete a folder you’d call Folder.delete and +to delete a document you’d call Document.delete.

+
+ +
+
+get(url, username, password, **kwargs)¶
+

Does a get against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, if you need to get a specific object by object id, try +Repository.getObject. If you have a path instead of an object +id, use Repository.getObjectByPath. Or, you could start with +the root folder (Repository.getRootFolder) and drill down from +there.

+
+ +
+
+post(url, username, password, payload, contentType, **kwargs)¶
+

Does a post against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, to update the properties on an object, you’d call +CmisObject.updateProperties. Or, to check in a document that’s +been checked out, you’d call Document.checkin on the PWC.

+
+ +
+
+put(url, username, password, payload, contentType, **kwargs)¶
+

Does a put against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, to update the properties on an object, you’d call +CmisObject.updateProperties. Or, to check in a document that’s +been checked out, you’d call Document.checkin on the PWC.

+
+ +
+ +
+
+class cmislib.atompub.RepositoryService¶
+

The repository service for the AtomPub binding.

+
+
+getDefaultRepository(client)¶
+

Returns the default repository for the server via the AtomPub binding.

+
+ +
+
+getRepositories(client)¶
+

Get all of the repositories provided by the server.

+
+ +
+
+getRepository(client, repositoryId)¶
+

Get the repository for the specified repositoryId.

+
+ +
+
+reload(obj)¶
+

Reloads the state of the repository object.

+
+ +
+ +
+
+

The cmislib.browser Module¶

+
+
+class cmislib.browser.BrowserBinding(**kwargs)¶
+

Implements the Browser Binding to communicate with the CMIS server. The +Browser Binding uses only GET and POST. It sends JSON and HTML forms and +gets back JSON.

+
+
+get(url, username, password, **kwargs)¶
+

Does a get against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, if you need to get a specific object by object id, try +Repository.getObject. If you have a path instead of an object +id, use Repository.getObjectByPath. Or, you could start with +the root folder (Repository.getRootFolder) and drill down from +there.

+
+ +
+
+post(url, payload, contentType, username, password, **kwargs)¶
+

Does a post against the CMIS service. More than likely, you will not +need to call this method. Instead, let the other objects do it for you.

+

For example, to update the properties on an object, you’d call +CmisObject.updateProperties. Or, to check in a document that’s +been checked out, you’d call Document.checkin on the PWC.

+
+ +
+ +
+
+class cmislib.browser.RepositoryService¶
+

Defines the repository service for the Browser Binding.

+
+
+getDefaultRepository(client)¶
+

Gets the default repository for this server. The spec doesn’t include +the notion of a default, so this just returns the first one in the +list.

+
+ +
+
+getRepositories(client)¶
+

Gets all of the repositories for this client.

+
+ +
+
+getRepository(client, repositoryId)¶
+

Gets the repository for the specified repository ID.

+
+ +
+ +
+
+ + +
+
+
+ +
+
+ + + + \ No newline at end of file