Return-Path: X-Original-To: apmail-incubator-connectors-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-connectors-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4B2AC738B for ; Wed, 31 Aug 2011 10:51:18 +0000 (UTC) Received: (qmail 65601 invoked by uid 500); 31 Aug 2011 10:51:18 -0000 Delivered-To: apmail-incubator-connectors-commits-archive@incubator.apache.org Received: (qmail 65542 invoked by uid 500); 31 Aug 2011 10:51:16 -0000 Mailing-List: contact connectors-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: connectors-dev@incubator.apache.org Delivered-To: mailing list connectors-commits@incubator.apache.org Received: (qmail 65535 invoked by uid 99); 31 Aug 2011 10:51:16 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 31 Aug 2011 10:51:16 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 31 Aug 2011 10:51:14 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 01CB0238888F; Wed, 31 Aug 2011 10:50:54 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1163569 - in /incubator/lcf/trunk: ./ site/src/documentation/content/xdocs/ site/src/documentation/resources/images/ Date: Wed, 31 Aug 2011 10:50:53 -0000 To: connectors-commits@incubator.apache.org From: piergiorgio@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110831105054.01CB0238888F@eris.apache.org> Author: piergiorgio Date: Wed Aug 31 10:50:53 2011 New Revision: 1163569 URL: http://svn.apache.org/viewvc?rev=1163569&view=rev Log: added the end-user documentation for the CMIS Connector Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png (with props) incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png (with props) Modified: incubator/lcf/trunk/CHANGES.txt incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml Modified: incubator/lcf/trunk/CHANGES.txt URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/CHANGES.txt?rev=1163569&r1=1163568&r2=1163569&view=diff ============================================================================== --- incubator/lcf/trunk/CHANGES.txt (original) +++ incubator/lcf/trunk/CHANGES.txt Wed Aug 31 10:50:53 2011 @@ -3,6 +3,9 @@ $Id$ ======================= 0.3-dev ========================= +CONNECTORS-229: CMIS connector needs to be documented in "how to build and deploy" +(Piergiorgio Lucidi) + CONNECTORS-244: Add a fix to recover for another Derby deadlock situation. (Karl Wright) Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml?rev=1163569&r1=1163568&r2=1163569&view=diff ============================================================================== --- incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml (original) +++ incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml Wed Aug 31 10:50:53 2011 @@ -681,6 +681,34 @@

If you need specific ManifoldCF logging information, contact your system integrator.

+
+ CMIS Authority Connection +

A CMIS authority connection is required for enforcing security for documents retrieved from CMIS repositories.

+

The CMIS specification includes the concept of authorities only depending on a specific document, this authority connector is only based on a regular expression comparator.

+

A CMIS authority connection has the following special tabs you will need to configure: the "Repository" tab and the "User Mapping" tab. The "Repository" tab looks like this:

+

+
+

+

The repository configuration will be only used to track an ID for a specific CMIS repository. No calls will be performed against the CMIS repository.

+

+

The second tab that you need to configure is the "User Mapping" tab that allows you to define a regular expression to specify the user mapping.

+

The "User Mapping" tab looks like the following:

+

+
+

+

The purpose of the "User Mapping" tab is to allow you to map the incoming user name and domain (usually from Active Directory) to its CMIS user equivalent. + The mapping consists of a match expression, which is a regular expression where parentheses ("(" + and ")") mark sections you are interested in, and a replace string. The sections marked with parentheses are called "groups" in regular expression parlance. The replace string consists of constant text plus + substitutions of the groups from the match, perhaps modified. For example, "$(1)" refers to the first group within the match, while "$(1l)" refers to the first match group + mapped to lower case. Similarly, "$(1u)" refers to the same characters, but mapped to upper case.

+

For example, a match expression of ^(.*)\@([A-Z|a-z|0-9|_|-]*)\.(.*)$ with a replace string of $(2)\$(1l) would convert an AD username of + MyUserName@subdomain.domain.com into the LiveLink user name subdomain\myusername.

+

When you are done, click the "Save" button. You will then see a summary and status for the authority connection:

+

+
+

+
+
@@ -1595,6 +1623,45 @@

If more than one rule is present, the rules are all executed in sequence. That is, the output of the first rule is modified by the second rule, etc.

+
+ CMIS Repository Connection +

The CMIS Repository Connection type allows you to index content from any CMIS-compliant repository.

+

By default each CMIS Connection manages a single CMIS repository, this means that if you have multiple CMIS repositories exposed by a single endpoint, you need to create a specific connection for each CMIS repository.

+

+

A CMIS connection has the following configuration parameters on the repository connection editing screen:

+

+
+

+

Select the correct CMIS binding protocol (AtomPub or Web Services) and enter the correct username, password and the endpoint to reference the CMIS document server services.

+

The endpoint consists of the HTTP protocol, hostname, port and the context path of the CMIS service exposed by the CMIS server:

+

+

http://HOSTNAME:PORT/CMIS_CONTEXT_PATH

+

+

Optionally you can provide the repository ID to select one of the exposed CMIS repository, if this parameter is null the CMIS Connector will consider the first CMIS repository exposed by the CMIS server.

+

+

Note that, in a CMIS system, a specific binding protocol has its own context path, this means that the endpoints are different:

+

for example the endpoint of the AtomPub binding exposed by the actual version of the InMemory Server provided by the OpenCMIS framework is the following:

+

http://localhost:8080/chemistry-opencmis-server-inmemory-war-0.5.0-SNAPSHOT/atom

+

+

The Web Services binding is exposed using a different endpoint:

+

http://localhost:8080/chemistry-opencmis-server-inmemory-war-0.5.0-SNAPSHOT/services/RepositoryService

+

+

After you click the "Save" button, you will see a connection summary screen, which might look something like this:

+

+
+

+

When you configure a job to use the CMIS repository connection an additional tab is presented. This is the "CMIS Query" tab:

+

+
+

+

The CMIS Query tab allows you to specify the query based on the CMIS Query Language to get all the result documents that need to be ingested.

+

Note that the CMIS Connector during the ingestion process, for each result, if it will find a folder node (that must have cmis:folder as the baseType), it will ingest all the children of the folder node; otherwise it will directly ingest the document (that must have cmis:document as the baseType).

+

When you are done, and you click the "Save" button, you will see a summary page looking something like this:

+

+
+

+
+ Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png?rev=1163569&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png ------------------------------------------------------------------------------ svn:mime-type = image/png